Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ユーザーが使用量タイプの料金プランを持つサブスクリプションがある場合に発行されるWebHookについて説明します。

Warning使用量要求のWebHookは、現在β環境でのみ送られます。


概要

ユーザーが使用量タイプの料金プランを持つサブスクリプションがある場合、毎日04:00(JST)にpayments/request-usage-record WebHookが発行されます。

このWebHookは、CloudGearアプリケーションにリマインドとして発行されるものであり、WebHookに基づいてCloudGearに使用量を報告する必要はありません。
(使用量の報告がなされない場合、使用量タイプの料金プランを持つサブスクリプションは、ユーザーに対して料金を請求しません。)

使用量タイプの料金プランを持つサブスクリプションCloudGearアプリケーションにない場合、このWebHookは発行されません。 

リクエストボディ

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

Code Block
languagejs
titleevent="payments", type="request-usage-record"
{
  "event": "payments",
  "type": "request-usage-record",
  "data": {
    "service_id": 1, // サービスID
    "requests": [{
       "square_id": "service-square-id", // サービススクエアID
       "subscription_id": "sub_1234567", // サブスクリプションID
       "plan_ids": ["plan_1", "plan_2"], // 使用量タイプの料金プランID
       "timestamp": 123456789 // タイムスタンプ(秒) 
    }...{}]
  }
}