シンイベントを取得するためのサポートを追加します

新機能

/v2/core/events エンドポイントから、各通知の retrieve thin Event オブジェクトを取得できます。

シンイベントは、API v2 API を介してアクセスできる軽量イベントです。シンイベントはより細かい権限モデルを使用し、そのペイロードには API バージョン管理されたデータは含ません。これにより、イベントを受信し、適切に型付けされた Stripe SDK で構築された組み込みを簡単に更新できます。Thin Event オブジェクトには、イベントに関する追加情報を含めることができる data プロパティが含まれます。

Meter API は、シンイベントを使用する最初の API です。現在、従量課金に関連する以下の v2 のみを取得できます。

• v1.billing.meter.error_report_triggered
• v1.billing.meter.no_meter_found

v1.billing.meter.error_report_triggered イベントの例を次に示します。related_object フィールドには、オブジェクトの id が含まれますが、オブジェクトレコード自体は含まれていません。

{
  "id": "evt_test_65R9Ijk8dKEYZcXeRWn16R9A7j1FSQ3w3TGDPLLGSM4CW0",
  "object": "v2.core.event",
  "type": "v1.billing.meter.error_report_triggered",
  "livemode": false,
  "created": "2024-09-17T06:20:52.246Z",
  "related_object": {
    "id": "mtr_test_61R9IeP0SgKbYROOx41PEAQhH0qO23oW",
    "type": "billing.meter",
    "url": "/v1/billing/meters/mtr_test_61R9IeP0SgKbYROOx41PEAQhH0qO23oW"
  }
}

イベントの詳細をご覧ください。

影響

シンイベントにはいくつかのメリットがあります。ペイロードのバージョン管理が行われないため、将来の Webhook の実装を維持しやすくなります。シンイベントをイベントの送信先に送信できます。シンイベントは、API v2 の SDK ですべてタイプが指定されています。最後に、アプリケーションで、対応するイベント関連の API オブジェクト (Meter (従量) など) が必要な場合は、Stripe API をコールしてオブジェクトの最新のステータスを取得する必要があります。この方法で、以前のオブジェクトデータに起因するアプリケーションエラー (競合状態など) を防止できます。SDKs for API v2 には、イベントに関連するレコードの取得を可能にするヘルパーメソッドが含まれています。

変更点

Upgrade