Skip to content
Create account or Sign in
The Stripe Docs logo
/
Ask AI
Create accountSign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
APIs & SDKsHelp
Overview
Versioning
Changelog
    Overview
    Dahlia
    Clover
    Basil
    Acacia
    Previous versions
      2024-06-20
      2024-04-10
      2023-10-16
      2023-08-16
      2022-11-15
      2022-08-01
      2020-08-27
      2020-03-02
      2019-12-03
      2019-11-05
      2019-10-17
      2019-10-08
      2019-09-09
      2019-08-14
      2019-05-16
      2019-03-14
      2019-02-19
      2019-02-11
      2018-11-08
      2018-10-31
      2018-09-24
      2018-09-06
      2018-08-23
      2018-07-27
      2018-05-21
      2018-02-28
      2018-02-06
      2018-02-05
      2018-01-23
      2017-12-14
      2017-08-15
      2017-06-05
      2017-05-25
      2017-04-06
      2017-02-14
      2017-01-27
      2016-10-19
      2016-07-06
      2016-06-15
      2016-03-07
      2016-02-29
      2016-02-23
      2016-02-22
      2016-02-19
      2016-02-03
      2015-10-16
      2015-10-12
      2015-10-01
      2015-09-23
      2015-09-08
      2015-09-03
      2015-08-19
      2015-08-07
      2015-07-28
      2015-07-13
      2015-07-07
      2015-06-15
      2015-04-07
      2015-03-24
      2015-02-18
      2015-02-16
      2015-02-10
      2015-01-26
      2015-01-11
      2014-12-22
      2014-12-17
      2014-12-08
      2014-11-20
      2014-11-05
      2014-10-07
      2014-09-08
      2014-08-20
      2014-08-04
      2014-07-26
      2014-07-22
      2014-06-17
      2014-06-13
      2014-05-19
      2014-03-28
      2014-03-13
      2014-01-31
      2013-12-03
      2013-10-29
      2013-08-13
      2013-08-12
      2013-07-05
      2013-02-13
      2013-02-11
      2012-11-07
      2012-10-26
      2012-09-24
      2012-07-09
      2012-06-18
      2012-03-25
      2012-02-23
      2011-09-15
      2011-08-01
      2011-06-28
      2011-06-21
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
Stripe Projects
Tools
Stripe Dashboard
Workbench
Developers Dashboard
Stripe for Visual Studio Code
Terraform
Stripe Discord server
Features
Workflows
Batch jobs
Event destinations
Stripe health alertsStripe SignalsFile uploads
AI solutions
Model Context ProtocolAgent skillsStripe Directory
Extend Stripe
Overview
Build Stripe apps
Use apps from Stripe
Build extensions
Custom objects
Security and privacy
Security
Activity logsStripebot web crawler
Privacy
Partners
Partner ecosystem
Partner certification
United States
English (United States)
  1. Home/
  2. Developer resources/
  3. Changelog/
  4. Previous versions/
  5. 2019-10-17
Breaking changes

Renames and updates subscription schedule renewal propertiesBreaking 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

ParametersChangeResources or endpoints
renewal_behaviorRemoved
SubscriptionSchedule#createSubscriptionSchedule#update
end_behaviorAdded
SubscriptionSchedule
renewal_intervalRemoved
SubscriptionSchedule
FieldChangeFrom → to
SubscriptionSchedule.renewal_behaviorChanged
nullable(enum('cancel'|'none'|'release'|'renew')) → enum('cancel'|'none'|'release'|'renew')

Upgrade

  1. View your current API version 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 to include Stripe-Version: 2019-10-17
  3. Upgrade the API version used for webhook endpoints.
  4. Test your integration against the new version.
  5. If you use Connect, test your Connect integration.
  6. In Workbench, perform the upgrade. You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.

Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Chat with Stripe developers on Discord.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc
On this page