Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

ユーザーサブスクリプションの課金サイクルが終了した際に発行されるWebHookについて説明します。


課金サイクルの終了のWebHookは、現在β環境でのみ送られます。

概要

ユーザーサブスクリプションに紐づく課金サイクルが終了した際にpayments/change-billing-period WebHookが発行されます。

課金サイクルの終了は、ユーザーに対して利用料金が請求される際のことになります。
このWebHookは、サブスクリプションが月額課金の場合は毎月料金の請求日に発行され、年額課金の場合は毎年料金の請求日に発行されます。

このWebHookに含まれる期間は、次回の利用期間と同じになります。 

リクエストボディ

以下のJSONフォーマットでCloudGearからCloudGearアプリケーションにHTTPリクエストが送信されます。

event="payments", type="change-billing-period"
{
  "event": "payments",
  "type": "change-billing-period",
  "data": {
    "subscription_id": "sub_1234567890", // サブスクリプションID
    "service_id": 1, // サービスID
    "square_id": "service-square-id", // サービススクエアID
    "period_start": 123456789, // 次回のサブスクリプションの適用開始日時(秒)
    "period_end": 987654321 // 次回のサブスクリプションの適用終了日時(秒)
  }
}
  • No labels