NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #4265 most downloaded on npm
Stripe API wrapper
Last release 2 days ago
01 Oct 2026
Ships on a steady schedule
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
2 versions withdrawn
withdrawn after publishing
15 years old
805 releases · first in 2011
See the changelog for more details.
Add support for new values issuing_token.created and issuing_token.updated on enum Event.type
issuing_token.created and issuing_token.updated on enum Event.typeissuing_token.created and issuing_token.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]One column per quarter.
Add support for new resources AccountNotice and Issuing.CreditUnderwritingRecord
AccountNotice and Issuing.CreditUnderwritingRecordlist, retrieve, and update methods on resource AccountNoticecorrect, create_from_application, create_from_proactive_review, list, report_decision, and retrieve methods on resource CreditUnderwritingRecordCheckout.Session.automatic_tax.liability.account, Checkout.Session.invoice_creation.invoice_data.issuer.account, Invoice.automatic_tax.liability.account, Invoice.issuer.account, Quote.automatic_tax.liability.account, Quote.invoice_settings.issuer.account, Subscription.automatic_tax.liability.account, SubscriptionSchedule.default_settings.automatic_tax.liability.account, SubscriptionSchedule.default_settings.invoice_settings.issuer.account, SubscriptionSchedule.phases[].automatic_tax.liability.account, and SubscriptionSchedule.phases[].invoice_settings.issuer.account from expandable(Account) | null to expandable(Account)Checkout.Session.automatic_tax.liability.account, Checkout.Session.invoice_creation.invoice_data.issuer.account, Invoice.automatic_tax.liability.account, Invoice.issuer.account, Issuing.Transaction.network_data.processing_date, Quote.automatic_tax.liability.account, Quote.invoice_settings.issuer.account, Subscription.automatic_tax.liability.account, SubscriptionSchedule.default_settings.automatic_tax.liability.account, SubscriptionSchedule.default_settings.invoice_settings.issuer.account, SubscriptionSchedule.phases[].automatic_tax.liability.account, and SubscriptionSchedule.phases[].invoice_settings.issuer.account to be optionalaccount_notice.created and account_notice.updated on enum Event.typelocal_amusement_tax and state_communications_tax on enums Tax.Registration.country_options.us.type and Tax.RegistrationCreateParams.country_options.us.typeaccount_notice.created and account_notice.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for redirect_on_completion, return_url, and ui_mode on Checkout.SessionCreateParams and Checkout.Session
redirect_on_completion, return_url, and ui_mode on Checkout.SessionCreateParams and Checkout.SessionCheckout.Session.custom_fields[].dropdown, Checkout.Session.custom_fields[].numeric, Checkout.Session.custom_fields[].text, Checkout.SessionCreateParams.success_url, PaymentLink.custom_fields[].dropdown, PaymentLink.custom_fields[].numeric, and PaymentLink.custom_fields[].text to be optionalclient_secret on Checkout.SessionCheckout.Session.custom_fields[].dropdown from PaymentPagesCheckoutSessionCustomFieldsDropdown | null to PaymentPagesCheckoutSessionCustomFieldsDropdownCheckout.Session.custom_fields[].numeric and Checkout.Session.custom_fields[].text from PaymentPagesCheckoutSessionCustomFieldsNumeric | null to PaymentPagesCheckoutSessionCustomFieldsNumericpostal_code on Issuing.Authorization.verification_dataPaymentLink.custom_fields[].dropdown from PaymentLinksResourceCustomFieldsDropdown | null to PaymentLinksResourceCustomFieldsDropdownPaymentLink.custom_fields[].numeric and PaymentLink.custom_fields[].text from PaymentLinksResourceCustomFieldsNumeric | null to PaymentLinksResourceCustomFieldsNumericoffline on Terminal.ConfigurationCreateParams, Terminal.ConfigurationUpdateParams, and Terminal.ConfigurationAdd support for mark_draft and mark_stale methods on resource Quote
mark_draft and mark_stale methods on resource Quotedraft_quote, mark_stale_quote, and preview_invoice_lines methods on resource Quoteliability on Checkout.Session.automatic_tax and Checkout.SessionCreateParams.automatic_taxissuer on Checkout.Session.invoice_creation.invoice_data and Checkout.SessionCreateParams.invoice_creation.invoice_datainvoice_settings on Checkout.SessionCreateParams.subscription_datapersonalization_design on Issuing.CardListParamsallow_backdated_lines on QuoteCreateParams, QuoteUpdateParams, and QuoteAdd support for new resource Issuing.Token
Issuing.Tokenlist, retrieve, and update methods on resource Tokenamount_authorized, extended_authorization, incremental_authorization, multicapture, and overcapture on Charge.payment_method_details.cardtoken on Issuing.Authorization and Issuing.Transactionauthorization_code on Issuing.Authorization.request_history[]request_extended_authorization, request_multicapture, and request_overcapture on PaymentIntent.payment_method_options.card, PaymentIntentConfirmParams.payment_method_options.card, PaymentIntentCreateParams.payment_method_options.card, and PaymentIntentUpdateParams.payment_method_options.cardrequest_incremental_authorization on 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.cardfinal_capture on PaymentIntentCaptureParamsmetadata on PaymentLink.payment_intent_data, PaymentLink.subscription_data, PaymentLinkCreateParams.payment_intent_data, and PaymentLinkCreateParams.subscription_datastatement_descriptor_suffix and statement_descriptor on PaymentLink.payment_intent_data and PaymentLinkCreateParams.payment_intent_datapayment_intent_data and subscription_data on PaymentLinkUpdateParamsRename resources Issuing.CardDesign and Issuing.CardBundle to Issuing.PersonalizationDesign and Issuing.PhysicalBundle
Issuing.CardDesign and Issuing.CardBundle to Issuing.PersonalizationDesign and Issuing.PhysicalBundlecapital_financing_offer and capital_financing_reporting on enum AccountLinkCreateParams.typefeatures on AccountSession.components.payment_details, AccountSession.components.payments, AccountSession.components.payouts, AccountSessionCreateParams.components.account_onboarding, AccountSessionCreateParams.components.payment_details, AccountSessionCreateParams.components.payments, and AccountSessionCreateParams.components.payoutsConfirmationToken.payment_method_preview.us_bank_account.financial_connections_account and ConfirmationToken.payment_method_preview.us_bank_account.status_details to be requiredreason on EventAdd support for rendering on InvoiceCreateParams, InvoiceUpdateParams, and Invoice
rendering on InvoiceCreateParams, InvoiceUpdateParams, and InvoicePaymentMethod.us_bank_account.financial_connections_account and PaymentMethod.us_bank_account.status_details to be requiredRemove support for customer on ConfirmationToken
customer on ConfirmationTokenissuer on InvoiceCreateParams, InvoiceUpcomingLinesParams, InvoiceUpcomingParams, InvoiceUpdateParams, Invoice, Quote.invoice_settings, QuoteCreateParams.invoice_settings, QuoteUpdateParams.invoice_settings, SubscriptionSchedule.default_settings.invoice_settings, SubscriptionSchedule.phases[].invoice_settings, SubscriptionScheduleCreateParams.default_settings.invoice_settings, SubscriptionScheduleCreateParams.phases[].invoice_settings, SubscriptionScheduleUpdateParams.default_settings.invoice_settings, and SubscriptionScheduleUpdateParams.phases[].invoice_settingson_behalf_of on InvoiceUpcomingLinesParams and InvoiceUpcomingParamsliability on Invoice.automatic_tax, InvoiceCreateParams.automatic_tax, InvoiceUpcomingLinesParams.automatic_tax, InvoiceUpcomingParams.automatic_tax, InvoiceUpdateParams.automatic_tax, Quote.automatic_tax, QuoteCreateParams.automatic_tax, QuoteUpdateParams.automatic_tax, Subscription.automatic_tax, SubscriptionCreateParams.automatic_tax, SubscriptionSchedule.default_settings.automatic_tax, SubscriptionSchedule.phases[].automatic_tax, SubscriptionScheduleCreateParams.default_settings.automatic_tax, SubscriptionScheduleCreateParams.phases[].automatic_tax, SubscriptionScheduleUpdateParams.default_settings.automatic_tax, SubscriptionScheduleUpdateParams.phases[].automatic_tax, and SubscriptionUpdateParams.automatic_taxIssuing.CardDesignUpdateParams.carrier_text from carrier_text_param to emptyStringable(carrier_text_param)invoice_settings on SubscriptionCreateParams and SubscriptionUpdateParamsAdd support for terms_of_service_acceptance on Checkout.Session.custom_text, Checkout.SessionCreateParams.custom_text, PaymentLink.custom_text, Paymen
terms_of_service_acceptance on Checkout.Session.custom_text, Checkout.SessionCreateParams.custom_text, PaymentLink.custom_text, PaymentLinkCreateParams.custom_text, and PaymentLinkUpdateParams.custom_textAdd support for new resource ConfirmationToken
ConfirmationTokenretrieve method on resource ConfirmationTokencreate method on resource Issuing.CardDesignreject_testmode test helper method on resource Issuing.CardDesignissuing_card_design.rejected on enum Event.typefeatures on Issuing.CardBundlepreferences on Issuing.CardDesignListParams, Issuing.CardDesignUpdateParams, and Issuing.CardDesignpreference on Issuing.CardDesignListParams, Issuing.CardDesignUpdateParams, and Issuing.CardDesigncard_bundle on Issuing.CardDesignUpdateParamscard_logo and carrier_text on Issuing.CardDesignUpdateParams and Issuing.CardDesignIssuing.CardDesignUpdateParams.lookup_key and Issuing.CardDesignUpdateParams.name from string to emptyStringable(string)rejection_reasons on Issuing.CardDesignconfirmation_token on PaymentIntentConfirmParams, PaymentIntentCreateParams, SetupIntentConfirmParams, and SetupIntentCreateParamsissuing_card_design.rejected on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for new resource PaymentMethodConfiguration
PaymentMethodConfigurationcreate, list, retrieve, and update methods on resource PaymentMethodConfigurationpayment_method_configuration on Checkout.SessionCreateParams, PaymentIntentCreateParams, PaymentIntentUpdateParams, SetupIntentCreateParams, and SetupIntentUpdateParamspayment_method_configuration_details on Checkout.Session, PaymentIntent, and SetupIntentcapture, create, expire, increment, and reverse test helper methods on resource Issuing.Authorizationcreate_force_capture, create_unlinked_refund, and refund test helper methods on resource Issuing.Transactionstripe_tax_inactive on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.codenonce on EphemeralKeyCreateParamscashback_amount on Issuing.Authorization.amount_details, Issuing.Authorization.pending_request.amount_details, Issuing.Authorization.request_history[].amount_details, and Issuing.Transaction.amount_detailsserial_number on Terminal.ReaderListParamsRemove support for submit_card test helper method on resource Issuing.Card
submit_card test helper method on resource Issuing.Cardtax_forms on Account.settings, AccountCreateParams.settings, and AccountUpdateParams.settingscard_design on Issuing.CardUpdateParamssubmitted from enum Issuing.Card.shipping.statusplatform_default on enums Issuing.CardDesign.preference and Issuing.CardDesignListParams.preferenceAdd support for new resource PaymentMethodDomain
PaymentMethodDomaincreate, list, retrieve, update, and validate methods on resource PaymentMethodDomainn26 on enums Charge.payment_method_details.ideal.bank, PaymentIntentConfirmParams.payment_method_data.ideal.bank, PaymentIntentCreateParams.payment_method_data.ideal.bank, PaymentIntentUpdateParams.payment_method_data.ideal.bank, PaymentMethod.ideal.bank, PaymentMethodCreateParams.ideal.bank, SetupAttempt.payment_method_details.ideal.bank, SetupIntentConfirmParams.payment_method_data.ideal.bank, SetupIntentCreateParams.payment_method_data.ideal.bank, and SetupIntentUpdateParams.payment_method_data.ideal.bankNTSBDEB1 on enums Charge.payment_method_details.ideal.bic, PaymentMethod.ideal.bic, and SetupAttempt.payment_method_details.ideal.bictreasury.credit_reversal.created, treasury.credit_reversal.posted, treasury.debit_reversal.completed, treasury.debit_reversal.created, treasury.debit_reversal.initial_credit_granted, treasury.financial_account.closed, treasury.financial_account.created, treasury.financial_account.features_status_updated, treasury.inbound_transfer.canceled, treasury.inbound_transfer.created, treasury.inbound_transfer.failed, treasury.inbound_transfer.succeeded, treasury.outbound_payment.canceled, treasury.outbound_payment.created, treasury.outbound_payment.expected_arrival_date_updated, treasury.outbound_payment.failed, treasury.outbound_payment.posted, treasury.outbound_payment.returned, treasury.outbound_transfer.canceled, treasury.outbound_transfer.created, treasury.outbound_transfer.expected_arrival_date_updated, treasury.outbound_transfer.failed, treasury.outbound_transfer.posted, treasury.outbound_transfer.returned, treasury.received_credit.created, treasury.received_credit.failed, treasury.received_credit.succeeded, and treasury.received_debit.created on enum Event.typeinvoiceitem.updated from enum Event.typefeatures on ProductCreateParams, ProductUpdateParams, and Productinvoiceitem.updated from enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Rename Quote.listPreviewSubscriptionSchedules to Quote.listPreviewSchedules and `Quote.listPreview
Quote.listPreviewSubscriptionSchedules to Quote.listPreviewSchedules and `Quote.listPreviewAdd support for new resource AccountSession
AccountSessioncreate method on resource AccountSessionobligation_inbound, obligation_outbound, obligation_payout_failure, obligation_payout, obligation_reversal_inbound, and obligation_reversal_outbound on enum BalanceTransaction.typeEvent.type from string to enumapplication on PaymentLinkobligation on enum Reporting.ReportRunCreateParams.parameters.reporting_categoryAdd support for retention on BillingPortal.Session.flow.subscription_cancel and BillingPortal.SessionCreateParams.flow_data.subscription_cancel
retention on BillingPortal.Session.flow.subscription_cancel and BillingPortal.SessionCreateParams.flow_data.subscription_cancelprefetch on Checkout.Session.payment_method_options.us_bank_account.financial_connections, Checkout.SessionCreateParams.payment_method_options.us_bank_account.financial_connections, FinancialConnections.SessionCreateParams, FinancialConnections.Session, Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections, InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections, InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections, PaymentIntent.payment_method_options.us_bank_account.financial_connections, PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections, PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections, PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections, SetupIntent.payment_method_options.us_bank_account.financial_connections, SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections, SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections, SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections, Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections, SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections, and SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connectionspayment_method_details on DisputePaymentIntentCreateParams.mandate_data and SetupIntentCreateParams.mandate_data from secret_key_param to emptyStringable(secret_key_param)PaymentIntentConfirmParams.mandate_data and SetupIntentConfirmParams.mandate_data from secret_key_param | client_key_param to emptyStringable(secret_key_param | client_key_param)balance_transaction on CustomerCashBalanceTransaction.adjusted_for_overdraftmaxNetworkRetries options JSDocAdd support for flat_amount on Tax.TransactionCreateReversalParams
flat_amount on Tax.TransactionCreateReversalParamsSee the changelog for more details.
2023-08-16.More information is available in the stripe-node v13 migration guide " ⚠️" symbol highlights breaking changes.
2023-08-16. Please read the API Changelog and carefully review the API changes before upgrading stripe-node.del method on Subcriptions. Please use the cancel method instead, which was introduced in v9.14.0:verification_directors_mismatch, verification_document_directors_mismatch, verification_extraneous_directors, and verification_missing_directors on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, BankAccount.future_requirements.errors[].code, and BankAccount.requirements.errors[].codecustom_account_update and custom_account_verification from enum AccountLinkCreateParams.type
available_on on BalanceTransactionListParams
.AddExtraParam if sending the parameter is still required.alternate_statement_descriptors and dispute on Charge
destination on Charge
transfer_data or on_behalf_of instead.shipping_rates on Checkout.SessionCreateParams
shipping_options instead.coupon and trial_from_plan on Checkout.SessionCreateParams.subscription_data
// @ts-ignore or any if sending the parameter is still required.card_present from enums CustomerListPaymentMethodsParams.type and PaymentMethodListParams.type
charge_refunded from enum Dispute.status
blik on Mandate.payment_method_details, PaymentMethodUpdateParams, SetupAttempt.payment_method_details, SetupIntent.payment_method_options, SetupIntentConfirmParams.payment_method_options, SetupIntentCreateParams.payment_method_options, and SetupIntentUpdateParams.payment_method_options
acss_debit, affirm, au_becs_debit, bacs_debit, cashapp, sepa_debit, and zip on PaymentMethodUpdateParams
country on PaymentMethod.link
recurring on PriceUpdateParams
attributes, caption, and deactivate_on on ProductCreateParams, ProductUpdateParams, and Product
2023-08-16 on enum WebhookEndpointCreateParams.api_versionAdd support for new resources QuotePreviewInvoice and QuotePreviewSchedule
QuotePreviewInvoice and QuotePreviewScheduleCheckout.Session.payment_method_options.us_bank_account.financial_connections.prefetch, FinancialConnections.Session.prefetch, Invoice.charge, Invoice.customer, Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch, PaymentIntent.payment_method_options.us_bank_account.financial_connections.prefetch, SetupIntent.payment_method_options.us_bank_account.financial_connections.prefetch, and Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch to be requiredapplies_to on Invoice and SubscriptionSchedulecl, co, id, kr, mx, my, sa, th, tr, and vn on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_optionshk on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_optionsThis release changes the pinned API version to 2023-08-16.
QuotePreviewInvoice and QuotePreviewScheduleCheckout.Session.payment_method_options.us_bank_account.financial_connections.prefetch, FinancialConnections.Session.prefetch, Invoice.charge, Invoice.customer, Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch, PaymentIntent.payment_method_options.us_bank_account.financial_connections.prefetch, SetupIntent.payment_method_options.us_bank_account.financial_connections.prefetch, and Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch to be requiredapplies_to on Invoice and SubscriptionSchedulecl, co, id, kr, mx, my, sa, th, tr, and vn on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_optionshk on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_optionsAdd support for paypal on PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, and PaymentMethodConfiguration
paypal on PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, and PaymentMethodConfigurationquote.accept_failed on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for new values incorporated_partnership and unincorporated_partnership on enums Account.company.structure, AccountCreateParams.company.str
incorporated_partnership and unincorporated_partnership on enums Account.company.structure, AccountCreateParams.company.structure, AccountUpdateParams.company.structure, and TokenCreateParams.account.company.structurepayment_reversal on enum BalanceTransaction.typeInvoice.subscription_details.metadata and Invoice.subscription_details to be requiredAdd support for submit_card test helper method on resource Issuing.Card
submit_card test helper method on resource Issuing.Cardaddress_validation on Issuing.Card.shipping and Issuing.CardCreateParams.shippingshipping on Issuing.CardUpdateParamssubmitted on enum Issuing.Card.shipping.statusOrderCreateParams.line_items[].product_data.description, OrderCreateParams.line_items[].product_data.tax_code, OrderCreateParams.shipping_details.phone, OrderUpdateParams.description, OrderUpdateParams.line_items[].product_data.description, OrderUpdateParams.line_items[].product_data.tax_code, OrderUpdateParams.shipping_details.phone, PaymentMethodConfigurationListParams.application, and QuoteUpdateParams.subscription_data_overrides[].description from string to emptyStringable(string)reason on QuoteMarkStaleQuoteParamsmarked_stale on Quote.status_details.stale.last_reasonTax.FormListParams.payee.type to be optionalChange many types from string to emptyStringable(string)
string to emptyStringable(string)subscription_details on Invoicepreferred_settlement_speed 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_accountsepa_debit_fingerprint and us_bank_account_fingerprint on enums Radar.ValueList.item_type and Radar.ValueListCreateParams.item_typeUpdated stable APIs to the latest version
Add support for monthly_estimated_revenue on Account.business_profile, AccountCreateParams.business_profile, and AccountUpdateParams.business_profile
Add support for monthly_estimated_revenue on Account.business_profile, AccountCreateParams.business_profile, and AccountUpdateParams.business_profile
Add support for new value ro_tin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Tax.Calculation.customer_
ro_tin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Tax.Calculation.customer_details.tax_ids[].type, and Tax.Transaction.customer_details.tax_ids[].typeexcluded_territory, jurisdiction_unsupported, and vat_exempt from enums Checkout.Session.shipping_cost.taxes[].taxability_reason, Checkout.Session.total_details.breakdown.taxes[].taxability_reason, CreditNote.shipping_cost.taxes[].taxability_reason, Invoice.shipping_cost.taxes[].taxability_reason, LineItem.taxes[].taxability_reason, Quote.computed.recurring.total_details.breakdown.taxes[].taxability_reason, Quote.computed.upfront.total_details.breakdown.taxes[].taxability_reason, and Quote.total_details.breakdown.taxes[].taxability_reasonro_tin on enums CustomerCreateParams.tax_id_data[].type, InvoiceUpcomingLinesParams.customer_details.tax_ids[].type, InvoiceUpcomingParams.customer_details.tax_ids[].type, and Tax.CalculationCreateParams.customer_details.tax_ids[].typeuse_stripe_sdk on SetupIntentConfirmParams and SetupIntentCreateParamsservice_tax on enums TaxRate.tax_type, TaxRateCreateParams.tax_type, and TaxRateUpdateParams.tax_typeCheckoutSessionCreateParams -> Checkout.SessionCreateParamsAdd support for new resource PaymentMethodConfiguration
PaymentMethodConfigurationcreate, list, retrieve, and update methods on resource PaymentMethodConfigurationpayment_method_configuration on PaymentIntentCreateParams and PaymentIntentUpdateParamspayment_method_configuration_details on PaymentIntentTax.SettingRetrieveParam to Tax.SettingsRetrieveParam and Tax.SettingUpdateParams to Tax.SettingsUpdateParams (parity with main release)Add support for new resource Tax.Settings
Tax.Settingsretrieve and update methods on resource Settingsinvalid_tax_location on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.codeorder_id on Charge.payment_method_details.afterpay_clearpayallow_redirects on PaymentIntent.automatic_payment_methods, PaymentIntentCreateParams.automatic_payment_methods, SetupIntent.automatic_payment_methods, and SetupIntentCreateParams.automatic_payment_methodsamusement_tax and communications_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_typeproduct on Tax.TransactionLineItemtax.settings.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for numeric and text on PaymentLink.custom_fields[]
numeric and text on PaymentLink.custom_fields[]automatic_tax on SubscriptionListParamsAdd support for metadata on Invoice.subscription_details
metadata on Invoice.subscription_detailsInvoice.subscription_details.pause_collection to be optionalAdd support for new value application_fees_not_allowed on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAtte
application_fees_not_allowed on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.codead_nrt, ar_cuit, bo_tin, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, pe_ruc, rs_pib, sv_nit, uy_ruc, ve_rif, and vn_tineffective_at on CreditNoteCreateParams, CreditNotePreviewLinesParams, CreditNotePreviewParams, CreditNote, InvoiceCreateParams, InvoiceUpdateParams, and InvoiceAdd support for new resource CustomerSession
CustomerSessioncreate method on resource CustomerSessionTax.Registration.country_options.us.type and TaxRegistrationCreateParams.country_options.us.type from literal('state_sales_tax') to enum('local_lease_tax'|'state_sales_tax')Add support for on_behalf_of on Mandate
on_behalf_of on MandateCheckout.Session.success_url from string to string | nullFileCreateParams.file from string to fileCheckout.Session.success_url from string to string | nullFileCreateParams.file from string to fileon_behalf_of on MandateAdd support for payment_details on ChargeCaptureParams, ChargeUpdateParams, PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreat
payment_details on ChargeCaptureParams, ChargeUpdateParams, PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentUpdateParams, and PaymentIntentstatement_details on PaymentIntent.payment_method_options.card, PaymentIntentConfirmParams.payment_method_options.card, PaymentIntentCreateParams.payment_method_options.card, and PaymentIntentUpdateParams.payment_method_options.cardSee the changelog for more details.
Change Charge.payment_method_details.cashapp.buyer_id, Charge.payment_method_details.cashapp.cashtag, PaymentMethod.cashapp.buyer_id, and PaymentMetho
Charge.payment_method_details.cashapp.buyer_id, Charge.payment_method_details.cashapp.cashtag, PaymentMethod.cashapp.buyer_id, and PaymentMethod.cashapp.cashtag to be requiredtaxability_reason on Tax.Calculation.tax_breakdown[]Add support for subscription_details on Invoice
subscription_details on Invoiceaba and swift on enums Order.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[], OrderCreateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[], and OrderUpdateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]us_bank_transfer on enums Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type, OrderCreateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.type, and OrderUpdateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.typeset_pause_collection on QuoteCreateParams.lines[], QuoteLine, QuoteUpdateParams.lines[], and SubscriptionScheduleAmendParams.amendments[]pause_collection_start on enums Quote.subscription_data.bill_on_acceptance.bill_from.type, Quote.subscription_data_overrides[].bill_on_acceptance.bill_from.type, QuoteCreateParams.subscription_data.bill_on_acceptance.bill_from.type, QuoteCreateParams.subscription_data_overrides[].bill_on_acceptance.bill_from.type, QuoteUpdateParams.subscription_data.bill_on_acceptance.bill_from.type, and QuoteUpdateParams.subscription_data_overrides[].bill_on_acceptance.bill_from.typepause_collection on SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.phases[], and SubscriptionScheduleUpdateParams.phases[]local_amusement_tax on Tax.Registration.country_options.us and TaxRegistrationCreateParams.country_options.uslocations on Tax.Settings and TaxSettingUpdateParamscustomer.subscription.collection_paused and customer.subscription.collection_resumed on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for numeric and text on CheckoutSessionCreateParams.custom_fields[], PaymentLinkCreateParams.custom_fields[], and PaymentLinkUpdateParams.
numeric and text on CheckoutSessionCreateParams.custom_fields[], PaymentLinkCreateParams.custom_fields[], and PaymentLinkUpdateParams.custom_fields[]aba and swift on enums Checkout.Session.payment_method_options.customer_balance.bank_transfer.requested_address_types[], CheckoutSessionCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], and PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]us_bank_transfer on enums Checkout.Session.payment_method_options.customer_balance.bank_transfer.type, CheckoutSessionCreateParams.payment_method_options.customer_balance.bank_transfer.type, CustomerCreateFundingInstructionsParams.bank_transfer.type, PaymentIntent.next_action.display_bank_transfer_instructions.type, PaymentIntent.payment_method_options.customer_balance.bank_transfer.type, PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.type, PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.type, and PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.typemaximum_length and minimum_length on Checkout.Session.custom_fields[].numeric and Checkout.Session.custom_fields[].textpreferred_locales on Issuing.Cardholder, IssuingCardholderCreateParams, and IssuingCardholderUpdateParamsdescription, iin, and issuer on PaymentMethod.card_present and PaymentMethod.interac_presentpayer_email on PaymentMethod.paypalnumeric and text on Checkout.SessionCreateParams.custom_fields[], PaymentLinkCreateParams.custom_fields[], and PaymentLinkUpdateParams.custom_fields[]aba and swift on enums Checkout.Session.payment_method_options.customer_balance.bank_transfer.requested_address_types[], Checkout.SessionCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], and PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]us_bank_transfer on enums Checkout.Session.payment_method_options.customer_balance.bank_transfer.type, Checkout.SessionCreateParams.payment_method_options.customer_balance.bank_transfer.type, CustomerCreateFundingInstructionsParams.bank_transfer.type, PaymentIntent.next_action.display_bank_transfer_instructions.type, PaymentIntent.payment_method_options.customer_balance.bank_transfer.type, PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.type, PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.type, and PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.typemaximum_length and minimum_length on Checkout.Session.custom_fields[].numeric and Checkout.Session.custom_fields[].textpreferred_locales on Issuing.Cardholder, Issuing.CardholderCreateParams, and Issuing.CardholderUpdateParamsdescription, iin, and issuer on PaymentMethod.card_present and PaymentMethod.interac_presentpayer_email on PaymentMethod.paypalSee the changelog for more details.
Add support for zip_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilities
zip_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiesInvoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.code from string to enumzip on Charge.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, PaymentMethodCreateParams, PaymentMethodUpdateParams, PaymentMethod, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_datazip on enums CheckoutSessionCreateParams.payment_method_types[] and PaymentMethodCreateParams.typezip on enums CustomerListPaymentMethodsParams.type and PaymentMethodListParams.typezip on enums 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.typezip on enum PaymentMethod.typeAdd support for subscribe and unsubscribe methods on resource FinancialConnections.Account
subscribe and unsubscribe methods on resource FinancialConnections.Accountnext_refresh_available_at on FinancialConnections.Account.balance_refresh, FinancialConnections.Account.inferred_balances_refresh, FinancialConnections.Account.ownership_refresh, and FinancialConnections.Account.transaction_refreshstatus_details and status on Tax.Settingstax.settings.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for subscription_update_confirm and subscription_update on BillingPortal.Session.flow and BillingPortalSessionCreateParams.flow_data
subscription_update_confirm and subscription_update on BillingPortal.Session.flow and BillingPortalSessionCreateParams.flow_datasubscription_update_confirm and subscription_update on enums BillingPortal.Session.flow.type and BillingPortalSessionCreateParams.flow_data.typelink on Charge.payment_method_details.card.wallet and PaymentMethod.card.walletbuyer_id and cashtag on Charge.payment_method_details.cashapp and PaymentMethod.cashappamusement_tax and communications_tax on enums TaxRate.tax_type, TaxRateCreateParams.tax_type, and TaxRateUpdateParams.tax_typeAdd support for payer_email, payer_name, and seller_protection on Charge.payment_method_details.paypal
payer_email, payer_name, and seller_protection on Charge.payment_method_details.paypalCharge.payment_method_details.paypal.payer_id, Charge.payment_method_details.paypal.verified_email, Charge.payment_method_details.paypal.verified_name, SetupIntent.payment_method_options.paypal.currency, and Tax.Settings.locations to be optionalcapture_method, preferred_locale, reference_id, and setup_future_usage on CheckoutSessionCreateParams.payment_method_options.paypalreference on CheckoutSessionCreateParams.payment_method_options.paypal, Order.payment.settings.payment_method_options.paypal, OrderCreateParams.payment.settings.payment_method_options.paypal, OrderUpdateParams.payment.settings.payment_method_options.paypal, PaymentIntent.payment_method_options.paypal, PaymentIntentConfirmParams.payment_method_options.paypal, PaymentIntentCreateParams.payment_method_options.paypal, and PaymentIntentUpdateParams.payment_method_options.paypalrisk_correlation_id on CheckoutSessionCreateParams.payment_method_options.paypal, OrderCreateParams.payment.settings.payment_method_options.paypal, OrderUpdateParams.payment.settings.payment_method_options.paypal, PaymentIntentConfirmParams.payment_method_options.paypal, PaymentIntentCreateParams.payment_method_options.paypal, and PaymentIntentUpdateParams.payment_method_options.paypalbilling_agreement_id and currency on CheckoutSessionCreateParams.payment_method_options.paypalfingerprint, payer_id, and verified_email on Mandate.payment_method_details.paypal and PaymentMethod.paypaltaxability_reason and taxable_amount on Order.shipping_cost.taxes[], Order.total_details.breakdown.taxes[], and QuotePhase.total_details.breakdown.taxes[]head_office on Tax.Settings and TaxSettingUpdateParamsAdd support for paypal on Charge.payment_method_details, CheckoutSessionCreateParams.payment_method_options, Mandate.payment_method_details, PaymentIn
paypal on Charge.payment_method_details, CheckoutSessionCreateParams.payment_method_options, Mandate.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, PaymentMethodCreateParams, PaymentMethod, 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_optionsnetwork_token on Charge.payment_method_details.cardpaypal on enums CheckoutSessionCreateParams.payment_method_types[] and PaymentMethodCreateParams.typetaxability_reason and taxable_amount on Checkout.Session.shipping_cost.taxes[], Checkout.Session.total_details.breakdown.taxes[], CreditNote.shipping_cost.taxes[], CreditNote.tax_amounts[], Invoice.shipping_cost.taxes[], Invoice.total_tax_amounts[], LineItem.taxes[], Quote.computed.recurring.total_details.breakdown.taxes[], Quote.computed.upfront.total_details.breakdown.taxes[], and Quote.total_details.breakdown.taxes[]paypal on enums CustomerListPaymentMethodsParams.type and PaymentMethodListParams.typepaypal on enums Invoice.payment_settings.payment_method_types[], InvoiceCreateParams.payment_settings.payment_method_types[], InvoiceUpdateParams.payment_settings.payment_method_types[], Subscription.payment_settings.payment_method_types[], SubscriptionCreateParams.payment_settings.payment_method_types[], and SubscriptionUpdateParams.payment_settings.payment_method_types[]paypal on enums 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.typeeftpos_au on enums PaymentIntent.payment_method_options.card.network, PaymentIntentConfirmParams.payment_method_options.card.network, PaymentIntentCreateParams.payment_method_options.card.network, PaymentIntentUpdateParams.payment_method_options.card.network, SetupIntent.payment_method_options.card.network, SetupIntentConfirmParams.payment_method_options.card.network, SetupIntentCreateParams.payment_method_options.card.network, SetupIntentUpdateParams.payment_method_options.card.network, Subscription.payment_settings.payment_method_options.card.network, SubscriptionCreateParams.payment_settings.payment_method_options.card.network, and SubscriptionUpdateParams.payment_settings.payment_method_options.card.networkpaypal on enums PaymentLink.payment_method_types[], PaymentLinkCreateParams.payment_method_types[], and PaymentLinkUpdateParams.payment_method_types[]brand, cardholder_name, country, exp_month, exp_year, fingerprint, funding, last4, networks, and read_method on PaymentMethod.card_present and PaymentMethod.interac_presentpreferred_locales on PaymentMethod.interac_presentpaypal on enum PaymentMethod.typeeffective_percentage on TaxRategb_bank_transfer and jp_bank_transfer on CustomerCashBalanceTransaction.Funded.BankTransferUpdated stable APIs to the latest version
Add support for link on Checkout.Session.payment_method_options and CheckoutSessionCreateParams.payment_method_options
link on Checkout.Session.payment_method_options and CheckoutSessionCreateParams.payment_method_optionsbrand, country, description, exp_month, exp_year, fingerprint, funding, iin, issuer, last4, network, and wallet on SetupAttempt.payment_method_details.cardlink on Checkout.Session.payment_method_options and Checkout.SessionCreateParams.payment_method_optionsbrand, country, description, exp_month, exp_year, fingerprint, funding, iin, issuer, last4, network, and wallet on SetupAttempt.payment_method_details.cardAdd support for billing_cycle_anchor and proration_behavior on CheckoutSessionCreateParams.subscription_data
billing_cycle_anchor and proration_behavior on CheckoutSessionCreateParams.subscription_dataterminal_id on Issuing.Authorization.merchant_data and Issuing.Transaction.merchant_datametadata on PaymentIntentCaptureParamschecks on SetupAttempt.payment_method_details.cardtax_breakdown on Tax.Calculation.shipping_cost and Tax.Transaction.shipping_costTaxRegistrationCreateParams.active_from, TaxRegistrationUpdateParams.active_from, and TaxRegistrationUpdateParams.expires_at from longInteger to longInteger | literal('now')Add support for billing_cycle_anchor and proration_behavior on CheckoutSessionCreateParams.subscription_data
billing_cycle_anchor and proration_behavior on CheckoutSessionCreateParams.subscription_dataterminal_id on Issuing.Authorization.merchant_data and Issuing.Transaction.merchant_datametadata on PaymentIntentCaptureParamschecks on SetupAttempt.payment_method_details.cardtax_breakdown on Tax.Calculation.shipping_cost and Tax.Transaction.shipping_costAdd support for zip on PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_meth
zip on PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_method_options, and PaymentIntentUpdateParams.payment_method_optionscountry_options on Tax.Registration and TaxRegistrationCreateParamsstate and type on Tax.Registration and TaxRegistrationCreateParamsChange Checkout.Session.currency_conversion to be required
Checkout.Session.currency_conversion to be requiredIdentity.VerificationReport.options and Identity.VerificationReport.type to be optionalIdentity.VerificationSession.options from VerificationSessionOptions to VerificationSessionOptions | nullIdentity.VerificationSession.type from enum('document'|'id_number') to enum('document'|'id_number') | nullAdd support for collect_payment_method and confirm_payment_intent methods on resource Terminal.Reader
collect_payment_method and confirm_payment_intent methods on resource Terminal.Readerpaypal_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiesREVOIE23 on enums Charge.payment_method_details.ideal.bic, PaymentMethod.ideal.bic, and SetupAttempt.payment_method_details.ideal.biccollect_payment_method and confirm_payment_intent on Terminal.Reader.actionstripe_account on Terminal.Reader.action.process_payment_intent and Terminal.Reader.action.refund_paymentcollect_payment_method and confirm_payment_intent on enum Terminal.Reader.action.typeterminal.reader.action_updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]See the changelog for more details.
No product changes.
Add support for new value REVOIE23 on enums Charge.payment_method_details.ideal.bic, PaymentMethod.ideal.bic, and SetupAttempt.payment_method_details.
Add support for treasury_transaction on CapitalFinancingTransactionListParams
treasury_transaction on CapitalFinancingTransactionListParamstransaction on Capital.FinancingTransaction.detailslink on enums Charge.payment_method_details.card.wallet.type and PaymentMethod.card.wallet.typeIssuingCardholderCreateParams.type to be optionalcountry on PaymentMethod.linkstatus_details on PaymentMethod.us_bank_account⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️
#1743 Pin latest API version as the default
⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️
In this release, Stripe API Version 2022-11-15 (the latest at time of release) will be sent by default on all requests.
The previous default was to use your Stripe account's default API version.
To successfully upgrade to stripe-node v12, you must either
(Recommended) Upgrade your integration to be compatible with API Version 2022-11-15.
Please read the API Changelog carefully for each API Version from 2022-11-15 back to your Stripe account's default API version. Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe Test Mode before deploying them to production.
You can read the v12 migration guide for more detailed instructions.
(Alternative option) Specify a version other than 2022-11-15 when initializing stripe-node.
If you were previously initializing stripe-node without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your Stripe account's default API version. For example:
- const stripe = require('stripe')('sk_test_...');
+ const stripe = require('stripe')('sk_test_...', {
+ apiVersion: 'YYYY-MM-DD' // Determine your default version from https://dashboard.stripe.com/developers
+ })
If you were already initializing stripe-node with an explicit API Version, upgrading to v12 will not affect your integration.
Read the v12 migration guide for more details.
Going forward, each major release of this library will be pinned by default to the latest Stripe API Version at the time of release. That is, instead of upgrading stripe-node and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-node, you should also upgrade your integration to be compatible with the latest Stripe API version.
#1743 Remove Stripe.default and Stripe.Stripe
This was added to maintain backwards compatibility during the transition of stripe-node to a dual ES module / CommonJS package, and should not be functionally necessary.
Add support for new value link on enums Charge.payment_method_details.card.wallet.type and PaymentMethod.card.wallet.type
link on enums Charge.payment_method_details.card.wallet.type and PaymentMethod.card.wallet.typeIssuing.CardholderCreateParams.type to be optionalcountry on PaymentMethod.linkstatus_details on PaymentMethod.us_bank_accountAdd support for new value ioss on enums Tax.Registration.type and TaxRegistrationCreateParams.type
ioss on enums Tax.Registration.type and TaxRegistrationCreateParams.typeTerminalReaderCollectInputsParams.inputs[].custom_text.description to be optionalYour coding agent can read these notes before it upgrades. Set up the MCP server →