# Deprecates subscription prorate and subscription_prorate parameters

## What’s new

Deprecates the `prorate` and `subscription_prorate` parameters in favor of `proration_behavior`.

## Impact

By deprecating the `prorate` and `subscription_prorate` parameters in favor of the more comprehensive `proration_behavior` parameter, you can more precisely configure how prorating should be handled.

## Changes

#### REST API

| Parameters | Change | Resources or endpoints |
| --- | --- | --- |
| `prorate` | Removed | [Subscription#create](/api/subscriptions/create?api-version=2024-06-20), [Subscription#update](/api/subscriptions/update?api-version=2024-06-20), [SubscriptionItem#create](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItem#delete](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItem#update](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule#update](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases) |
| `proration_behavior` | Added | [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### Ruby

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `prorate` | Removed | [SubscriptionCreateParams](/api/subscriptions/create?api-version=2024-06-20), [SubscriptionItemCreateParams](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItemDeleteParams](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItemUpdateParams](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule::Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionUpdateParams](/api/subscriptions/update?api-version=2024-06-20) |
| `proration_behavior` | Added | [SubscriptionSchedule::Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### Python

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `prorate` | Removed | [SubscriptionCreateParams](/api/subscriptions/create?api-version=2024-06-20), [SubscriptionItemCreateParams](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItemDeleteParams](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItemModifyParams](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionModifyParams](/api/subscriptions/update?api-version=2024-06-20), [SubscriptionSchedule.Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionScheduleModifyParams](/api/subscription_schedules/update?api-version=2024-06-20) |
| `proration_behavior` | Added | [SubscriptionSchedule.Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### PHP

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `prorate` | Removed | [Subscription.create().$params](/api/subscriptions/create?api-version=2024-06-20), [Subscription.update().$params](/api/subscriptions/update?api-version=2024-06-20), [SubscriptionItem.create().$params](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItem.delete().$params](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItem.update().$params](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionSchedule.update().$params](/api/subscription_schedules/update?api-version=2024-06-20) |
| `proration_behavior` | Added | [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### Java

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `prorate` | Removed | [SubscriptionCreateParams](/api/subscriptions/create?api-version=2024-06-20), [SubscriptionItemCreateParams](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItemDeleteParams](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItemUpdateParams](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionUpdateParams](/api/subscriptions/update?api-version=2024-06-20) |
| `prorationBehavior` | Added | [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### Node.js

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `prorate` | Removed | [SubscriptionCreateParams](/api/subscriptions/create?api-version=2024-06-20), [SubscriptionItemCreateParams](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItemDeleteParams](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItemUpdateParams](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionScheduleUpdateParams](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionUpdateParams](/api/subscriptions/update?api-version=2024-06-20) |
| `proration_behavior` | Added | [SubscriptionSchedule.phases[]](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### Go

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `Prorate` | Removed | [SubscriptionItemParams](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionParams](/api/subscriptions/update?api-version=2024-06-20), [SubscriptionScheduleParams](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionSchedulePhase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases) |
| `ProrationBehavior` | Added | [SubscriptionSchedulePhase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

#### .NET

| Parameters | Change | Resources or methods |
| --- | --- | --- |
| `Prorate` | Removed | [SubscriptionCreateOptions](/api/subscriptions/create?api-version=2024-06-20), [SubscriptionItemCreateOptions](/api/subscription_items/create?api-version=2024-06-20), [SubscriptionItemDeleteOptions](/api/subscription_items/delete?api-version=2024-06-20), [SubscriptionItemUpdateOptions](/api/subscription_items/update?api-version=2024-06-20), [SubscriptionSchedule.Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases), [SubscriptionScheduleUpdateOptions](/api/subscription_schedules/update?api-version=2024-06-20), [SubscriptionUpdateOptions](/api/subscriptions/update?api-version=2024-06-20) |
| `ProrationBehavior` | Added | [SubscriptionSchedule.Phase](/api/subscription_schedules/object?api-version=2024-06-20#subscription_schedule_object-phases-proration_behavior) |

## Upgrade

#### REST API

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. If you use an SDK, upgrade to the corresponding SDK version for this API version.
   - If you don’t use an SDK, update your [API requests](https://docs.stripe.com/api/versioning.md) to include `Stripe-Version: 2020-08-27`
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Ruby

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Ruby SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Python

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Python SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### PHP

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your PHP SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Java

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Java SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Node.js

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Node SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Go

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Go SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### .NET

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your .NET SDK to the latest version.
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).
