課金サイクルの終了の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 // 次回のサブスクリプションの適用終了日時（秒）
}
}
サービス定義の使用実績のプランを含むサブスクリプションの場合
「サービス定義の使用実績」のプランを含むサブスクリプションでは、発行されるWebHookに対してレスポンスを返していただく必要があります。
課金サイクルが変わる前に請求期間内の使用量の最終値を送っていただきます。
その後、サービス側で使用量のリセットをしていただく必要があります。
レスポンスボディ
以下のJSONフォーマットでCloudGearアプリケーションからCloudGearにHTTPリクエストを返してください。
{
[{
"subscription_id": "sub_1234567890", // サブスクリプションID
"plan_id": "plan_1", // プランID
"quantity": 100L, // 使用量の最新値
"timestamp": 123456789, //使用量報告日時（秒)
"service_id": 1 // サービスID
},{
"subscription_id": "sub_1234567890", // サブスクリプションID
"plan_id": "plan_2", // プランID
"quantity": 200L, // 使用量の最新値
"timestamp": 123456789, //使用量報告日時（秒)
"service_id": 1 // サービスID
}]
}