Please review the changelog for 22.0.2 for more information about changes in this release.
parseEventNotificationAsync to match existing sync functionemitEventBodies config option to include request and response bodies in request/response events.httpClient config type from HttpClient class to HttpClientInterface interface.// ✅ Fixed
import { Stripe } from 'stripe';
latest_version on V2.Billing.LicenseFee, V2.Billing.PricingPlan, and V2.Billing.RateCardservice_interval_count and service_interval on V2.Billing.LicenseFee and V2.Billing.RateCardV2.Core.WorkflowRun and V2.Core.Workflowreport_authorized method on resource PaymentAttemptRecordlist and retrieve methods on resource V2.Core.WorkflowRuninvoke, list, and retrieve methods on resource V2.Core.Workflownext_action and status on SharedPayment.IssuedTokennetwork_id on SharedPayment.IssuedToken.seller_detailsbills on AccountSession.componentssettlement_currencies on BalanceSettingUpdateParams.payments and BalanceSettings.paymentsdefault_settlement_currency on BalanceSettings.paymentsaccount_funding on Charge.payment_method_details.cardautomatic_surcharge on Checkout.SessionCreateParams, Checkout.Session, PaymentLinkCreateParams, and PaymentLinkbizum on Checkout.Session.payment_method_options and Checkout.SessionCreateParams.payment_method_optionssurcharge_cost on Checkout.Sessionamount_surcharge on Checkout.Session.total_detailsshared_payment_granted_token on ConfirmationTokenCreateParams.testHelpers.payment_method_data, PaymentIntentConfirmParams.payment_method_data, PaymentIntentCreateParams.payment_method_data, PaymentIntentUpdateParams.payment_method_data, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_dataemail on enums Identity.VerificationReportListParams.type, Identity.VerificationSessionCreateParams.type, and Identity.VerificationSessionUpdateParams.typedetails on Identity.VerificationReport.emailemail on enums Identity.VerificationReport.type and Identity.VerificationSession.typeconfirm on Identity.VerificationSessionCreateParams and Identity.VerificationSessionUpdateParamssubscription on InvoiceItem.parent.schedule_detailsshared_payment_granted_token on PaymentIntentConfirmParams and PaymentIntentCreateParamsmoney_services on PaymentIntent.payment_detailsexternal_reference on PlanSharedPayment.GrantedToken.payment_method_details.billing_details to be requiredpayment_record on ApplicationFee.fee_sourcebeneficiary_account, beneficiary_details, sender_account, and sender_details on ChargeCaptureParams.payment_details.money_services.account_funding, ChargeUpdateParams.payment_details.money_services.account_funding, PaymentIntentCaptureParams.payment_details.money_services.account_funding, PaymentIntentConfirmParams.payment_details.money_services.account_funding, PaymentIntentCreateParams.payment_details.money_services.account_funding, and PaymentIntentUpdateParams.payment_details.money_services.account_fundingChargeCaptureParams.payment_details.money_services.transaction_type, ChargeUpdateParams.payment_details.money_services.transaction_type, PaymentIntentCaptureParams.payment_details.money_services.transaction_type, PaymentIntentConfirmParams.payment_details.money_services.transaction_type, PaymentIntentCreateParams.payment_details.money_services.transaction_type, and PaymentIntentUpdateParams.payment_details.money_services.transaction_type from literal('account_funding') to emptyable(literal('account_funding'))bizum on Invoice.payment_settings.payment_method_options, InvoiceCreateParams.payment_settings.payment_method_options, InvoiceUpdateParams.payment_settings.payment_method_options, QuotePreviewInvoice.payment_settings.payment_method_options, Subscription.payment_settings.payment_method_options, SubscriptionCreateParams.payment_settings.payment_method_options, and SubscriptionUpdateParams.payment_settings.payment_method_optionsbizum on enums Invoice.payment_settings.payment_method_types, InvoiceCreateParams.payment_settings.payment_method_types, InvoiceUpdateParams.payment_settings.payment_method_types, QuotePreviewInvoice.payment_settings.payment_method_types, Subscription.payment_settings.payment_method_types, SubscriptionCreateParams.payment_settings.payment_method_types, and SubscriptionUpdateParams.payment_settings.payment_method_typesquantity_precision on PaymentIntentAmountDetailsLineItem, PaymentIntentCaptureParams.amount_details.line_items[], PaymentIntentConfirmParams.amount_details.line_items[], PaymentIntentCreateParams.amount_details.line_items[], PaymentIntentDecrementAuthorizationParams.amount_details.line_items[], PaymentIntentIncrementAuthorizationParams.amount_details.line_items[], and PaymentIntentUpdateParams.amount_details.line_items[]liquid_asset and wallet on PaymentIntentConfirmParams.payment_method_options.card.payment_details.money_services.account_funding, PaymentIntentConfirmParams.payment_method_options.card_present.payment_details.money_services.account_funding, PaymentIntentCreateParams.payment_method_options.card.payment_details.money_services.account_funding, PaymentIntentCreateParams.payment_method_options.card_present.payment_details.money_services.account_funding, PaymentIntentUpdateParams.payment_method_options.card.payment_details.money_services.account_funding, and PaymentIntentUpdateParams.payment_method_options.card_present.payment_details.money_services.account_fundingshared_payment_granted_token on PaymentMethodRadar.CustomerEvaluation.event_type from string to enum('login'|'registration')Radar.CustomerEvaluation.signals.account_sharing.risk_level and Radar.CustomerEvaluation.signals.multi_accounting.risk_level from string to enumdata on Radar.PaymentEvaluation.client_device_metadata_details and Radar.PaymentEvaluationCreateParams.client_device_metadata_detailssunbit on SharedPayment.GrantedToken.payment_method_detailssunbit on enum SharedPayment.GrantedToken.payment_method_details.typebm_crn, bo_tin, bt_tpn, co_nit, ec_ruc, eg_tin, gh_tin, gy_tin, hn_rtn, jm_trn, jo_crn, ke_pin, ky_crn, lk_tin, mo_tin, mv_tin, ng_tin, pa_ruc, ph_tin, py_ruc, sl_tin, sv_nit, uy_ruc, vg_cn, and za_tin from enums V2.Core.Account.identity.business_details.id_numbers[].type, V2.Core.AccountCreateParams.identity.business_details.id_numbers[].type, V2.Core.AccountTokenCreateParams.identity.business_details.id_numbers[].type, and V2.Core.AccountUpdateParams.identity.business_details.id_numbers[].typebm_pp, bo_ci, bt_cid, eg_tin, gh_pin, gy_tin, hn_rtn, jm_trn, jo_pin, ky_pp, lk_nic, mo_bir, mt_nic, mv_tin, pa_ruc, ph_tin, py_ruc, si_pin, sv_nit, and vg_pp from enums V2.Core.Account.identity.individual.id_numbers[].type, V2.Core.AccountCreateParams.identity.individual.id_numbers[].type, V2.Core.AccountPerson.id_numbers[].type, V2.Core.AccountPersonCreateParams.id_numbers[].type, V2.Core.AccountPersonTokenCreateParams.id_numbers[].type, V2.Core.AccountPersonUpdateParams.id_numbers[].type, V2.Core.AccountTokenCreateParams.identity.individual.id_numbers[].type, and V2.Core.AccountUpdateParams.identity.individual.id_numbers[].typeCannotProceedErrorPlease review the changelog for 22.0.1 for more information about changes in this release.
new keyword is now possible for CJS based TypeScript project. Resolves: 2660import Stripe = require('stripe');
// ✅ Both statements work
const stripeNew: Stripe.Stripe = new Stripe('sk_test_...');
const stripeCalled: Stripe.Stripe = Stripe('sk_test_...');
Stripe constructor config parameter to use StripeConfig type instead of Record<string, unknown>, restoring compile-time type safety.authenticator property to StripeConfig.Stripe.API_VERSION to retain the literal API version type.StripeConfig.stripeContext to accept StripeContext objects in addition to strings.rawRequest with absolute urlsstring[] to WebhookHeader type for compatibility with express
string[] to the type of signature param in stripe.webhooks.construct_event method.This release changes the pinned API version to 2026-04-01.preview and contains additional breaking changes. See the GA changelog for more information.
SharedPayment.IssuedToken and V2.Data.Reporting.QueryRuncreate and retrieve methods on resource V2.Data.Reporting.QueryRunpause and resume methods on resource V2.Payments.OffSessionPaymenttenant_keys, tenant_operator, and tenant_values on Billing.MeterListMeterEventSummariesParamsfleet_data on ChargeCaptureParams.payment_details, ChargeUpdateParams.payment_details, PaymentIntent.payment_details, PaymentIntentAmountDetailsLineItem.payment_method_options.card, PaymentIntentCaptureParams.amount_details.line_items[].payment_method_options.card, PaymentIntentCaptureParams.payment_details, PaymentIntentConfirmParams.amount_details.line_items[].payment_method_options.card, PaymentIntentConfirmParams.payment_details, PaymentIntentCreateParams.amount_details.line_items[].payment_method_options.card, PaymentIntentCreateParams.payment_details, PaymentIntentDecrementAuthorizationParams.amount_details.line_items[].payment_method_options.card, PaymentIntentIncrementAuthorizationParams.amount_details.line_items[].payment_method_options.card, PaymentIntentUpdateParams.amount_details.line_items[].payment_method_options.card, and PaymentIntentUpdateParams.payment_detailsmoney_services on ChargeCaptureParams.payment_details, ChargeUpdateParams.payment_details, PaymentIntentCaptureParams.payment_details, PaymentIntentConfirmParams.payment_details, PaymentIntentCreateParams.payment_details, and PaymentIntentUpdateParams.payment_detailspayment_method_options on DelegatedCheckout.RequestedSessionCreateParams, DelegatedCheckout.RequestedSessionUpdateParams, and DelegatedCheckout.RequestedSessionpayment_method_data on DelegatedCheckout.RequestedSessionConfirmParams, DelegatedCheckout.RequestedSessionCreateParams, and DelegatedCheckout.RequestedSessionUpdateParamscard_brands and payment_method_types on DelegatedCheckout.RequestedSession.seller_detailsDelegatedCheckout.RequestedSession.shared_payment_issued_token from string to expandable(SharedPayment.IssuedToken)requires_action on enum DelegatedCheckout.RequestedSession.statuscheck_scan on Invoice.payment_settings.payment_method_options, InvoiceCreateParams.payment_settings.payment_method_options, InvoiceUpdateParams.payment_settings.payment_method_options, QuotePreviewInvoice.payment_settings.payment_method_options, Subscription.payment_settings.payment_method_options, SubscriptionCreateParams.payment_settings.payment_method_options, and SubscriptionUpdateParams.payment_settings.payment_method_optionscheck_scan on enums Invoice.payment_settings.payment_method_types, InvoiceCreateParams.payment_settings.payment_method_types, InvoiceUpdateParams.payment_settings.payment_method_types, QuotePreviewInvoice.payment_settings.payment_method_types, Subscription.payment_settings.payment_method_types, SubscriptionCreateParams.payment_settings.payment_method_types, and SubscriptionUpdateParams.payment_settings.payment_method_typesprocessor_details on PaymentAttemptRecordReportFailedParams, PaymentAttemptRecordReportGuaranteedParams, PaymentRecordReportPaymentAttemptFailedParams, PaymentRecordReportPaymentAttemptGuaranteedParams, PaymentRecordReportPaymentAttemptParams.failed, PaymentRecordReportPaymentAttemptParams.guaranteed, PaymentRecordReportPaymentParams.failed, and PaymentRecordReportPaymentParams.guaranteedpayment_details on PaymentIntentConfirmParams.payment_method_options.card_present, PaymentIntentConfirmParams.payment_method_options.card, PaymentIntentCreateParams.payment_method_options.card_present, PaymentIntentCreateParams.payment_method_options.card, PaymentIntentUpdateParams.payment_method_options.card_present, and PaymentIntentUpdateParams.payment_method_options.cardbill_from on QuotePreviewSubscriptionSchedule.billing_schedules[], Subscription.billing_schedules[], and SubscriptionSchedule.billing_schedules[]agent_details, payment_method_details, and risk_details on SharedPayment.GrantedTokenpaper_checks on V2.Account.configuration.recipient_data.features, V2.AccountCreateParams.configuration.recipient_data.features, V2.AccountUpdateParams.configuration.recipient_data.features, V2.Core.Account.configuration.recipient.capabilities, V2.Core.Account.configuration.storer.capabilities.outbound_payments, V2.Core.AccountCreateParams.configuration.recipient.capabilities, V2.Core.AccountCreateParams.configuration.storer.capabilities.outbound_payments, V2.Core.AccountUpdateParams.configuration.recipient.capabilities, and V2.Core.AccountUpdateParams.configuration.storer.capabilities.outbound_paymentspaper_checks on enum V2.Account.configuration.supportable_features.recipient_datapaper_checks on enum V2.Account.requirements[].impact.required_for_featuresV2.Billing.Cadence.settings_data.collection.payment_method_options.konbini, V2.Billing.CollectionSetting.payment_method_options.konbini, V2.Billing.CollectionSettingCreateParams.payment_method_options.konbini, V2.Billing.CollectionSettingUpdateParams.payment_method_options.konbini, and V2.Billing.CollectionSettingVersion.payment_method_options.konbini from map(string: dynamic) to an objectV2.Billing.Cadence.settings_data.collection.payment_method_options.sepa_debit, V2.Billing.CollectionSetting.payment_method_options.sepa_debit, V2.Billing.CollectionSettingCreateParams.payment_method_options.sepa_debit, V2.Billing.CollectionSettingUpdateParams.payment_method_options.sepa_debit, and V2.Billing.CollectionSettingVersion.payment_method_options.sepa_debit from map(string: dynamic) to an objectid on V2.Billing.CadenceSpendModifier.max_billing_period_spend.amount.custom_pricing_unit, V2.Billing.IntentAction.apply.spend_modifier_rule.max_billing_period_spend.amount.custom_pricing_unit, and V2.Billing.IntentCreateParams.actions[].apply.spend_modifier_rule.max_billing_period_spend.amount.custom_pricing_unitoutbound_payments.paper_checks and paper_checks on enums V2.Core.Account.future_requirements.entries[].impact.restricts_capabilities[].capability and V2.Core.Account.requirements.entries[].impact.restricts_capabilities[].capabilitybm_crn, bo_tin, bt_tpn, co_nit, ec_ruc, eg_tin, gh_tin, gy_tin, hn_rtn, jm_trn, jo_crn, ke_pin, ky_crn, lk_tin, mo_tin, mv_tin, ng_tin, pa_ruc, ph_tin, py_ruc, sl_tin, sv_nit, uy_ruc, vg_cn, and za_tin on enums V2.Core.Account.identity.business_details.id_numbers[].type, V2.Core.AccountCreateParams.identity.business_details.id_numbers[].type, V2.Core.AccountTokenCreateParams.identity.business_details.id_numbers[].type, and V2.Core.AccountUpdateParams.identity.business_details.id_numbers[].typebm_pp, bo_ci, bt_cid, eg_tin, gh_pin, gy_tin, hn_rtn, jm_trn, jo_pin, ky_pp, lk_nic, mo_bir, mt_nic, mv_tin, pa_ruc, ph_tin, py_ruc, si_pin, sv_nit, and vg_pp on enums V2.Core.Account.identity.individual.id_numbers[].type, V2.Core.AccountCreateParams.identity.individual.id_numbers[].type, V2.Core.AccountPerson.id_numbers[].type, V2.Core.AccountPersonCreateParams.id_numbers[].type, V2.Core.AccountPersonTokenCreateParams.id_numbers[].type, V2.Core.AccountPersonUpdateParams.id_numbers[].type, V2.Core.AccountTokenCreateParams.identity.individual.id_numbers[].type, and V2.Core.AccountUpdateParams.identity.individual.id_numbers[].typeV2.Core.Event.reason.request.client.stripe_action from map(string: dynamic) to an objectV2.MoneyManagement.InboundTransfer.transfer_history[].bank_debit_processing from map(string: dynamic) to an objectV2.MoneyManagement.InboundTransfer.transfer_history[].bank_debit_queued from map(string: dynamic) to an objectV2.MoneyManagement.InboundTransfer.transfer_history[].bank_debit_succeeded from map(string: dynamic) to an objectpaper_check_attachment_too_large, paper_check_expired, and paper_check_undeliverable on enum V2.MoneyManagement.OutboundPayment.status_details.failed.reasontown on V2.MoneyManagement.OutboundPayment.tracking_details.paper_check.mailing_addressV2.MoneyManagement.OutboundPayment.delivery_options.paper_check.memo to be requiredpayout_method_amount_limit_exceeded on enum V2.MoneyManagement.OutboundTransfer.status_details.failed.reasonapplication_fee_amount_requested on V2.Payments.OffSessionPaymentcompartment_id on V2.Payments.OffSessionPaymentexceeded_retry_window on enum V2.Payments.OffSessionPayment.failure_reasonretry_until on V2.Payments.OffSessionPayment.retry_detailspaused on enum V2.Payments.OffSessionPayment.statusV2.Reporting.ReportRun.result.file to be optionalapplication_fee_amount on V2.Payments.OffSessionPaymentCaptureParams and V2.Payments.OffSessionPaymentCreateParamspaper_checks on enum EventsV2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.updated_capabilityoutbound_payments.paper_checks on enum EventsV2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.updated_capabilityalert_id on EventsV2CoreHealthApiErrorResolvedEvent, EventsV2CoreHealthApiLatencyResolvedEvent, EventsV2CoreHealthAuthorizationRateDropResolvedEvent, EventsV2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent, EventsV2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent, EventsV2CoreHealthPaymentMethodErrorResolvedEvent, EventsV2CoreHealthSepaDebitDelayedFiringEvent, EventsV2CoreHealthSepaDebitDelayedResolvedEvent, EventsV2CoreHealthTrafficVolumeDropResolvedEvent, and EventsV2CoreHealthWebhookLatencyResolvedEventapi_key on EventsV2IamApiKeyCreatedEvent, EventsV2IamApiKeyDefaultSecretRevealedEvent, EventsV2IamApiKeyExpiredEvent, EventsV2IamApiKeyPermissionsUpdatedEvent, EventsV2IamApiKeyRotatedEvent, and EventsV2IamApiKeyUpdatedEventstripe_access_grant on EventsV2IamStripeAccessGrantApprovedEvent, EventsV2IamStripeAccessGrantCanceledEvent, EventsV2IamStripeAccessGrantDeniedEvent, EventsV2IamStripeAccessGrantRemovedEvent, EventsV2IamStripeAccessGrantRequestedEvent, and EventsV2IamStripeAccessGrantUpdatedEventV2DataReportingQueryRunCreatedEvent, V2DataReportingQueryRunFailedEvent, V2DataReportingQueryRunSucceededEvent, and V2DataReportingQueryRunUpdatedEvent with related object V2.Data.Reporting.QueryRunV2PaymentsOffSessionPaymentPausedEvent and V2PaymentsOffSessionPaymentResumedEvent with related object V2.Payments.OffSessionPaymentPlease review the changelog for 22.0.0 for more information about changes in this release.
This release uses the same pinned API version to 2026-03-25.dahlia as the last major release. The breaking changes in this release are prefixed with ⚠️ below. There's also a detailed migration guide to simplify your upgrade process.
Stripe.StripeContext is no longer exported as a type. Use Stripe.StripeContextType instead.Stripe.errors.StripeError is no longer a type. Use typeof Stripe.errors.StripeError or Stripe.ErrorType instead.new Stripe() to create a StripeClient instead of calling it:// Before
const stripeClient = Stripe("sk_test_...");
// After
const stripeClient = new Stripe("sk_test_...");
#2645 ⚠️ Remove stripeMethod and standardize how function args are handled (including removing callback support)
async / await insteadRequestOptions under the apiKey propertyparams and options objects are no longer mixed. If present on a method, RequestParams must always come first and RequestOptions must always come second. To supply options without params, pass undefined as the first argument explicitlyStripeResource: createFullPath, createResourcePathWithSymbols, extend, method and _joinUrlParts. These were mostly intended for internal use and we no longer need themAs a result, the following call patterns are no longer supported:
stripe.customers.retrieve('cus_123', 'sk_test_123')
stripe.customers.create({name: 'david', host: 'example.com'}, 'sk_test_123')
stripe.customers.create({apiKey: 'sk_test_123'})
stripe.customers.list(customers => {
// do something with customers
})
#2643 ⚠️ Removed per-request host override. To use a custom host, set it in the client configuration. All requests from that client will use that host.
Before:
import Stripe from 'stripe';
const stripe = new Stripe('sk_test_...');
const customer = await stripe.customers.create({
email: 'customer@example.com',
}, {host: 'example.com'});
After:
import Stripe from 'stripe';
const stripe = new Stripe('sk_test_...', {host: 'example.com'});
// goes to example.com
const customer = await stripe.customers.create({
email: 'customer@example.com',
});
#2638 Converted V2/Amount.ts to V2/V2Amount.ts
This release changes the pinned API version to 2026-03-25.preview and contains additional breaking changes. See the GA changelog for more information.
RiskSignalsupi_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiesrisk_signals on Accountfinancial_account_rewards and nesting_demo on AccountSession.componentsfraud_intent on AccountSignalsrelated_accounts on enum AccountSignals.delinquency.indicators[].indicatorrisk_reserved on Balancebillable_items on Billing.Alert.spend_threshold.filtersupi on Charge.payment_method_details, Checkout.Session.payment_method_options, Checkout.SessionCreateParams.payment_method_options, ConfirmationToken.payment_method_preview, ConfirmationTokenCreateParams.testHelpers.payment_method_data, Mandate.payment_method_details, PaymentAttemptRecord.payment_method_details, PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_data, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_method_data, PaymentIntentCreateParams.payment_method_options, PaymentIntentUpdateParams.payment_method_data, PaymentIntentUpdateParams.payment_method_options, PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, PaymentMethodConfiguration, PaymentMethodCreateParams, PaymentMethod, PaymentRecord.payment_method_details, SetupAttempt.payment_method_details, SetupIntent.payment_method_options, SetupIntentConfirmParams.payment_method_data, SetupIntentConfirmParams.payment_method_options, SetupIntentCreateParams.payment_method_data, SetupIntentCreateParams.payment_method_options, SetupIntentUpdateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_optionstempo on enums Charge.payment_method_details.crypto.network, PaymentAttemptRecord.payment_method_details.crypto.network, and PaymentRecord.payment_method_details.crypto.networksource_type on Charge.payment_method_details.stripe_balance, ConfirmationToken.payment_method_preview.stripe_balance, ConfirmationTokenCreateParams.testHelpers.payment_method_data.stripe_balance, PaymentAttemptRecord.payment_method_details.stripe_balance, PaymentIntentConfirmParams.payment_method_data.stripe_balance, PaymentIntentCreateParams.payment_method_data.stripe_balance, PaymentIntentUpdateParams.payment_method_data.stripe_balance, PaymentMethod.stripe_balance, PaymentMethodCreateParams.stripe_balance, PaymentRecord.payment_method_details.stripe_balance, SetupIntentConfirmParams.payment_method_data.stripe_balance, SetupIntentCreateParams.payment_method_data.stripe_balance, and SetupIntentUpdateParams.payment_method_data.stripe_balanceintegration_identifier on Checkout.SessionCreateParams and Checkout.Sessionapplication on enums Checkout.Session.automatic_tax.liability.type, Checkout.Session.invoice_creation.invoice_data.issuer.type, Checkout.SessionCreateParams.automatic_tax.liability.type, Checkout.SessionCreateParams.invoice_creation.invoice_data.issuer.type, Checkout.SessionCreateParams.subscription_data.invoice_settings.issuer.type, Checkout.SessionUpdateParams.automatic_tax.liability.type, Checkout.SessionUpdateParams.invoice_creation.invoice_data.issuer.type, Checkout.SessionUpdateParams.subscription_data.invoice_settings.issuer.type, Invoice.automatic_tax.liability.type, Invoice.issuer.type, InvoiceCreateParams.automatic_tax.liability.type, InvoiceCreateParams.issuer.type, InvoiceCreatePreviewParams.automatic_tax.liability.type, InvoiceCreatePreviewParams.issuer.type, InvoiceCreatePreviewParams.schedule_details.phases[].automatic_tax.liability.type, InvoiceCreatePreviewParams.schedule_details.phases[].invoice_settings.issuer.type, InvoiceUpdateParams.automatic_tax.liability.type, InvoiceUpdateParams.issuer.type, PaymentLink.automatic_tax.liability.type, PaymentLink.invoice_creation.invoice_data.issuer.type, PaymentLink.subscription_data.invoice_settings.issuer.type, PaymentLinkCreateParams.automatic_tax.liability.type, PaymentLinkCreateParams.invoice_creation.invoice_data.issuer.type, PaymentLinkCreateParams.subscription_data.invoice_settings.issuer.type, PaymentLinkUpdateParams.automatic_tax.liability.type, PaymentLinkUpdateParams.invoice_creation.invoice_data.issuer.type, PaymentLinkUpdateParams.subscription_data.invoice_settings.issuer.type, Quote.automatic_tax.liability.type, Quote.invoice_settings.issuer.type, QuoteCreateParams.automatic_tax.liability.type, QuoteCreateParams.invoice_settings.issuer.type, QuotePreviewInvoice.automatic_tax.liability.type, QuotePreviewInvoice.issuer.type, QuotePreviewSubscriptionSchedule.default_settings.automatic_tax.liability.type, QuotePreviewSubscriptionSchedule.default_settings.invoice_settings.issuer.type, QuotePreviewSubscriptionSchedule.phases[].automatic_tax.liability.type, QuotePreviewSubscriptionSchedule.phases[].invoice_settings.issuer.type, QuoteUpdateParams.automatic_tax.liability.type, QuoteUpdateParams.invoice_settings.issuer.type, Subscription.automatic_tax.liability.type, Subscription.invoice_settings.issuer.type, SubscriptionCreateParams.automatic_tax.liability.type, SubscriptionCreateParams.invoice_settings.issuer.type, SubscriptionSchedule.default_settings.automatic_tax.liability.type, SubscriptionSchedule.default_settings.invoice_settings.issuer.type, SubscriptionSchedule.phases[].automatic_tax.liability.type, SubscriptionSchedule.phases[].invoice_settings.issuer.type, SubscriptionScheduleCreateParams.default_settings.automatic_tax.liability.type, SubscriptionScheduleCreateParams.default_settings.invoice_settings.issuer.type, SubscriptionScheduleCreateParams.phases[].automatic_tax.liability.type, SubscriptionScheduleCreateParams.phases[].invoice_settings.issuer.type, SubscriptionScheduleUpdateParams.default_settings.automatic_tax.liability.type, SubscriptionScheduleUpdateParams.default_settings.invoice_settings.issuer.type, SubscriptionScheduleUpdateParams.phases[].automatic_tax.liability.type, SubscriptionScheduleUpdateParams.phases[].invoice_settings.issuer.type, SubscriptionUpdateParams.automatic_tax.liability.type, and SubscriptionUpdateParams.invoice_settings.issuer.typeupi on enum Checkout.SessionCreateParams.excluded_payment_method_typesCheckout.SessionCreateParams.line_items[].price_data.product_data.tax_details.tax_code, Checkout.SessionUpdateParams.line_items[].price_data.product_data.tax_details.tax_code, InvoiceAddLinesParams.lines[].price_data.product_data.tax_details.tax_code, InvoiceLineItemUpdateParams.price_data.product_data.tax_details.tax_code, InvoiceUpdateLinesParams.lines[].price_data.product_data.tax_details.tax_code, PaymentLinkCreateParams.line_items[].price_data.product_data.tax_details.tax_code, PlanCreateParams.product[0].tax_details.tax_code, PriceCreateParams.product_data.tax_details.tax_code, ProductCreateParams.tax_details.tax_code, and ProductUpdateParams.tax_details.tax_code from string to emptyable(string)crypto on Checkout.SessionCreateParams.payment_method_optionsupi on enum Checkout.SessionCreateParams.payment_method_typespending_invoice_item_interval on Checkout.SessionCreateParams.subscription_data and Checkout.SessionUpdateParams.subscription_dataelements, embedded_page, form, and hosted_page on enums Checkout.Session.ui_mode and Checkout.SessionCreateParams.ui_modecustom, embedded, and hosted from enums Checkout.Session.ui_mode and Checkout.SessionCreateParams.ui_modeCheckout.SessionCreateParams.line_items[].price_data.product_data.tax_details.tax_code, Checkout.SessionUpdateParams.line_items[].price_data.product_data.tax_details.tax_code, InvoiceAddLinesParams.lines[].price_data.product_data.tax_details.tax_code, InvoiceLineItemUpdateParams.price_data.product_data.tax_details.tax_code, InvoiceUpdateLinesParams.lines[].price_data.product_data.tax_details.tax_code, PaymentLinkCreateParams.line_items[].price_data.product_data.tax_details.tax_code, PlanCreateParams.product[0].tax_details.tax_code, PriceCreateParams.product_data.tax_details.tax_code, ProductCreateParams.tax_details.tax_code, and ProductUpdateParams.tax_details.tax_code to be optionalau_becs_debit, bacs_debit, boleto, link, sepa_debit, and us_bank_account on Checkout.Session.current_attempt.payment_method_detailsmarine_carbon_removal on enum Climate.Supplier.removal_pathwayupi on enums ConfirmationTokenCreateParams.testHelpers.payment_method_data.type, PaymentIntentConfirmParams.payment_method_data.type, PaymentIntentCreateParams.payment_method_data.type, PaymentIntentUpdateParams.payment_method_data.type, SetupIntentConfirmParams.payment_method_data.type, SetupIntentCreateParams.payment_method_data.type, and SetupIntentUpdateParams.payment_method_data.typeupi on enums ConfirmationToken.payment_method_preview.type and PaymentMethod.typemetadata on CreditNoteCreateParams.lines[], CreditNoteLineItem, CreditNotePreviewLinesParams.lines[], and CreditNotePreviewParams.lines[]upi on enums CustomerListPaymentMethodsParams.type, PaymentMethodCreateParams.type, and PaymentMethodListParams.typeselected_fulfillment_option_overrides on DelegatedCheckout.RequestedSession.fulfillment_detailsline_item_keys on DelegatedCheckout.RequestedSession.fulfillment_details.fulfillment_options[].digital.digital_options[] and DelegatedCheckout.RequestedSession.fulfillment_details.fulfillment_options[].shipping.shipping_options[]quantity_decimal on InvoiceAddLinesParams.lines[], InvoiceCreatePreviewParams.invoice_items[], InvoiceItemCreateParams, InvoiceItemUpdateParams, InvoiceItem, InvoiceLineItemUpdateParams, InvoiceLineItem, and InvoiceUpdateLinesParams.lines[]expires_after_seconds on Invoice.payment_settings.payment_method_options.pix, InvoiceCreateParams.payment_settings.payment_method_options.pix, InvoiceUpdateParams.payment_settings.payment_method_options.pix, QuotePreviewInvoice.payment_settings.payment_method_options.pix, Subscription.payment_settings.payment_method_options.pix, SubscriptionCreateParams.payment_settings.payment_method_options.pix, and SubscriptionUpdateParams.payment_settings.payment_method_options.pixlevel on Issuing.AuthorizationCreateParams.testHelpers.risk_assessment.card_testing_risk and Issuing.AuthorizationCreateParams.testHelpers.risk_assessment.merchant_dispute_riskrisk_level on Issuing.AuthorizationCreateParams.testHelpers.risk_assessment.card_testing_risk and Issuing.AuthorizationCreateParams.testHelpers.risk_assessment.merchant_dispute_riskda, pl, and sv on enums Issuing.Cardholder.preferred_locales, Issuing.CardholderCreateParams.preferred_locales, and Issuing.CardholderUpdateParams.preferred_localeslifecycle_controls on Issuing.CardCreateParams and Issuing.CardIssuing.Token.network_data.visa.card_reference_id from string to string | nullPaymentAttemptRecord.payment_method_details.card.brand and PaymentRecord.payment_method_details.card.brand from enum to enum | nullPaymentAttemptRecord.payment_method_details.card.exp_month and PaymentRecord.payment_method_details.card.exp_month from longInteger to longInteger | nullPaymentAttemptRecord.payment_method_details.card.exp_year and PaymentRecord.payment_method_details.card.exp_year from longInteger to longInteger | nullPaymentAttemptRecord.payment_method_details.card.funding and PaymentRecord.payment_method_details.card.funding from enum('credit'|'debit'|'prepaid'|'unknown') to enum('credit'|'debit'|'prepaid'|'unknown') | nullPaymentAttemptRecord.payment_method_details.card.last4 and PaymentRecord.payment_method_details.card.last4 from string to string | nullPaymentAttemptRecord.payment_method_details.card.moto and PaymentRecord.payment_method_details.card.moto from boolean to boolean | nullcryptogram, electronic_commerce_indicator, exemption_indicator_applied, and exemption_indicator on PaymentAttemptRecord.payment_method_details.card.three_d_secure and PaymentRecord.payment_method_details.card.three_d_securesurcharge on PaymentIntent.amount_details, PaymentIntentCaptureParams.amount_details, PaymentIntentConfirmParams.amount_details, PaymentIntentCreateParams.amount_details, PaymentIntentIncrementAuthorizationParams.amount_details, and PaymentIntentUpdateParams.amount_detailsupi on enums PaymentIntent.excluded_payment_method_types, PaymentIntentConfirmParams.excluded_payment_method_types, PaymentIntentCreateParams.excluded_payment_method_types, PaymentIntentUpdateParams.excluded_payment_method_types, SetupIntent.excluded_payment_method_types, SetupIntentCreateParams.excluded_payment_method_types, and SetupIntentUpdateParams.excluded_payment_method_typesmandate_options on PaymentIntent.payment_method_options.stripe_balance, PaymentIntentConfirmParams.payment_method_options.stripe_balance, PaymentIntentCreateParams.payment_method_options.stripe_balance, and PaymentIntentUpdateParams.payment_method_options.stripe_balanceamount_details and payment_details on PaymentIntentDecrementAuthorizationParamsupi_handle_redirect_or_display_qr_code on PaymentIntent.next_action and SetupIntent.next_actionmanaged_payments on PaymentLinkCreateParams and PaymentLinkupi on enums PaymentLink.payment_method_types, PaymentLinkCreateParams.payment_method_types, and PaymentLinkUpdateParams.payment_method_typesrecommended_action and signals on Radar.PaymentEvaluationinsights on Radar.PaymentEvaluationcrypto_fingerprint on enums Radar.ValueList.item_type and Radar.ValueListCreateParams.item_typestripe_balance on SetupIntent.payment_method_options, SetupIntentConfirmParams.payment_method_options, SetupIntentCreateParams.payment_method_options, and SetupIntentUpdateParams.payment_method_optionsresolved on enum SharedPayment.GrantedToken.deactivated_reasonrecurring_interval on SharedPayment.GrantedToken.usage_limitsSharedPayment.GrantedToken.usage_limits.expires_at from DateTime to DateTime | nullpresentment_details on Subscriptioncanceled_by_retention_policy on enum Subscription.cancellation_details.reason2026-03-25.dahlia on enum WebhookEndpointCreateParams.api_versioninvoice_resources on V2.Billing.Intentamount_due and customer_balance_applied on V2.Billing.Intent.amount_detailsrecurring_credit_grant on V2.Billing.IntentAction.modify.pricing_plan_subscription_details.overrides.partial_period_behaviors[], V2.Billing.IntentAction.subscribe.pricing_plan_subscription_details.overrides.partial_period_behaviors[], V2.Billing.IntentCreateParams.actions[].modify.pricing_plan_subscription_details.overrides.partial_period_behaviors[], and V2.Billing.IntentCreateParams.actions[].subscribe.pricing_plan_subscription_details.overrides.partial_period_behaviors[]consumer_privacy_disclosures and consumer_storer on V2.Core.Account.identity.attestations.terms_of_service, V2.Core.AccountCreateParams.identity.attestations.terms_of_service, and V2.Core.AccountUpdateParams.identity.attestations.terms_of_serviceinclude on V2.Billing.IntentCreateParams and V2.Billing.IntentReserveParamsservice_period_coupon_with_metered_tiered_item_unsupported on Invoice.last_finalization_error, PaymentIntent.last_payment_error, QuotePreviewInvoice.last_finalization_error, SetupAttempt.setup_error, SetupIntent.last_setup_error, and StripeErrorV2.Core.AccountEvaluationV2.Billing.LicenseFeeSubscription and V2.Billing.PricingPlanSubscriptionComponentscreate method on resource V2.Core.AccountEvaluationretrieve method on resources V2.Billing.LicenseFeeSubscription and V2.Billing.PricingPlanSubscriptionComponentsmodify_rates method on resource V2.Billing.RateCardremove_discounts method on resource V2.Billing.PricingPlanSubscriptioneg_bank_account on enum V2.Account.configuration.recipient_data.default_outbound_destination.typeinvoice_resources on V2.Billing.Intentamount_due and customer_balance_applied on V2.Billing.Intent.amount_detailsexpires_at on V2.Billing.Intent.status_transitionsdiscount on V2.Billing.IntentAction.apply and V2.Billing.IntentCreateParams.actions[].applytimestamp on V2.Billing.IntentAction.apply.effective_at and V2.Billing.IntentCreateParams.actions[].apply.effective_atcurrent_billing_period_start and timestamp on enums V2.Billing.IntentAction.apply.effective_at.type and V2.Billing.IntentCreateParams.actions[].apply.effective_at.typediscount on enums V2.Billing.IntentAction.apply.type and V2.Billing.IntentCreateParams.actions[].apply.typeV2.Billing.IntentAction.deactivate.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type, V2.Billing.IntentAction.modify.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type, V2.Billing.IntentAction.subscribe.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type, V2.Billing.IntentCreateParams.actions[].deactivate.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type, V2.Billing.IntentCreateParams.actions[].modify.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type, and V2.Billing.IntentCreateParams.actions[].subscribe.pricing_plan_subscription_details.overrides.partial_period_behaviors[].type from literal('license_fee') to enum('license_fee'|'recurring_credit_grant')service_cycle on V2.Billing.LicenseFee and V2.Billing.RateCardlatest_version on V2.Billing.LicenseFee, V2.Billing.PricingPlan, and V2.Billing.RateCardservice_interval_count and service_interval on V2.Billing.LicenseFee and V2.Billing.RateCardV2.Billing.LicenseFee.transform_quantity.divide_by, V2.Billing.LicenseFeeCreateParams.transform_quantity.divide_by, V2.Billing.LicenseFeeUpdateParams.transform_quantity.divide_by, V2.Billing.LicenseFeeVersion.transform_quantity.divide_by, V2.Billing.RateCardRate.transform_quantity.divide_by, and V2.Billing.RateCardRateCreateParams.transform_quantity.divide_by from longInteger to int64_stringdiscount_details and pricing_plan_component_details on V2.Billing.PricingPlanSubscriptioncrypto_wallets on enums V2.Core.Account.future_requirements.entries[].impact.restricts_capabilities[].capability and V2.Core.Account.requirements.entries[].impact.restricts_capabilities[].capabilitycrypto from enums V2.Core.Account.future_requirements.entries[].impact.restricts_capabilities[].capability and V2.Core.Account.requirements.entries[].impact.restricts_capabilities[].capabilitybalance_by_funds_type on V2.MoneyManagement.FinancialAccount.paymentsnext_day_payout_fee on enum V2.MoneyManagement.OutboundPaymentQuote.estimated_fees[].typetreasury_transaction_entry on V2.MoneyManagement.TransactionEntrytreasury_credit_reversal, treasury_debit_reversal, treasury_inbound_transfer, treasury_issuing_authorization, treasury_outbound_payment, treasury_outbound_transfer, treasury_received_credit, and treasury_received_debit on V2.MoneyManagement.Transaction.flow and V2.MoneyManagement.TransactionEntry.transaction_details.flowtreasury_credit_reversal, treasury_debit_reversal, treasury_inbound_transfer, treasury_issuing_authorization, treasury_other, treasury_outbound_payment, treasury_outbound_transfer, treasury_received_credit, and treasury_received_debit on enums V2.MoneyManagement.Transaction.flow.type and V2.MoneyManagement.TransactionEntry.transaction_details.flow.typetreasury_transaction on V2.MoneyManagement.Transactionno_valid_payment_method on enum V2.Payments.OffSessionPayment.failure_reasonmetadata on V2.Payments.SettlementAllocationIntentSplitV2.Reporting.ReportRun.result.file.size from longInteger to int64_stringstatement_descriptor on V2.MoneyManagement.OutboundPaymentCreateParams and V2.MoneyManagement.OutboundTransferCreateParamsinclude on V2.Billing.IntentCreateParams, V2.Billing.IntentReserveParams, V2.Billing.PricingPlanSubscriptionListParams, V2.Billing.PricingPlanSubscriptionRetrieveParams, V2.MoneyManagement.FinancialAccountListParams, and V2.MoneyManagement.FinancialAccountRetrieveParamsV1AccountSignalsIncludingDelinquencyCreatedEvent, V2CoreAccountSignalsFraudulentWebsiteReadyEvent, and V2SignalsAccountSignalFraudulentMerchantReadyEventThis release changes the pinned API version to 2026-03-25.preview. It is built on top of SDK version 21.0.0 which contains breaking changes. Please review the changelog for 21.0.0 if upgrading from older SDK versions.
ProductCatalog.TrialOffer, Tax.Location, and V2.Core.BatchJobcreate method on resource ProductCatalog.TrialOffercreate, list, and retrieve methods on resource Tax.Locationcancel, create, and retrieve methods on resource V2.Core.BatchJobperformance_location on Tax.CalculationCreateParams.line_items[] and Tax.CalculationLineItemperformance on enums Tax.Calculation.shipping_cost.tax_breakdown[].sourcing, Tax.CalculationLineItem.tax_breakdown[].sourcing, and Tax.Transaction.shipping_cost.tax_breakdown[].sourcingadmissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, luxury_tax, resort_tax, and tourism_tax on enums Tax.Calculation.shipping_cost.tax_breakdown[].tax_rate_details.tax_type, Tax.Calculation.tax_breakdown[].tax_rate_details.tax_type, Tax.CalculationLineItem.tax_breakdown[].tax_rate_details.tax_type, and Tax.Transaction.shipping_cost.tax_breakdown[].tax_rate_details.tax_typetrial_offer on InvoiceCreatePreviewParams.schedule_details.amendments[].item_actions[].add, InvoiceCreatePreviewParams.schedule_details.amendments[].item_actions[].set, InvoiceCreatePreviewParams.schedule_details.phases[].items[], QuoteCreateParams.lines[].actions[].add_item, QuoteCreateParams.lines[].actions[].set_items[], QuoteLine.actions[].add_item, QuoteLine.actions[].set_items[], QuotePreviewSubscriptionSchedule.phases[].items[], QuoteUpdateParams.lines[].actions[].add_item, QuoteUpdateParams.lines[].actions[].set_items[], SubscriptionSchedule.phases[].items[], SubscriptionScheduleAmendParams.amendments[].item_actions[].add, SubscriptionScheduleAmendParams.amendments[].item_actions[].set, SubscriptionScheduleCreateParams.phases[].items[], and SubscriptionScheduleUpdateParams.phases[].items[]risk_reserved on Balancesource_type on Charge.payment_method_details.stripe_balance, ConfirmationToken.payment_method_preview.stripe_balance, ConfirmationTokenCreateParams.testHelpers.payment_method_data.stripe_balance, PaymentAttemptRecord.payment_method_details.stripe_balance, PaymentIntentConfirmParams.payment_method_data.stripe_balance, PaymentIntentCreateParams.payment_method_data.stripe_balance, PaymentIntentUpdateParams.payment_method_data.stripe_balance, PaymentMethod.stripe_balance, PaymentMethodCreateParams.stripe_balance, PaymentRecord.payment_method_details.stripe_balance, SetupIntentConfirmParams.payment_method_data.stripe_balance, SetupIntentCreateParams.payment_method_data.stripe_balance, and SetupIntentUpdateParams.payment_method_data.stripe_balancetax_details on Checkout.SessionCreateParams.line_items[].price_data.product_data, Checkout.SessionUpdateParams.line_items[].price_data.product_data, InvoiceAddLinesParams.lines[].price_data.product_data, InvoiceLineItemUpdateParams.price_data.product_data, InvoiceUpdateLinesParams.lines[].price_data.product_data, PaymentLinkCreateParams.line_items[].price_data.product_data, PlanCreateParams.product[0], PriceCreateParams.product_data, ProductCreateParams, and ProductUpdateParamspending_invoice_item_interval on Checkout.SessionUpdateParams.subscription_datahosted and ui_mode on FinancialConnections.SessionCreateParams and FinancialConnections.Sessionurl on FinancialConnections.Sessionexpires_after_seconds on Invoice.payment_settings.payment_method_options.pix, InvoiceCreateParams.payment_settings.payment_method_options.pix, InvoiceUpdateParams.payment_settings.payment_method_options.pix, QuotePreviewInvoice.payment_settings.payment_method_options.pix, Subscription.payment_settings.payment_method_options.pix, SubscriptionCreateParams.payment_settings.payment_method_options.pix, and SubscriptionUpdateParams.payment_settings.payment_method_options.pixcurrent_trial on InvoiceCreatePreviewParams.subscription_details.items[], SubscriptionCreateParams.items[], SubscriptionItemCreateParams, SubscriptionItemUpdateParams, SubscriptionItem, and SubscriptionUpdateParams.items[]surcharge on PaymentIntent.amount_details, PaymentIntentCaptureParams.amount_details, PaymentIntentConfirmParams.amount_details, PaymentIntentCreateParams.amount_details, PaymentIntentIncrementAuthorizationParams.amount_details, and PaymentIntentUpdateParams.amount_detailsamount_details and payment_details on PaymentIntentDecrementAuthorizationParamsmandate_options on PaymentIntent.payment_method_options.stripe_balancemanaged_payments on PaymentLinkCreateParams and PaymentLinkstripe_balance on SetupIntent.payment_method_options, SetupIntentConfirmParams.payment_method_options, SetupIntentCreateParams.payment_method_options, and SetupIntentUpdateParams.payment_method_optionsbilling_cycle_anchor on Subscription.trial_settings.end_behavior, SubscriptionCreateParams.trial_settings.end_behavior, and SubscriptionUpdateParams.trial_settings.end_behavioradmissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, luxury_tax, resort_tax, and tourism_tax on enums Tax.Registration.country_options.us.type and Tax.RegistrationCreateParams.country_options.us.typeadmissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, luxury_tax, resort_tax, and tourism_tax on Tax.Registration.country_options.usrequirements on TaxCodeV2.Billing.Cadence.settings_data.collection.payment_method_options.card.mandate_options.amount, V2.Billing.CollectionSetting.payment_method_options.card.mandate_options.amount, V2.Billing.CollectionSettingCreateParams.payment_method_options.card.mandate_options.amount, V2.Billing.CollectionSettingUpdateParams.payment_method_options.card.mandate_options.amount, and V2.Billing.CollectionSettingVersion.payment_method_options.card.mandate_options.amount from longInteger to int64_stringar_bank_account, co_bank_account, and eg_bank_account on enum V2.Core.Account.configuration.recipient.default_outbound_destination.typetimezone on V2.Core.Account.defaults, V2.Core.AccountCreateParams.defaults, and V2.Core.AccountUpdateParams.defaultsazure_event_grid on V2.Core.EventDestinationCreateParams and V2.Core.EventDestinationno_azure_partner_topic_exists on enum V2.Core.EventDestination.status_details.disabled.reasonazure_event_grid on enums V2.Core.EventDestination.type and V2.Core.EventDestinationCreateParams.typesupported_currencies on V2.Core.Vault.GbBankAccount, V2.Core.Vault.UsBankAccount, and V2.MoneyManagement.PayoutMethod.cardV2.Core.Vault.GbBankAccount.sort_code and V2.Core.Vault.GbBankAccountCreateParams.sort_code to be optionalrestricted on V2.MoneyManagement.PayoutMethodcurrencies on V2.MoneyManagement.PayoutMethodsBankAccountSpec.countries.value.fields[]counterparty and description on V2.MoneyManagement.Transactioncurrency on V2.Core.Vault.GbBankAccountCreateParams, V2.Core.Vault.UsBankAccountCreateParams, V2.MoneyManagement.OutboundSetupIntentCreateParams.payout_method_data.bank_account, V2.MoneyManagement.OutboundSetupIntentCreateParams.payout_method_data.card, V2.MoneyManagement.OutboundSetupIntentUpdateParams.payout_method_data.bank_account, and V2.MoneyManagement.OutboundSetupIntentUpdateParams.payout_method_data.cardiban on V2.Core.Vault.GbBankAccountCreateParamsV2.Core.Vault.GbBankAccountCreateParams.account_number to be optionalcurrency on enum InvalidPaymentMethodError.invalid_paramV2CoreBatchJobBatchFailedEvent, V2CoreBatchJobCanceledEvent, V2CoreBatchJobCompletedEvent, V2CoreBatchJobCreatedEvent, V2CoreBatchJobReadyForUploadEvent, V2CoreBatchJobTimeoutEvent, V2CoreBatchJobUpdatedEvent, V2CoreBatchJobUploadTimeoutEvent, V2CoreBatchJobValidatingEvent, and V2CoreBatchJobValidationFailedEvent with related object V2.Core.BatchJobservice_period_coupon_with_metered_tiered_item_unsupported on QuotePreviewInvoice.last_finalization_errorThis release changes the pinned API version to 2026-03-25.dahlia and contains breaking changes (prefixed with ⚠️ below). There's also a detailed migration guide to simplify your upgrade process.
Please review details for the breaking changes and alternatives in the Stripe API changelog before upgrading.
Note: we're releasing another major version very soon that overhauls and improves the package's structure and typescript types. That will also use
2026-03-25.dahliaas an API version and will mostly be a drop-in replacement.
decimal_string fields changed type from string to Stripe.Decimal in both request params and response objects. Code that reads or writes these fields as string will need to use Stripe.Decimal instead (construct via Decimal.from("1.23"), serialize via .toString()). Affected fields across v1 and v2 APIs:
currency_conversion.fx_ratemetric_tons; Climate.Product: metric_tons_availableunit_amount_decimalquantity_decimal, unit_amount_decimalquantity_decimal, unit_amount_decimalquantity_decimal, unit_cost_decimal, gross_amount_decimal, local_amount_decimal, national_amount_decimalamount_decimal, flat_amount_decimal, unit_amount_decimalunit_amount_decimal, flat_amount_decimal (including currency_options and tiers)percent_ownershipunit_amount_decimal, flat_amount_decimal, quantity_decimal (where applicable)simulate_crypto_deposit test helper method on resource PaymentIntentdeposit_options and mode on PaymentIntent.payment_method_options.crypto, PaymentIntentConfirmParams.payment_method_options.crypto, PaymentIntentCreateParams.payment_method_options.crypto, and PaymentIntentUpdateParams.payment_method_options.cryptocrypto_display_details on PaymentIntent.next_actionOrchestration.PaymentAttempt and Radar.CustomerEvaluationretrieve method on resource Orchestration.PaymentAttemptcreate and update methods on resource Radar.CustomerEvaluationapprove method on resource Checkout.Sessionreport_authenticated, report_canceled, report_failed, report_guaranteed, report_informational, and report_refund methods on resource PaymentAttemptRecordcreate_us_paper_check_on_application on AccountSessionCreateParams.components.check_scanning.featuresAccountSignals.delinquency to be optionalapproval_method on Checkout.SessionCreateParams and Checkout.Sessioncurrent_attempt on Checkout.Sessionselected_fulfillment_option_overrides on DelegatedCheckout.RequestedSessionUpdateParams.fulfillment_detailspricing_plan_subscription_details on InvoiceItem.parent and InvoiceLineItem.parentlicense_fee_subscription_details on InvoiceItem.parent and InvoiceLineItem.parentpricing_plan_subscription and pricing_plan_version on InvoiceItem.parent.rate_card_subscription_details and InvoiceLineItem.parent.rate_card_subscription_detailspricing_plan_subscription_details on enum InvoiceItem.parent.typelicense_fee_subscription_details from enum InvoiceItem.parent.typediscounts on enum InvoiceItem.frozen_fieldspricing_plan_subscription_details on enum InvoiceLineItem.parent.typelicense_fee_subscription_details from enum InvoiceLineItem.parent.typetoken_details on Issuing.Authorizationfailure_code on PaymentRecordReportPaymentAttemptFailedParams, PaymentRecordReportPaymentAttemptParams.failed, and PaymentRecordReportPaymentParams.failedPaymentRecordReportPaymentAttemptCanceledParams.canceled_at to be optionalPaymentRecordReportPaymentAttemptFailedParams.failed_at to be optionalPaymentRecordReportPaymentAttemptGuaranteedParams.guaranteed_at to be optionalPaymentRecordReportRefundParams.refunded to be optionalnow from enums QuoteCreateParams.subscription_data.billing_schedules[].bill_from.type, QuoteCreateParams.subscription_data_overrides[].billing_schedules[].bill_from.type, QuoteUpdateParams.subscription_data.billing_schedules[].bill_from.type, and QuoteUpdateParams.subscription_data_overrides[].billing_schedules[].bill_from.typeRadar.IssuingAuthorizationEvaluationCreateParams.card_details.bin_country to be requiredrecurring_interval on SharedPayment.GrantedTokenCreateParams.testHelpers.usage_limitsSharedPayment.GrantedTokenCreateParams.testHelpers.usage_limits.expires_at to be optionalhome_rule_tax on Tax.Registration.country_options.us and Tax.RegistrationCreateParams.country_options.ushome_rule_tax on enums Tax.Registration.country_options.us.type and Tax.RegistrationCreateParams.country_options.us.typeRadar.IssuingAuthorizationEvaluationcreate method on resource Radar.IssuingAuthorizationEvaluationfee_credits on enum BalanceTransaction.balance_typeaffiliate_attributions to affiliate_attribution on DelegatedCheckout.RequestedSessionConfirmParams and DelegatedCheckout.RequestedSessionCreateParamsamount_to_counter on Disputefrozen_fields on InvoiceItemnext_billing_period_start on enums V2.Billing.IntentAction.apply.effective_at.type and V2.Billing.IntentCreateParams.actions[].apply.effective_at.typeconsumer on V2.Core.Account.configuration.card_creator.capabilities, V2.Core.Account.identity.attestations.terms_of_service.card_creator, V2.Core.AccountCreateParams.configuration.card_creator.capabilities, V2.Core.AccountCreateParams.identity.attestations.terms_of_service.card_creator, V2.Core.AccountUpdateParams.configuration.card_creator.capabilities, and V2.Core.AccountUpdateParams.identity.attestations.terms_of_service.card_creatorfifth_third on V2.Core.Account.configuration.card_creator.capabilities.commercial, V2.Core.Account.identity.attestations.terms_of_service.card_creator.commercial, V2.Core.AccountCreateParams.configuration.card_creator.capabilities.commercial, V2.Core.AccountCreateParams.identity.attestations.terms_of_service.card_creator.commercial, V2.Core.AccountUpdateParams.configuration.card_creator.capabilities.commercial, and V2.Core.AccountUpdateParams.identity.attestations.terms_of_service.card_creator.commercialprepaid_card on V2.Core.Account.configuration.card_creator.capabilities.commercial.cross_river_bank, V2.Core.Account.identity.attestations.terms_of_service.card_creator.commercial.cross_river_bank, V2.Core.AccountCreateParams.configuration.card_creator.capabilities.commercial.cross_river_bank, V2.Core.AccountCreateParams.identity.attestations.terms_of_service.card_creator.commercial.cross_river_bank, V2.Core.AccountUpdateParams.configuration.card_creator.capabilities.commercial.cross_river_bank, and V2.Core.AccountUpdateParams.identity.attestations.terms_of_service.card_creator.commercial.cross_river_bankcommercial.cross_river_bank.prepaid_card, commercial.fifth_third.charge_card, consumer.celtic.revolving_credit_card, consumer.cross_river_bank.prepaid_card, and consumer.lead.prepaid_card on enums V2.Core.Account.future_requirements.entries[].impact.restricts_capabilities[].capability and V2.Core.Account.requirements.entries[].impact.restricts_capabilities[].capabilitypayment_method_data on V2.Payments.OffSessionPaymentCreateParamsV2.Payments.OffSessionPaymentCreateParams.payment_method to be optionalcommercial.cross_river_bank.prepaid_card, commercial.fifth_third.charge_card, consumer.celtic.revolving_credit_card, consumer.cross_river_bank.prepaid_card, and consumer.lead.prepaid_card on enum EventsV2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent.updated_capabilityThis release changes the pinned API version to 2026-03-04.preview.
Billing.AlertRecovered and Profilereauthorize method on resource PaymentIntentsmart_disputes on Account.settings, AccountCreateParams.settings, AccountUpdateParams.settings, V2.Core.Account.configuration.merchant, V2.Core.AccountCreateParams.configuration.merchant, and V2.Core.AccountUpdateParams.configuration.merchantemail_customers_on_successful_payment on Account.settings.payments, AccountCreateParams.settings.payments, and AccountUpdateParams.settings.paymentssettings on QuoteLine.actions[].add_discount, QuoteLine.actions[].add_item.discounts[], QuoteLine.actions[].set_discounts[], QuoteLine.actions[].set_items[].discounts[], QuotePreviewSubscriptionSchedule.phases[].discounts[], QuotePreviewSubscriptionSchedule.phases[].items[].discounts[], SubscriptionSchedule.phases[].discounts[], and SubscriptionSchedule.phases[].items[].discounts[]balance_update_details on Billing.CreditBalanceSummary.balances[]reauthorization and reauthorize_before on Charge.payment_method_details.card_present, Charge.payment_method_details.card, ConfirmationToken.payment_method_preview.card.generated_from.payment_method_details.card_present, PaymentAttemptRecord.payment_method_details.card_present, PaymentMethod.card.generated_from.payment_method_details.card_present, and PaymentRecord.payment_method_details.card_presentlocation and reader on Charge.payment_method_details.card_present, Charge.payment_method_details.interac_present, ConfirmationToken.payment_method_preview.card.generated_from.payment_method_details.card_present, PaymentAttemptRecord.payment_method_details.card_present, PaymentAttemptRecord.payment_method_details.interac_present, PaymentMethod.card.generated_from.payment_method_details.card_present, PaymentRecord.payment_method_details.card_present, and PaymentRecord.payment_method_details.interac_presentmanaged_payments on Checkout.SessionCreateParams, Checkout.Session, PaymentIntent, SetupIntent, and Subscriptionlk_vat on enums Checkout.Session.collected_information.tax_ids[].type, Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Order.tax_details.tax_ids[].type, QuotePreviewInvoice.customer_tax_ids[].type, Tax.Calculation.customer_details.tax_ids[].type, Tax.Transaction.customer_details.tax_ids[].type, and TaxId.typelk_vat on enums CustomerCreateParams.tax_id_data[].type, CustomerCreateTaxIdParams.type, InvoiceCreatePreviewParams.customer_details.tax_ids[].type, OrderCreateParams.tax_details.tax_ids[].type, OrderUpdateParams.tax_details.tax_ids[].type, Tax.CalculationCreateParams.customer_details.tax_ids[].type, and TaxIdCreateParams.typedigital on DelegatedCheckout.RequestedSession.fulfillment_details.fulfillment_options[], DelegatedCheckout.RequestedSession.fulfillment_details.selected_fulfillment_option, and DelegatedCheckout.RequestedSessionUpdateParams.fulfillment_details.selected_fulfillment_optionDelegatedCheckout.RequestedSessionUpdateParams.fulfillment_details.selected_fulfillment_option.shipping to be optionalaffiliate_attributions on DelegatedCheckout.RequestedSessionConfirmParams, DelegatedCheckout.RequestedSessionCreateParams, and DelegatedCheckout.RequestedSessionfulfillment_type on DelegatedCheckout.RequestedSession.line_item_details[]marketplace_seller_details, network_profile, privacy_notice_url, return_policy_url, store_policy_url, and terms_of_service_url on DelegatedCheckout.RequestedSession.seller_detailsamount_to_counter on DisputeUpdateParamsreserve.hold.created, reserve.hold.updated, reserve.plan.created, reserve.plan.disabled, reserve.plan.expired, reserve.plan.updated, and reserve.release.created on enum Event.typeterminal_wifi_certificate and terminal_wifi_private_key on enums File.purpose and FileListParams.purposeterminal_wifi_certificate and terminal_wifi_private_key on enum FileCreateParams.purposepay_by_bank on enums Invoice.payment_settings.payment_method_types, InvoiceCreateParams.payment_settings.payment_method_types, InvoiceUpdateParams.payment_settings.payment_method_types, QuotePreviewInvoice.payment_settings.payment_method_types, Subscription.payment_settings.payment_method_types, SubscriptionCreateParams.payment_settings.payment_method_types, and SubscriptionUpdateParams.payment_settings.payment_method_typesdisplay_name and service_user_number on Mandate.payment_method_details.bacs_debitPaymentAttemptRecord.payment_method_details.boleto.tax_id and PaymentRecord.payment_method_details.boleto.tax_id from string to string | nullPaymentAttemptRecord.payment_method_details.us_bank_account.expected_debit_date and PaymentRecord.payment_method_details.us_bank_account.expected_debit_date from string | null to stringrequest_reauthorization on PaymentIntent.payment_method_options.card_present, PaymentIntent.payment_method_options.card, PaymentIntentConfirmParams.payment_method_options.card_present, PaymentIntentConfirmParams.payment_method_options.card, PaymentIntentCreateParams.payment_method_options.card_present, PaymentIntentCreateParams.payment_method_options.card, PaymentIntentUpdateParams.payment_method_options.card_present, and PaymentIntentUpdateParams.payment_method_options.cardtransaction_purpose on PaymentIntent.payment_method_options.us_bank_account, PaymentIntentConfirmParams.payment_method_options.us_bank_account, PaymentIntentCreateParams.payment_method_options.us_bank_account, and PaymentIntentUpdateParams.payment_method_options.us_bank_accountrequires_reauthorization on enum PaymentIntent.statusoptional_items on PaymentLinkUpdateParamsbilling_schedules_invalid on enum Quote.status_details.stale.last_reason.typecard_issuer_decline on Radar.PaymentEvaluation.insightspayment_behavior on SubscriptionItemDeleteParamsbilling_cycle_anchor on Subscription.trial_settings.end_behaviorlk on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_optionscellular and stripe_s710 on Terminal.ConfigurationCreateParams, Terminal.ConfigurationUpdateParams, and Terminal.Configurationsimulated_stripe_s710 and stripe_s710 on enums Terminal.Reader.device_type and Terminal.ReaderListParams.device_typereserve.hold.created, reserve.hold.updated, reserve.plan.created, reserve.plan.disabled, reserve.plan.expired, reserve.plan.updated, and reserve.release.created on enums WebhookEndpointCreateParams.enabled_events and WebhookEndpointUpdateParams.enabled_events2026-02-25.clover on enum WebhookEndpointCreateParams.api_versionar_bank_account, bt_bank_account, co_bank_account, cr_bank_account, do_bank_account, gt_bank_account, md_bank_account, mk_bank_account, mo_bank_account, mz_bank_account, pe_bank_account, pk_bank_account, tw_bank_account, and uz_bank_account on enums V2.Account.configuration.recipient_data.default_outbound_destination.type and V2.Core.Account.configuration.recipient.default_outbound_destination.typerecipient_onboarding and recipient_update on V2.Core.AccountLink.use_case and V2.Core.AccountLinkCreateParams.use_caserecipient_onboarding and recipient_update on enums V2.Core.AccountLink.use_case.type and V2.Core.AccountLinkCreateParams.use_case.typeconsumer on V2.Core.Account.configuration.storer.capabilities, V2.Core.AccountCreateParams.configuration.storer.capabilities, and V2.Core.AccountUpdateParams.configuration.storer.capabilitiesconsumer.holds_currencies.usd on enums V2.Core.Account.future_requirements.entries[].impact.restricts_capabilities[].capability and V2.Core.Account.requirements.entries[].impact.restricts_capabilities[].capabilityfunds_usage_type on V2.MoneyManagement.FinancialAccount.storage and V2.MoneyManagement.FinancialAccountCreateParams.storagepurpose on V2.MoneyManagement.OutboundPaymentCreateParams and V2.MoneyManagement.OutboundPaymentbranch_number and swift_code on V2.MoneyManagement.PayoutMethod.bank_accountdispute, inbound_payment_failure, inbound_payment, india_mdr_processing_fee, payment_method_passthrough_fee, refund, and tax_withholding on enums V2.MoneyManagement.Transaction.category and V2.MoneyManagement.TransactionEntry.transaction_details.categorycharge_failure and charge from enums V2.MoneyManagement.Transaction.category and V2.MoneyManagement.TransactionEntry.transaction_details.categoryV2.MoneyManagement.Transaction.flow and V2.MoneyManagement.TransactionEntry.transaction_details.flow to be optionalconsumer.holds_currencies.usd on enum EventsV2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.updated_capabilityBillingAlertRecoveredEvent with resource Billing.AlertRecoveredReserveHoldCreatedEvent and ReserveHoldUpdatedEvent with resource Reserve.HoldReservePlanCreatedEvent, ReservePlanDisabledEvent, ReservePlanExpiredEvent, and ReservePlanUpdatedEvent with resource Reserve.PlanReserveReleaseCreatedEvent with resource Reserve.ReleaseV2BillingRateCardCustomPricingUnitOverageRateCreatedEvent with related object V2.Billing.RateCardCustomPricingUnitOverageRateV2IamStripeAccessGrantApprovedEvent, V2IamStripeAccessGrantCanceledEvent, V2IamStripeAccessGrantDeniedEvent, V2IamStripeAccessGrantRemovedEvent, V2IamStripeAccessGrantRequestedEvent, and V2IamStripeAccessGrantUpdatedEventstorer_capability_missing and storer_capability_not_active on Invoice.last_finalization_error, PaymentIntent.last_payment_error, QuotePreviewInvoice.last_finalization_error, SetupAttempt.setup_error, SetupIntent.last_setup_error, and StripeErrorThis release changes the pinned API version to 2026-02-25.preview.
AccountSignalsretrieve method on resource AccountSignalsaggregation_period, group_by, and triggered_at on Billing.AlertTriggeredexternal_account_collection on AccountLinkCreateParams.collection_optionsfunding_source on ApplicationFeeDelegatedCheckout.RequestedSessionConfirmParams.payment_method_data.billing_details.address.line1, DelegatedCheckout.RequestedSessionCreateParams.fulfillment_details.address.line1, DelegatedCheckout.RequestedSessionCreateParams.payment_method_data.billing_details.address.line1, DelegatedCheckout.RequestedSessionUpdateParams.fulfillment_details.address.line1, and DelegatedCheckout.RequestedSessionUpdateParams.payment_method_data.billing_details.address.line1 to be optionalhosted and ui_mode on FinancialConnections.SessionCreateParams and FinancialConnections.Sessionurl on FinancialConnections.Sessionbilling_cycle_anchor on SubscriptionCreateParams.trial_settings.end_behavior and SubscriptionUpdateParams.trial_settings.end_behavior