Catalog
stripe/upgrade-stripe

stripe

upgrade-stripe

Guide for upgrading Stripe API versions and SDKs

NewUpdated Sep 9, 2026

The latest Stripe API version is 2026-08-26.dahlia - use this version when upgrading unless the user specifies a different target version.

Upgrading Stripe Versions

This guide covers upgrading Stripe API versions, server-side SDKs, Stripe.js, and mobile SDKs.

Understanding Stripe API Versioning

Stripe uses date-based API versions (e.g., 2026-08-26.dahlia, 2025-08-27.basil, 2024-12-18.acacia). Your account’s API version determines request/response behavior.

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 (e.g., 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 for all changes between versions.

Server-Side SDK Versioning

See SDK Version Management for details.

Dynamically-Typed Languages (Ruby, Python, PHP, Node.js)

These SDKs offer flexible version control:

Global Configuration:

import stripe
stripe.api_version = '2026-08-26.dahlia'
Stripe.api_version = '2026-08-26.dahlia'
const stripe = require('stripe')('sk_test_xxx', {
  apiVersion: '2026-08-26.dahlia'
});

Per-Request Override:

stripe.Customer.create(
  email="customer@example.com",
  stripe_version='2026-08-26.dahlia'
)

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:

// Good: Explicit version
const stripe = require('stripe')('sk_test_xxx', {
  apiVersion: '2026-08-26.dahlia'
});

// Avoid: Relying on account default
const stripe = require('stripe')('sk_test_xxx');

Stripe.js Versioning

See Stripe.js Versioning for details.

Stripe.js uses an evergreen model with major releases (Acacia, Basil, Clover, Dahlia) on a biannual basis.

Loading Versioned Stripe.js

Via Script Tag:

<script src="https://js.stripe.com/dahlia/stripe.js"></script>

Via npm:

npm install @stripe/stripe-js

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:

  • Dahlia Stripe.js uses 2026-08-26.dahlia 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 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 for changes between your current and target versions
  2. Check Upgrades Guide for migration guidance
  3. Update server-side SDK package version (e.g., 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. Update webhook handlers to handle new event structures
  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:

curl https://api.stripe.com/v1/customers \
  -u sk_test_xxx: \
  -H "Stripe-Version: 2026-08-26.dahlia"

Or in code:

const stripe = require('stripe')('sk_test_xxx', {
  apiVersion: '2026-08-26.dahlia'  // Test with new version
});

Important Notes

  • 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
Files1
1 files · 1.1 KB

Select a file to preview

Overall Score

83/100

Grade

B

Good

Grades are signals, not a certification. Always review a skill yourself before use.

Safety

82

Quality

85

Clarity

88

Completeness

79

Summary

This skill provides comprehensive guidance for upgrading Stripe API versions and SDKs across multiple platforms (server, Stripe.js, mobile). It explains versioning concepts, breaking vs. backward-compatible changes, and offers step-by-step upgrade procedures with code examples and testing strategies.

Static Analysis Findings

1 finding

Patterns detected by deterministic static analysis before AI scoring. Hover over any finding code for detailed information and remediation guidance.

Network Access
SEC-060Outbound Network Request

Outbound network request (curl/wget/fetch)

SKILL.mdcurl https://

Detected Capabilities

HTTP request (curl example for testing)Documentation referenceCode snippet guidanceVersion comparison guidance

Trigger Keywords

Phrases that agents use to match this skill to user intent.

upgrade stripe versionstripe api migrationupdate stripe sdkstripe.js major releasestripe mobile sdk updatetest stripe api versionstripe version compatibility

Risk Signals

INFO

Outbound network request (curl to api.stripe.com)

SKILL.md | Testing API Version Changes section

Referenced Domains

External domains referenced in skill content, detected by static analysis.

api.stripe.comdocs.stripe.comjs.stripe.com

Use Cases

  • Upgrade server-side Stripe SDK to a new version
  • Migrate Stripe.js to a newer major release (e.g., Acacia to Basil)
  • Update mobile SDKs (iOS, Android, React Native) for Stripe integration
  • Test API version changes without modifying account defaults
  • Review breaking changes between Stripe API versions
  • Understand API version pairing with Stripe.js releases
  • Plan staged adoption of new Stripe API features

Quality Notes

  • Comprehensive coverage of versioning across all Stripe platforms (backend SDKs, Stripe.js, mobile)
  • Well-structured sections with clear headers and logical progression
  • Practical code examples for Python, Ruby, JavaScript demonstrating global and per-request version configuration
  • Clear distinction between strongly-typed and dynamically-typed languages with actionable guidance
  • Upgrade checklist provides step-by-step procedure
  • Testing section demonstrates safe version migration patterns
  • Clearly documents that Stripe.js version pairs automatically with API versions (no override possible)
  • Mobile SDK versioning explains differences across platforms (semantic vs. 0.x.y schema)
  • Important notes section addresses webhook handling and backward compatibility concerns
Model: claude-haiku-4-5-20251001Analyzed: Sep 9, 2026

Reviews

Add this skill to your library to leave a review.

No reviews yet

Be the first to share your experience.

Version History

  1. v1.2

    Content updated

    ✦ AIUpdates recommended Stripe API version from 2026-06-24.dahlia to 2026-08-26.dahlia across all code examples and documentation.

    2026-09-09

    LATEST
  2. v1.1

    Content updated

    ✦ AIUpdates recommended Stripe API version from 2026-04-22.dahlia to 2026-06-24.dahlia throughout examples and documentation.

    2026-06-28

    View This Version
  3. v1.0

    2026-05-02

    View This VersionInitial version

Use stripe/upgrade-stripe in your dev environment

Command Palette

Search for a command to run...