Repository navigation
Changes for upcoming major release #1981
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8695bf6
seed the migration guide for the next major version
xavdid 28c7779
Rename Reversal to TransferReversal (#1971)
zacchua-stripe ec3daaf
⚠️ Drop support for Ruby 2.7 (#1978)
ramya-stripe 3b484aa
Rename Stripe::Reversal to Stripe::TransferReversal
jar-stripe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
.hark/changes/2026-09-17_zacchua_rename-reversal-transferreversal.change.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: Rename `Stripe::Reversal` to `Stripe::TransferReversal` | ||
| pr_url: https://github.com/stripe/stripe-ruby/pull/1971 | ||
| semver_level: major | ||
| --- | ||
|
|
||
| - Rename the `Stripe::Reversal` resource class to `Stripe::TransferReversal`. Update references and Sorbet type annotations to use `Stripe::TransferReversal`. |
4 changes: 4 additions & 0 deletions
4
.hark/changes/2026-09-25_unknown_drop-support-ruby-2-7.change.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: Drop support for Ruby 2.7 | ||
| semver_level: major | ||
| --- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Migration guide for v20 | ||
|
|
||
| <!-- This is the migration guide for the next major version! | ||
| If you're making breaking changes, add a new h2 header with a nice title and write a detailed guide to help users upgrade. | ||
| You will almost certainly need before/after code examples and information about which users this change affects. | ||
| See: https://github.com/stripe/hark#writing-a-great-migration-guide | ||
| --> | ||
|
|
||
| This version uses API version `2026-09-30.endive`. If the format of this API version looks new to you, see our new [API release process](https://stripe.com/blog/introducing-stripes-new-api-release-process). | ||
|
jar-stripe marked this conversation as resolved.
|
||
|
|
||
| Please review our API changelog for `2026-09-30.endive` to understand all the breaking changes to the Stripe API, the reasons behind them and potential alternatives. | ||
|
|
||
| The Ruby SDK specific [changelog for v20](https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md) has the corresponding changes in the SDKs as well as SDK specific breaking changes. | ||
|
|
||
| ## Minimum Ruby version raised to 3.0 | ||
|
|
||
| Ruby 2.7 is no longer supported. The gem now requires Ruby >= 3.0.0. | ||
|
|
||
| **Action required**: Upgrade to Ruby 3.0 or later before updating to the latest SDK version. For more information, see our [language version support policy](https://docs.stripe.com/sdks/versioning?lang=ruby#stripe-sdk-language-version-support-policy). | ||
|
|
||
| Note that this is the last major release that supports Ruby `3.0`. Please make plans to update to a higher version before March 2027. | ||
|
|
||
| ## Rename `Stripe::Reversal` to `Stripe::TransferReversal` | ||
|
|
||
| The class representing a transfer reversal has been renamed from `Stripe::Reversal` to `Stripe::TransferReversal` | ||
|
|
||
| This change affects integrations that reference `Stripe::Reversal` directly, including class comparisons, `is_a?` checks, and Sorbet type annotations. Replace those references with `Stripe::TransferReversal`: | ||
|
|
||
| ```ruby | ||
| # Before | ||
| reversal = Stripe::Transfer.retrieve_reversal("tr_123", "trr_123") | ||
| reversal.is_a?(Stripe::Reversal) | ||
|
|
||
| # After | ||
| reversal = Stripe::Transfer.retrieve_reversal("tr_123", "trr_123") | ||
| reversal.is_a?(Stripe::TransferReversal) | ||
| ``` | ||
|
|
||
| The methods for creating, retrieving, updating, and listing transfer reversals have not changed. Code that only calls those methods and reads attributes from the returned object does not require an update. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.