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

« Previous Version 4 Next »

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

2020年1月8日の本番リリース(予定)より、既存のWebHookの一部パラメータが変更され、新たなWebHookが追加されます。
β環境では変更が適用されている為、β環境をご利用の場合は、概要(ベータ環境)をご覧ください。

概要

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

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

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

リクエストボディ

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

event="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 // タイムスタンプ(秒) 
    }...{}]
  }
}


概要(ベータ環境)

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

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


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

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

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 // タイムスタンプ(秒) 
    }...{}]
  }
}
  • No labels