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

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

アカウントには[デフォルトの API バージョン](https://docs.stripe.com/upgrades.md#how-can-i-upgrade-my-api)があり、API の呼び出し方法、アクセスできる機能、レスポンスの一部として返されることが保証される内容を定義します。ただし、[サーバー側 SDK](https://docs.stripe.com/sdks.md#server-side-libraries) を使用する場合、Stripe への API コールでは、SDK のリリース時に最新の API バージョンが使用されます。Java、Go、.NET などの強力な型付け言語を使用する場合、異なるバージョンをターゲットにすることはできません。

#### Ruby

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

stripe-ruby ライブラリを使用すると API バージョンをグローバルに、またはリクエストごとに設定できます。API バージョンを設定しない場合、stripe-ruby の最近のバージョンでは、お使いの stripe-ruby バージョンがリリースされた時点の最新の API バージョンが使用されます。stripe-ruby の [v9](https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md#900---2023-08-16) より前のバージョンでは、アカウントのデフォルトの API バージョンが使用されます。

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

```ruby
require 'stripe'
# Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
client = Stripe::StripeClient.new('<<YOUR_SECRET_KEY>>', stripe_version: '2026-04-22.dahlia')
```

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

```ruby
require 'stripe'
# Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
client = Stripe::StripeClient.new('<<YOUR_SECRET_KEY>>')
intent = client.v1.payment_intents.retrieve(
  'pi_1DlIVK2eZvKYlo2CW4yj5l2C',
  {
    stripe_version: '2026-04-22.dahlia',
  },
)
intent.capture
```

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

#### Python

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

stripe-python ライブラリを使用すると API バージョンをグローバルに、またはリクエストごとに設定できます。API バージョンを設定しない場合、stripe-python の最近のバージョンでは、お使いの stripe-python バージョンがリリースされた時点の最新の API バージョンが使用されます。stripe-python の [v6](https://github.com/stripe/stripe-python/blob/master/CHANGELOG.md#600---2023-08-16) より前のバージョンでは、アカウントのデフォルトの API バージョンが使用されます。

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

```python
import stripe
# Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
stripe.api_key = <<YOUR_SECRET_KEY>>
stripe.api_version = '2026-04-22.dahlia'
```

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

```python
import stripe
intent = stripe.PaymentIntent.retrieve(
  "pi_1DlIVK2eZvKYlo2CW4yj5l2C",
  stripe_version="2026-04-22.dahlia",
)
intent.capture()
```

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

#### PHP

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

stripe-php ライブラリを使用すると API バージョンをグローバルに、またはリクエストごとに設定できます。API バージョンを設定しない場合、stripe-php の最近のバージョンでは、お使いの stripe-php バージョンがリリースされた時点の最新の API バージョンが使用されます。stripe-php の [v11](https://github.com/stripe/stripe-php/blob/master/CHANGELOG.md#1100---2023-08-16) より前のバージョンでは、アカウントのデフォルトの API バージョンが使用されます。

SDK で API バージョンを**グローバルに**設定するには、`\Stripe\Stripe::setApiVersion()` メソッドにバージョンを渡します。

```php
$stripe = new \Stripe\StripeClient([
  // Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
  "api_key" => "<<YOUR_SECRET_KEY>>",
  "stripe_version" => "2026-04-22.dahlia"
]);
```

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

```php
$intent = $stripe->paymentIntents->capture(
  'pi_1DlIVK2eZvKYlo2CW4yj5l2C',
  [],
  ['stripe_version' => '2026-04-22.dahlia']
);
```

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

#### Java

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

Java は強い型付けのプログラミング言語であるため、SDK で使用される API バージョンは SDK リリース時の最新 API バージョンに「固定」されています。

強い型付けのプログラミング言語で異なる API バージョンを設定すると、レスポンスオブジェクトが SDK の強い型付けと一致せず、リクエストが失敗する可能性があるため、お勧めしません。たとえば、対象の API バージョンが SDK タイプに存在しないパラメーターを必要とする場合、リクエストは失敗します。

#### Node

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

stripe-node ライブラリを使用すると API バージョンをグローバルに、またはリクエストごとに設定できます。API バージョンを設定しない場合、stripe-node の最近のバージョンでは、お使いの stripe-node バージョンがリリースされた時点の最新の API バージョンが使用されます。stripe-node の [v12](https://github.com/stripe/stripe-node/blob/master/CHANGELOG.md#1200---2023-04-06) より前のバージョンでは、アカウントのデフォルトの API バージョンが使用されます。

SDK で API バージョンを**グローバルに**設定するには、`apiVersion` オプションを指定します。

```javascript
// Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
const stripe = require('stripe')('<<YOUR_SECRET_KEY>>', {
  apiVersion: '2026-04-22.dahlia',
});
```

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

```javascript
const intent = await stripe.paymentIntents.retrieve('pi_1DlIVK2eZvKYlo2CW4yj5l2C', {
  apiVersion: '2026-04-22.dahlia',
});
```

#### Typescript の使用

TypeScript タイプではリリース時の最新の API バージョンが反映されます。このバージョンは、[API_VERSION ファイル](https://github.com/stripe/stripe-node/blob/master/API_VERSION)にエンコードされています。

Stripe をデフォルトのインポートとしてインポートし、最新の API バージョンで `new Stripe()` としてインスタンス化します。

```javascript
import Stripe from 'stripe';
const stripe = new Stripe('<<YOUR_PUBLISHABLE_KEY>>', {
  apiVersion: '2026-04-22.dahlia'
});
```

#### Go

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

Go は強い型付けのプログラミング言語であるため、SDK で使用される API バージョンは SDK リリース時の最新 API バージョンに「固定」されています。

強い型付けのプログラミング言語で異なる API バージョンを設定すると、レスポンスオブジェクトが SDK の強い型付けと一致せず、リクエストが失敗する可能性があるため、お勧めしません。たとえば、対象の API バージョンが SDK タイプに存在しないパラメーターを必要とする場合、リクエストは失敗します。

#### .NET

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

C\# は強い型付けのプログラミング言語であるため、.NET SDK で使用される API バージョンは SDK リリース時の最新 API バージョンに「固定」されています。

強い型付けのプログラミング言語で異なる API バージョンを設定すると、レスポンスオブジェクトが SDK の強い型付けと一致せず、リクエストが失敗する可能性があるため、お勧めしません。たとえば、対象の API バージョンが SDK タイプに存在しないパラメーターを必要とする場合、リクエストは失敗します。

#### cURL

```sh
curl https://api.stripe.com/v1/charges \
  -u <<YOUR_SECRET_KEY>>: \
  -H "Stripe-Version: 2026-04-22.dahlia"
```

#### Stripe CLI

```sh
stripe charges create --stripe-version 2026-04-22.dahlia
```

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

[API バージョン](https://docs.stripe.com/upgrades.md#how-can-i-upgrade-my-api)をアップグレードする前に、以下のリソースを慎重に確認してください。

- [Stripe API の変更ログ](https://docs.stripe.com/changelog.md)
- [API リクエストで使用される API バージョンを表示する](https://docs.stripe.com/workbench/guides.md#view-api-versions)

アカウントのデフォルトの API バージョンは、&nbsp;[ワークベンチ](https://dashboard.stripe.com/workbench/overview) でアップグレードできます。コールを行う際に、最新バージョンの SDK を使用し、新しい API バージョンを設定するようにコードを更新してください。

## See also

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

- [Stripe のバージョン管理とサポートに関するポリシー](https://docs.stripe.com/sdks/versioning.md)