# サブスクリプションスケジュールの更新プロパティの名前変更と更新を行いました

## 新機能

サブスクリプションスケジュールの複数の変更が含まれます。

- `renewal_behavior` の名前を、`cancel` と `release` の値が指定された `end_behavior` に変更します。
- `renewal_interval` を削除します。

この変更により、古い API バージョンで `renewal_behavior` を `none` として記述した場合、値を読み戻す際に `end_behavior` が `cancel` に変換されます。API をアップグレードして `renewal_behavior` を `renew` に設定した場合、この API バージョンを有効にすると、`end_behavior` が `renew` と表示されます。ただし、読み取り専用であるため、`renewal_interval` を更新することも、`end_behavior` を `renew` に設定することもできません。

## 影響

`end_behavior` プロパティを使用して、サブスクリプションのスケジュールの終了方法を直感的に管理できます。この変更は、以前の `renewal_behavior` 値 `none` を新しいキャンセル終了動作に自動的にマッピングして後方互換性に対応しています。

## 変更点

#### REST API

| Parameters | Change | Resources or endpoints |
| --- | --- | --- |
| `renewal_behavior` | Removed | [SubscriptionSchedule#create](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionSchedule#update](/api/subscription_schedules/update?api-version=2024-06-20) |
| `end_behavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |
| `renewal_interval` | Removed | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20) |

| Field | Change | From → to |
| --- | --- | --- |
| `SubscriptionSchedule.renewal_behavior` | Changed | `nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew')` |

#### Ruby

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `renewal_behavior` | Removed | [SubscriptionScheduleCreateParams](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20) |
| `end_behavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

| Field | Change | From → to |
| --- | --- | --- |
| `SubscriptionSchedule.renewal_behavior` | Changed | `nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew')` |

#### Python

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `renewal_behavior` | Removed | [SubscriptionScheduleCreateParams](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionScheduleModifyParams](/api/subscription_schedules/update?api-version=2024-06-20) |
| `end_behavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

| Field | Change | From → to |
| --- | --- | --- |
| `SubscriptionSchedule.renewal_behavior` | Changed | `nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew')` |

#### PHP

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `renewal_behavior` | Removed | [SubscriptionSchedule.create().$params](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionSchedule.update().$params](/api/subscription_schedules/update?api-version=2024-06-20) |
| `end_behavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

| Field | Change | From → to |
| --- | --- | --- |
| `SubscriptionSchedule.renewal_behavior` | Changed | `nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew')` |

#### Java

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `renewalBehavior` | Removed | [SubscriptionScheduleCreateParams](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20) |
| `endBehavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

#### Node.js

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `renewal_behavior` | Removed | [SubscriptionScheduleCreateParams](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20) |
| `end_behavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

| Field | Change | From → to |
| --- | --- | --- |
| `SubscriptionSchedule.renewal_behavior` | Changed | `enum('cancel'|'none'|'release'|'renew') | null → enum('cancel'|'none'|'release'|'renew')` |

#### Go

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `RenewalBehavior` | Removed | [SubscriptionScheduleParams](/api/subscription_schedules/create?api-version=2024-06-20) |
| `EndBehavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

#### .NET

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `RenewalBehavior` | Removed | [SubscriptionScheduleCreateOptions](/api/subscription_schedules/create?api-version=2024-06-20), [SubscriptionScheduleUpdateOptions](/api/subscription_schedules/update?api-version=2024-06-20) |
| `EndBehavior` | Added | [SubscriptionSchedule](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-end_behavior) |

## アップグレード

#### REST API

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. SDK を使用している場合は、この API バージョンに対応する SDK バージョンにアップグレードします。
   - SDK を使用していない場合は、`Stripe-Version: 2019-10-17` を含めるように [API リクエスト](https://docs.stripe.com/api/versioning.md)を更新してください。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### Ruby

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. Ruby SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### Python

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. Python SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### PHP

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. PHP SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### Java

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. Java SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### Node.js

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. Node SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### Go

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. Go SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。

#### .NET

1. Workbench で[現在の API バージョンを表示します](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench)。
2. .NET SDK を 最新バージョンにアップグレードします。
3. [Webhook エンドポイント](https://docs.stripe.com/webhooks/versioning.md)に使用する API バージョンをアップグレードします。
4. 新しいバージョンに対して、[実装内容をテスト](https://docs.stripe.com/testing.md)します。
5. Connect を使用する場合は、[Connect の実装内容をテスト](https://docs.stripe.com/connect/testing.md)します。
6. Workbench で[アップグレードを実行](https://docs.stripe.com/upgrades.md#perform-the-upgrade)します。[バージョンをロールバック](https://docs.stripe.com/upgrades.md#roll-back-your-api-version)できるのは 72 時間以内です。

[Stripe API のアップグレード](https://docs.stripe.com/upgrades.md)について、詳細をご確認ください。