顧客の使用量を記録する前に、メーターを作成してから設定を行う必要があります。メーターの設定後は、表示名を除き変更を加えることはできません。
メーター設定の属性
| メーターの属性 | 説明 |
|---|
| イベント名 | メーターで使用量を記録するメーターイベントの名前。使用量を Stripe に送信する場合は、Meter Event (メーターイベント) の event_name フィールドにこのイベント名を指定してください。これにより、正しいメーターで使用量を記録して集計できるようになります。イベント名は 1 つのメーターでのみ使用できます。 |
イベントの受信 | Stripe にイベントを送信する方法を指定します。 - 未加工：メーターイベントはすべてスタンドアロンのイベントとして処理されます。同じタイムスタンプで送信された複数のイベントは、互いに上書きされません。集計は、複数のイベントが対象となります。これは、何も指定しない場合のデフォルトのオプションです。
- 事前集計:特定の時間間隔 (毎時または毎日) にイベントを送信する場合、Stripe はその時間間隔で最後に受信したメーターイベントのみを使用します。同じ期間内 (毎時または毎日) に送信された新しいイベントは、前のイベントを上書きします。メーターイベントのタイムスタンプ (UTC) によって、時間と日が区切られます。
|
集計式 | 請求期間の使用量を集計する方法を指定します。 - 合計:請求期間におけるすべての使用量の合計に基づいて顧客に請求します。
- カウント:請求期間におけるすべての使用量のカウントに基づいて顧客に請求します。
- 前回:請求期間の最新の使用量イベントの値に基づいて顧客に請求します。
|
ペイロードのキーの上書き | 顧客と使用量値を参照するイベントペイロード内のキーを指定します。 - value_settings:このパラメーターを使用して、使用量値を参照するイベントペイロードのキーを定義します。デフォルトのキーは
value ですが、トークンなどの別のキーを指定することもできます。 - customer_mapping:このパラメータを使用して、Customer ID を参照するイベントペイロードのキーを定義します。デフォルトのキーは
stripe_customer_id ですが、customer_id などの別のキーを指定することもできます。
|
誤った使用量データの修正
現在の請求期間に誤って記録されたイベントを発見した場合は、メーターイベント調整を作成して、該当のイベントをキャンセルすることができます。その場合、メーターイベントの ID を指定する必要があります。
取り消すことができるのは、過去 24 時間以内に Stripe に送信されたイベントのみです。確定請求書に記載されている使用量を取り消した場合、取り消された使用量に対する請求書の更新や、修正請求書の発行は行われません。顧客に送付される確定請求書に対し、使用量の取り消しによる請求調整は行われません。
また、負の数量を記録して、誤って記録された使用量データを修正することもできます。サイクル全体の使用量がマイナスの場合、Stripe は請求書の項目の使用量を 0 として報告します。
curl https://api.stripe.com/v1/billing/meter_event_adjustments \
-u "sk_test_BQokikJOvBiI2HlWgH4olfQ2