Stripe API バージョンを設定する

こちらのガイドラインに従って、Stripe の実装全体で API バージョンを統一します。

アカウントには、API の呼び出し方法、アクセスできる機能、レスポンスの一部として返される内容が定義された、デフォルトの API バージョンがあります。Webhook イベントオブジェクトは、デフォルトの API バージョンに基づいていますが、これは SDK で使用されている API バージョンとは異なる場合があります。これらのバージョンを一致させるには、SDK で使用されているものと同じ API バージョンで Webhook エンドポイントを登録することをお勧めします。バージョンを確認するには、API リクエストで使用される API バージョンを表示するをご覧ください。

バージョン管理の基本

ご利用を開始するには、SDK 言語を選択してください。

API バージョンを設定する

stripe-ruby ライブラリを使用すると API バージョンをグローバルに、またはリクエストごとに設定できます。API バージョンを設定しない場合、stripe-ruby の最近のバージョンでは、お使いの stripe-ruby バージョンがリリースされた時点の最新の API バージョンが使用されます。stripe-ruby の v9 より前のバージョンでは、アカウントのデフォルトの API バージョンが使用されます。

SDK で API バージョンをグローバルに設定するには、Stripe.api_version プロパティにバージョンを割り当てます。

require 'stripe'
Stripe.api_key =sk_test_4eC39HqLyjWDarjtT1zdp7dc
Stripe.api_version = '2024-11-20.acacia'

またはリクエストごとにバージョンを設定します。

require 'stripe'
intent = Stripe::PaymentIntent.retrieve(
  'pi_1DlIVK2eZvKYlo2CW4yj5l2C',
  {
    stripe_version: '2024-11-20.acacia',
  }
)
intent.capture

注

グローバルまたはリクエストごとにバージョンをオーバーライドすると、API レスポンスオブジェクトもそのバージョンで返されます。

API バージョンのアップグレード

API バージョンをアップグレードする前に、以下のリソースを慎重に確認してください。

アカウントのデフォルトの API バージョンは、ワークベンチでアップグレードできます。コールを行う際に、最新バージョンの Ruby SDK を使用し、新しい API バージョンを設定するようにコードを更新してください。

参照情報

Stripe SDK は独自のバージョン管理ポリシーに従っています。詳細については、以下のリンクをご覧ください。

Stripe のバージョン管理とサポートに関するポリシー