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

SDK で使用されるものとは異なる API バージョンを対象とするには、次のガイドラインに従ってください。

アカウントにはデフォルトの API バージョンがあり、API の呼び出し方法、アクセスできる機能、レスポンスの一部として返されることが保証される内容を定義します。ただし、サーバー側 SDK を使用する場合、Stripe への API コールでは、SDK のリリース時に最新の API バージョンが使用されます。Java、Go、.NET などの強力な型付け言語を使用する場合、異なるバージョンをターゲットにすることはできません。

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_BQokikJOvBiI2HlWgH4olfQ2
Stripe.api_version = '2025-11-17.clover'

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

require 'stripe'
intent = Stripe::PaymentIntent.retrieve(
  'pi_1DlIVK2eZvKYlo2CW4yj5l2C',
  {
    stripe_version: '2025-11-17.clover',
  }
)
intent.capture

メモ

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

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

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

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

参照情報

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

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