Name: upgrade-stripe
Author: stripe

Upgrading Stripe Versions Choose a target API version If the user specifies a target API version, use it. Otherwise, look up the current version on docs.stripe.com with any documentation or web tool available to you, for example stripe docs /api/versioning with the Stripe CLI. The [API versioning](https://docs.stripe.com/api/versioning.md) page states it in the sentence that begins “The current version is”. Bundled fallback API version: 2026 09 30.endive . This value is only a snapshot from the last time this skill was generated, on 2026 10 29. Version identifiers start with their release date in YYYY MM DD format and new stable versions are released monthly, so a fallback version dated more than a month ago is probably stale. Use it only when you can’t reach docs.stripe.com. Never guess about a newer version number. Before making changes, compare the target with each API version the integration pins: client configuration, per request overrides, and webhook endpoints. Unless the user explicitly asks for it, don’t move any pin to an older version or a stable pin to a preview version. If a pin already matches the target, report it as unchanged. State the selected target and its source. If live verification fails or is unavailable, say that the latest version remains unverified, and don’t claim the integration is on the latest version. When reviewing webhook endpoints and event destinations, distinguish snapshot events from thin events. Thin event payloads are unversioned, so they don’t need to be upgraded when you change your API version. API calls that retrieve the full event or related resource remain versioned. For SDKs that support explicit API version overrides, use the selected target in client configuration and per request overrides. Use it in curl Stripe Version test headers, too. Replace bundled API versions shown in those examples with the selected target before copying or running them. For Java, Go, and .NET, select an SDK release that targets the selected API version instead of overriding the SDK’s fixed version. Preview targets need the matching beta SDK release in every language; see [SDK versioning](https://docs.stripe.com/sdks/versioning.md). Understanding Stripe API Versioning Stripe uses date based API versions (for example, 2026 09 30.endive , 2025 08 27.basil , 2024 12 18.acacia ). Your account’s API version determines request/response behavior. Starting with the 2024 09 30.acacia release, Stripe releases new API versions monthly with no breaking changes. Twice a year, a new major release (for example, Basil) starts with an API version containing breaking changes. You can safely upgrade to any monthly release without updating your code. Types of Changes Backward Compatible Changes (don’t require code updates): New API resources New optional request parameters New properties in existing responses Changes to opaque string lengths (for example, object IDs) New webhook event types Breaking Changes (require code updates): Field renames or removals Behavioral modifications Removed endpoints or parameters Review the [API changelog](https://docs.stripe.com/changelog.md) for all changes between versions. See [API upgrades](https://docs.stripe.com/upgrades.md) for the full upgrade guide. Server Side SDK Versioning See [Set a Stripe API version for your SDK](https://docs.stripe.com/sdks/set version.md) for details on setting an API version in code. Dynamically Typed Languages (Ruby, Python, PHP, Node.js) These SDKs offer flexible version control: Global Configuration: Per Request Override: Strongly Typed Languages (Java, Go, .NET) These use a fixed API version matching the SDK release date. Don’t set a different API version for strongly typed languages because response objects might not match the strong types in the SDK. Instead, update the SDK to target a new API version. Best Practice Always specify the API version you’re integrating against in your code instead of relying on your account’s default API version: Stripe.js Versioning See [Stripe.js Versioning](https://docs.stripe.com/sdks/stripejs versioning.md) for details. Stripe.js uses an evergreen model with major releases (Acacia, Basil, Clover, Dahlia, Endive) on a biannual basis. Loading Versioned Stripe.js Via Script Tag: Via npm: Major npm versions correspond to specific Stripe.js versions. API Version Pairing Each Stripe.js version automatically pairs with its corresponding API version. For instance: Endive Stripe.js uses 2026 09 30.endive API Acacia Stripe.js uses 2024 12 18.acacia API You can’t override this association. Migrating from v3 1. Identify your current API version in code 2. Review the changelog for relevant changes 3. Consider gradually updating your API version before switching Stripe.js versions 4. Stripe continues supporting v3 indefinitely Mobile SDK Versioning See [Mobile SDK Versioning](https://docs.stripe.com/sdks/mobile sdk versioning.md) for details. iOS and Android SDKs Both platforms follow semantic versioning (MAJOR.MINOR.PATCH): MAJOR : Breaking API changes MINOR : New functionality (backward compatible) PATCH : Bug fixes (backward compatible) New features and fixes release only on the latest major version. Upgrade regularly to access improvements. React Native SDK Uses a different model (0.x.y schema): Minor version changes (x): Breaking changes AND new features Patch updates (y): Critical bug fixes only Backend Compatibility All mobile SDKs work with any Stripe API version you use on your backend unless documentation specifies otherwise. Upgrade Checklist 1. Review the [API changelog](https://docs.stripe.com/changelog.md) for changes between your current and target versions 2. Check the [API upgrades guide](https://docs.stripe.com/upgrades.md) for migration guidance 3. Update server side SDK package version (for example, npm update stripe , pip install upgrade stripe ) 4. Update the apiVersion parameter in your Stripe client initialization 5. Test your integration against the new API version using the Stripe Version header 6. For each destination that receives snapshot events, review its configured API version. For webhook endpoints, follow [webhook versioning](https://docs.stripe.com/webhooks/versioning.md). For every v2 snapshot event destination — including webhook endpoints, Amazon EventBridge, and Azure Event Grid destinations — inspect [snapshot api version](https://docs.stripe.com/api/v2/core/event destinations/object.md v2 event destination object snapshot api version) and, if it differs from the target, create and test a replacement destination because you can’t change it after creation. For a replacement webhook endpoint, save its new signing secret and configure the handler to accept both secrets during testing and cutover. After cutover, disable or delete the old destination to avoid duplicate delivery. Leave thin event destinations unchanged 7. Update Stripe.js script tag or npm package version if needed 8. Update mobile SDK versions in your package manager if needed 9. Store Stripe object IDs in databases that accommodate up to 255 characters (case sensitive collation) Testing API Version Changes Use the Stripe Version header to test your code against a new version without changing your default: Or in code: Important Notes For supported event types, follow the [migration guide](https://docs.stripe.com/webhooks/migrate snapshot to thin events.md) to move from snapshot events to thin events. After migration, webhook payloads no longer depend on API version upgrades; API calls that retrieve the full event or related resource remain versioned. Your webhook listener should handle unfamiliar event types gracefully Test webhooks with the new version structure before upgrading Breaking changes are tagged by affected product areas (Payments, Billing, Connect, etc.) Multiple API versions coexist simultaneously, enabling staged adoption For 72 hours after upgrading, you can roll back to your previous API version in [Workbench](https://dashboard.stripe.com/workbench/overview)