請求書の使用量を記録する

顧客の使用量データの記録方法をご紹介します。

各請求期間を通して、Stripe に使用量を記録して、正しい金額が顧客に請求されるようにします。Stripe に使用量を記録する頻度を決定できます。

Stripe に使用量を記録するには、まずメーターを設定し、次に記録された使用量を Stripe ダッシュボードまたは API で追加します。

メーターを設定する

顧客の使用量を記録する前に、meter (メーター) を設定する必要があります。メーターの設定後は、表示名を除き変更することができなくなります。

従量属性	説明
イベント名	メーターを使用して使用量を記録することを予定している従量イベントの名前。使用量を Stripe に送信する際、meter event (従量イベント) の `event_name` フィールドでこのイベント名が使用されます。これにより、正しいメーターを記録して使用量を集計することができます。イベント名は特定の 1 つのメーターでのみ使用できます。
イベントの取り込み	Stripe にイベントを送信する方法を指定します。未加工: すべての従量イベントをスタンドアロンのイベントとして処理します。同じタイムスタンプで送信された複数のイベントは、互いに上書きされず、集計には複数のイベントが含まれます。これは、何も指定しなかった場合のデフォルトのオプションです。事前集計: 特定の頻度 (毎時または毎日) でイベントを送信している場合、Stripe はその時間枠内で最近受信した従量イベントのみを使用します。同じ毎時または毎日の時間枠内で送信される新しいイベントによって以前のイベントは上書きされます。UTC の従量イベントのタイムスタンプで、時間と日の区切りが指定されます。
集計式	請求期間の使用量の集計方法を指定します。合計: 請求期間中のすべての使用量の合計値に基づいて顧客に請求します。件数: 請求期間中のすべての使用量の件数に基づいて顧客に請求します。
ペイロードキーの上書き	イベントペイロードのどのキーが顧客と使用量の数値を表すかを指定します。 value_settings: このパラメーターを使用して、使用量の数値を参照するイベントペイロード内のキーを定義します。デフォルトのキーは `value` ですが、トークンなど別のキーも指定できます。 customer_mapping: このパラメーターを使用して、Stripe 顧客 ID を参照するイベントペイロード内のキーを定義します。デフォルトのキーは `stripe_customer_id` ですが、`customer_id` など別のキーも指定できます。

使用量を記録する

ダッシュボードまたは API を使用して Stripe に使用量を記録します。

Stripe は従量イベントを非同期に処理するため、集計された使用量は従量イベントのサマリーに集約され、次回の請求書には、最近受信した従量イベントが即時に反映されない可能性があります。

API を使用する

Stripe API を使用して顧客の使用量データを記録します。

Stripe ダッシュボードを使用

ダッシュボードを使用して使用量データを含む CSV ファイルをアップロードします。

使用量データの誤りを修正する

現在の請求期間で誤って記録されたイベントに気付いた場合は、meter event adjustment (従量イベントの調整) を作成して、それらのイベントをキャンセルできます。その従量イベントの ID を指定する必要があります。

過去 24 時間以内に Stripe に送信されたイベントのみキャンセルできます。確定済みの請求書に含まれている使用量をキャンセルしても、Stripe はその請求書を更新せず、キャンセルされた使用量を対象とする修正請求書も発行しません。また、顧客に送信された確定済みの請求書におけるキャンセルされた使用量の請求調整には対応していません。

数量をマイナスで記録して、誤って記録した使用量データを修正することもできます。サイクル全体の使用量がマイナスの場合、Stripe では請求書のラインアイテムの使用数量を 0 として報告します。