[NOTICE]: Versioning coming soon to Stripe.js. Pay attention to breaking changes in the next release.

[brendanm-stripe]

The most important thing to know:

A new major version of this module will be released soon that has potentially breaking changes. Please read the release notes and linked documentation carefully before upgrading.

Update (2025-03-10): This has now been released with version 6.0.0.

What is happening and when?

Stripe.js is joining the release process for the API and introducing our first versioned release soon. You can preview our public documentation about the versioning system for Stripe.js and how it might affect your integration.

With that release, a new major version of this library will also be released which is pinned to the acacia version of Stripe.js, similar to the way our latest server SDK versions are pinned to specific API versions.

Is this a required change?

No. While we recommend upgrading your integration to use the latest version, this will be at your discretion. We will continue to support v3 for the foreseeable future and you can continue to use it in your integration.

As detailed in the documentation, some new features might only be supported in newer versions of Stripe.js, at which point you can choose to upgrade on a schedule that works for you.

What do I need to do?

Be aware of these changes and read the release notes for the new version when it is released. Review the breaking changes and ensure you handle them in your integration, if needed, when upgrading to the new version.

What are the breaking changes?

For the first versioned release, acacia, the only breaking changes are directly related to versioning itself – there are no breaking changes to product features or functionality.

• It is no longer supported to pass apiVersion during Stripe.js initialization (either using Stripe() directly or via loadStripe() in this helper module). Stripe.js versions will be pinned to API versions in the same release family (ie, Stripe.js acacia will use a *.acacia API version)
• If you manually load Stripe.js in your application while using this library for integration, you’ll need to remove that or update it to use the appropriate version by changing the script src to use a path such as https://js.stripe.com/acacia/stripe.js.
• Because this will bump your Stripe.js-controlled API calls to *.acacia you should review historic breaking changes that could impact your Stripe.js/Elements integration to ensure you handle any that apply to you.
  • Check the API version used by recent requests in Workbench Overview or examine request logs.