Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Next major] Set the latest API version as the default #1242

Merged
merged 2 commits into from
Aug 15, 2023

Conversation

richardm-stripe
Copy link
Contributor

@richardm-stripe richardm-stripe commented Jul 7, 2023

Analog to this change in stripe-node.

Changelog

⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️

In this release, Stripe API Version 2023-08-16 (the latest at time of release) will be sent by default on all requests.
The previous default was to use your Stripe account's default API version.

To successfully upgrade to stripe-ruby v9, you must either

  1. (Recommended) Upgrade your integration to be compatible with API Version 2023-08-16.

    Please read the API Changelog carefully for each API Version from 2023-08-16 back to your Stripe account's default API version. Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe Test Mode before deploying them to production.

    You can read the v9 migration guide for more detailed instructions.

  2. (Alternative option) Specify a version other than 2023-08-16 when initializing stripe-ruby.

    If you were previously initializing stripe-ruby without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your Stripe account's default API version. For example:

      require 'stripe'
      Stripe.api_key = "sk_test_..."
    + Stripe.api_version = '2020-08-27'

    If you were already initializing stripe-ruby with an explicit API Version, upgrading to v9 will not affect your integration.

    Read the v9 migration guide for more details.

Going forward, each major release of this library will be pinned by default to the latest Stripe API Version at the time of release.

That is, instead of upgrading stripe-ruby and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-ruby, you should also upgrade your integration to be compatible with the latest Stripe API version.

@richardm-stripe richardm-stripe changed the base branch from master to sdk-release/next-major August 4, 2023 20:26
@richardm-stripe richardm-stripe marked this pull request as ready for review August 14, 2023 16:43
@richardm-stripe richardm-stripe requested review from a team and pakrym-stripe and removed request for a team August 14, 2023 20:04
@richardm-stripe richardm-stripe merged commit 3d0367a into sdk-release/next-major Aug 15, 2023
12 checks passed
@remi-stripe remi-stripe deleted the richardm-version-pinning branch September 28, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants