Breaking changes
Renames and updates subscription schedule renewal properties Breaking changes
What’s new
Includes multiple changes to subscription schedules:
- Renames renewal _ behavior to end _ behavior , and cancel and release values.
- Removes renewal _ interval .
A side effect of this change is that if you wrote a renewal_behavior of none on an old API version, end_behavior is now converted to cancel when reading the value back. In the event that you’re upgrading your API and set renewal_behavior as renew, with this API version enabled, you’ll see end_behavior as renew. However, you can no longer update renewal_interval, or set end_behavior to renew, as it’s in a read-only state.
Impact
Lets you more intuitively control how a subscription schedule ends using the end_behavior property. The change handles backward compatibility by automatically mapping the old renewal_behavior value of none to the new cancel end behavior.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| renewal_behavior | Removed | SubscriptionSchedule#create SubscriptionSchedule#update |
| end_behavior | Added | SubscriptionSchedule |
| renewal_interval | Removed | SubscriptionSchedule |
| Field | Change | From → to |
| SubscriptionSchedule. renewal_behavior | Changed | nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew') |
Upgrade
- View your current API version in Workbench.
- 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 to include Stripe-Version: 2019-10-17
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.