使用量タイプの料金プランを持つサブスクリプションに対して使用量を要求

Owned by DiceK Mikami (Unlicensed)
Last updated: 2020 Apr 02 by 二宮力也
1 min read

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


概要

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

使用量要求のWebHookは、バージョン2のみ送信されます。


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

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


リクエストボディ

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

event="payments", type="request_usage_record"
{
  "id": "91018c24-4182-4e20-8509-501471b6304f", // UUID
  "event": "payments",
  "type": "request_usage_record",
  "created_at": 1576200980964, // 作成日時
  "version": 2, // WebHookのバージョン
  "data": {
    "service_id": 1, // サービスID
    "requests": [{
       "square_id": "service-square-id", // サービススクエアID
       "service__id": 1, // サービスID
       "subscription_id": "sub_1234567", // サブスクリプションID
       "plan_ids": ["plan_1", "plan_2"], // 使用量タイプの料金プランID
       "timestamp": 123456789 // タイムスタンプ（秒） 
    }...{}]
  }
}