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 4 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
This is not a breaking change, as this method was deprecated before the Tax Transactions API was released in favor of the createFromCalculation method…
create method on resource Tax.Transaction
createFromCalculation method.export_license_id and export_purpose_code on Account.company, AccountCreateParams.company, AccountUpdateParams.company, and TokenCreateParams.account.companydeleted from enum Invoice.status
deleted was never returned or accepted as input.amount_tip on Terminal.ReaderPresentPaymentMethodParams.testHelpersOne column per quarter.
Add support for new resources Tax.CalculationLineItem and Tax.TransactionLineItem
Tax.CalculationLineItem and Tax.TransactionLineItemcollect_inputs method on resource Terminal.Readerfinancing_offer on Capital.FinancingSummarylink on enum CheckoutSessionCreateParams.payment_method_types[]fx_rate on Checkout.Session.currency_conversionlink on enums PaymentLink.payment_method_types[], PaymentLinkCreateParams.payment_method_types[], and PaymentLinkUpdateParams.payment_method_types[]automatic_payment_methods on SetupIntentCreateParams and SetupIntentpreview on TaxCalculationCreateParamsTax.Calculation.line_items[] from LineItem to Tax.CalculationLineItemTax.Transaction.line_items[] from LineItem to Tax.TransactionLineItemcollect_inputs on Terminal.Reader.actioncollect_inputs on enum Terminal.Reader.action.typeAdd support for new resources Tax.CalculationLineItem, Tax.Calculation, Tax.TransactionLineItem, and Tax.Transaction
Tax.CalculationLineItem, Tax.Calculation, Tax.TransactionLineItem, and Tax.Transactioncreate and list_line_items methods on resource Calculationcreate_from_calculation, create_reversal, create, list_line_items, and retrieve methods on resource Transactionlink on enum Checkout.SessionCreateParams.payment_method_types[]currency_conversion on Checkout.Sessionlink on enums PaymentLink.payment_method_types[], PaymentLinkCreateParams.payment_method_types[], and PaymentLinkUpdateParams.payment_method_types[]automatic_payment_methods on SetupIntentCreateParams and SetupIntentAdd support for create_from_calculation method on resource Tax.Transaction
create_from_calculation method on resource Tax.TransactionInvoice.applies_to from QuotesResourceQuoteLinesAppliesTo | null to QuotesResourceQuoteLinesAppliesTopaypal on Mandate.payment_method_details, SetupAttempt.payment_method_details, SetupIntent.payment_method_options, SetupIntentConfirmParams.payment_method_options, SetupIntentCreateParams.payment_method_options, and SetupIntentUpdateParams.payment_method_optionsautomatic_async on enums Order.payment.settings.payment_method_options.afterpay_clearpay.capture_method, Order.payment.settings.payment_method_options.card.capture_method, OrderCreateParams.payment.settings.payment_method_options.afterpay_clearpay.capture_method, OrderCreateParams.payment.settings.payment_method_options.card.capture_method, OrderUpdateParams.payment.settings.payment_method_options.afterpay_clearpay.capture_method, and OrderUpdateParams.payment.settings.payment_method_options.card.capture_methodsetup_future_usage on 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.paypalPaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.hosted_instructions_url, PaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.mobile_auth_url, PaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.expires_at, PaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_png, PaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_svg, PaymentIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code, SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.hosted_instructions_url, SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.mobile_auth_url, SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.expires_at, SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_png, SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_svg, and SetupIntent.next_action.cashapp_handle_redirect_or_display_qr_code.qr_code to be requiredapplies_to on QuotePreviewInvoiceLinesParamsshipping_cost on Tax.Calculation, Tax.Transaction, TaxCalculationCreateParams, and TaxTransactionCreateReversalParamstax_breakdown on Tax.Calculationtax_summary on Tax.CalculationAdd support for ES modules by defining a separate ESM entry point. This updates stripe-node to be a dual CommonJS / ES module package.
cashapp_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiescashapp on Charge.payment_method_details, Checkout.Session.payment_method_options, Checkout.SessionCreateParams.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, PaymentMethodUpdateParams, PaymentMethod, SetupAttempt.payment_method_details, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_datacashapp on enum Checkout.SessionCreateParams.payment_method_types[]cashapp on enums CustomerListPaymentMethodsParams.type and PaymentMethodListParams.typecashapp 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[]cashapp 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.typepreferred_locale on PaymentIntent.payment_method_options.affirm, PaymentIntentConfirmParams.payment_method_options.affirm, PaymentIntentCreateParams.payment_method_options.affirm, and PaymentIntentUpdateParams.payment_method_options.affirmcashapp_handle_redirect_or_display_qr_code on PaymentIntent.next_action and SetupIntent.next_actioncashapp on enums PaymentLink.payment_method_types[], PaymentLinkCreateParams.payment_method_types[], and PaymentLinkUpdateParams.payment_method_types[]cashapp on enum PaymentMethodCreateParams.typecashapp on enum PaymentMethod.typepayout.reconciliation_completed on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for cashapp_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilities
Add support for new value cashapp as a new type throughout the API.
Add support for future_requirements and requirements on BankAccount
Add support for country on Charge.payment_method_details.link
Add support for new value automatic_async on enums Checkout.SessionCreateParams.payment_intent_data.capture_method, PaymentIntent.capture_method, PaymentIntentConfirmParams.capture_method, PaymentIntentCreateParams.capture_method, PaymentIntentUpdateParams.capture_method, PaymentLink.payment_intent_data.capture_method, and PaymentLinkCreateParams.payment_intent_data.capture_method
Add support for preferred_locale on PaymentIntent.payment_method_options.affirm,
Add support for cashapp_handle_redirect_or_display_qr_code on PaymentIntent.next_action and SetupIntent.next_action
Add support for new value payout.reconciliation_completed on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]
Updated stable APIs to the latest version
list_transactions method on resource Tax.Transactionamendment_start and timestamp on SubscriptionScheduleAmendParams.prebilling[].bill_fromSubscriptionScheduleAmendParams.prebilling[].bill_from.type from literal('now') to enum('amendment_start'|'now'|'timestamp')SubscriptionSchedule.applies_to from QuotesResourceQuoteLinesAppliesTo | null to QuotesResourceQuoteLinesAppliesTolease_tax on enum Tax.Calculation.tax_summary[].tax_rate_details.tax_typetax_behavior on Tax.Settings.defaults and TaxSettingUpdateParams.defaultsAdd support for card_issuing on Issuing.CardholderCreateParams.individual and Issuing.CardholderUpdateParams.individual
card_issuing on Issuing.CardholderCreateParams.individual and Issuing.CardholderUpdateParams.individualrequirements.past_due on enum Issuing.Cardholder.requirements.disabled_reasonindividual.card_issuing.user_terms_acceptance.date and individual.card_issuing.user_terms_acceptance.ip on enum Issuing.Cardholder.requirements.past_due[]cancellation_details on SubscriptionCancelParams, SubscriptionUpdateParams, and SubscriptionUpdated stable APIs to the latest version
update_behavior on Subscription.prebilling, SubscriptionCreateParams.prebilling, SubscriptionSchedule.prebilling, SubscriptionScheduleCreateParams.prebilling, SubscriptionScheduleUpdateParams.prebilling, and SubscriptionUpdateParams.prebillingprebilling on SubscriptionScheduleAmendParamstaxability_override on Tax.Calculation.customer_details, Tax.Transaction.customer_details, and TaxCalculationCreateParams.customer_detailstax_summary on Tax.Calculationtax_breakdown on Tax.CalculationUpdated stable APIs to the latest version
Issuing.CardBundle and Issuing.CardDesignlist and retrieve methods on resource CardBundlelist, retrieve, and update methods on resource CardDesigncontroller on AccountUpdateParamscard_design on Issuing.Card and IssuingCardCreateParamsissuing_card_design.activated, issuing_card_design.deactivated, and issuing_card_design.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for new values electric_vehicle_charging, emergency_services_gcas_visa_use_only, government_licensed_horse_dog_racing_us_region_only, gove
electric_vehicle_charging, emergency_services_gcas_visa_use_only, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, and marketplaces on spending control categories.reconciliation_status on Payoutlease_tax on enums TaxRate.tax_type, TaxRateCreateParams.tax_type, and TaxRateUpdateParams.tax_typeUpdated stable APIs to the latest version
manual_entry on Checkout.Session.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, and SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connectionsigst on enum Tax.Calculation.tax_breakdown[].tax_rate_details.tax_typeTaxTransactionCreateParams.reference to be requiredcapital.financing_offer.accepted, capital.financing_offer.canceled, capital.financing_offer.created, capital.financing_offer.expired, capital.financing_offer.fully_repaid, capital.financing_offer.paid_out, capital.financing_offer.rejected, and capital.financing_offer.replacement_created on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Add support for new value yoursafe on enums Charge.payment_method_details.ideal.bank, PaymentIntentConfirmParams.payment_method_data.ideal.bank, Payme
yoursafe 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.bankBITSNL2A on enums Charge.payment_method_details.ideal.bic, PaymentMethod.ideal.bic, and SetupAttempt.payment_method_details.ideal.bicigst on enums TaxRate.tax_type, TaxRateCreateParams.tax_type, and TaxRateUpdateParams.tax_typeUpdated stable APIs to the latest version
Quote.status_details.canceled from QuotesResourceStatusDetailsCanceledStatusDetails | null to QuotesResourceStatusDetailsCanceledStatusDetailsQuote.status_details.stale from QuotesResourceStatusDetailsStaleStatusDetails | null to QuotesResourceStatusDetailsStaleStatusDetailsQuote.status_details.canceled and Quote.status_details.stale to be optionalreference on Tax.Calculation and TaxCalculationCreateParamsreference on TaxTransactionCreateParamsAdd support for refund_payment method on resource Terminal.Reader
refund_payment method on resource Terminal.Readername on enums BillingPortal.Configuration.features.customer_update.allowed_updates[], BillingPortal.ConfigurationCreateParams.features.customer_update.allowed_updates[], and BillingPortal.ConfigurationUpdateParams.features.customer_update.allowed_updates[]custom_fields on Checkout.Session, Checkout.SessionCreateParams, PaymentLinkCreateParams, PaymentLinkUpdateParams, and PaymentLinkSubscription.trial_settings.end_behavior and Subscription.trial_settings to be requiredinterac_present on Terminal.ReaderPresentPaymentMethodParams.testHelpersTerminal.ReaderPresentPaymentMethodParams.testHelpers.type from literal('card_present') to enum('card_present'|'interac_present')refund_payment on Terminal.Reader.actionrefund_payment on enum Terminal.Reader.action.typeUpdated stable APIs to the latest version
currency_conversion on Checkout.Sessionlimits on FinancialConnections.Session and FinancialConnectionsSessionCreateParamsenabled on FinancialConnectionsSessionCreateParams.manual_entry* #1679 Enable library to work in worker environments without extra configuration.
Updated stable APIs to the latest version
FinancialConnections.Transactionlist method on resource Transactionprefetch on .payment_method_options.us_bank_account.financial_connections across several APIsCheckoutSessionCreateParams.payment_method_options.paypal.currency, IssuingCardholderCreateParams.individual.first_name, IssuingCardholderCreateParams.individual.last_name, IssuingCardholderUpdateParams.individual.first_name, IssuingCardholderUpdateParams.individual.last_name, and Quote.subscription_data_overrides[].bill_on_acceptance to be optionalinferred_balances and transactions on enum FinancialConnectionsAccountRefreshParams.features[]inferred_balances_refresh, subscriptions, and transaction_refresh on FinancialConnections.Accountmanual_entry on FinancialConnections.Session and FinancialConnectionsSessionCreateParamsstatus_details and status on FinancialConnections.Sessionownership on enums Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.permissions[] and Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.permissions[]account_number on PaymentMethod.us_bank_accountid on QuoteCreateParams.lines[].starts_at.line_ends_atcustomer.subscription.paused, customer.subscription.resumed, financial_connections.account.refreshed_inferred_balances, financial_connections.account.refreshed_ownership, financial_connections.account.refreshed_transactions, and financial_connections.session.updated on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]* #1672 Update main entrypoint on package.json
Add support for resume method on resource Subscription
resume method on resource Subscriptionpayment_link on Checkout.SessionListParamstrial_settings on Checkout.SessionCreateParams.subscription_data, SubscriptionCreateParams, SubscriptionUpdateParams, and Subscriptionshipping_cost on CreditNoteCreateParams, CreditNotePreviewLinesParams, CreditNotePreviewParams, CreditNote, InvoiceCreateParams, InvoiceUpdateParams, and Invoiceamount_shipping on CreditNote and Invoiceshipping_details on InvoiceCreateParams, InvoiceUpdateParams, and Invoicesubscription_resume_at on InvoiceUpcomingLinesParams and InvoiceUpcomingParamsIssuing.CardholderCreateParams.individual.first_name, Issuing.CardholderCreateParams.individual.last_name, Issuing.CardholderUpdateParams.individual.first_name, and Issuing.CardholderUpdateParams.individual.last_name to be optionalIssuing.Cardholder.individual.first_name and Issuing.Cardholder.individual.last_name from string to string | nullinvoice_creation on PaymentLinkCreateParams, PaymentLinkUpdateParams, and PaymentLinkAmerica/Ciudad_Juarez on enum Reporting.ReportRunCreateParams.parameters.timezonepaused on enum SubscriptionListParams.statuspaused on enum Subscription.statuscustomer.subscription.paused and customer.subscription.resumed on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]funding_reversed on enum CustomerCashBalanceTransaction.typeUpdated stable APIs to the latest version
billing_agreement_id on CheckoutSessionCreateParams.payment_method_options.paypallist_transactions method on resource Tax.TransactionQuoteUpdateParams.subscription_data_overrides from array(create_specs) to emptyStringable(array(update_specs))This is technically a breaking change that explicitly defines package entry points and was mistakenly released in a minor version. If your application…
BE on enums Checkout.Session.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.country, Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.country, PaymentIntent.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.country, and Subscription.payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.countrycs-CZ, el-GR, en-CZ, and en-GR on enums PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale, PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale, and PaymentIntentUpdateParams.payment_method_options.klarna.preferred_localeUpdated stable APIs to the latest version
Tax.Settings resource.Add support for verification_session on EphemeralKeyCreateParams
Updated stable APIs to the latest version
Updated stable APIs to the latest version
Add support for new resource Tax.Registration
Add support for create, list, and update methods on resource Registration
Add support for controller on AccountCreateParams and AccountUpdateParams
Add support for application and dashboard on Account.controller
Change type of Quote.subscription_data_overrides[].proration_behavior from enum('always_invoice'|'create_prorations'|'none') to enum('always_invoice'|'create_prorations'|'none') | null
Remove support for timestamp on QuoteLine.actions[].add_discount.discount_end
Change type of QuoteLine.actions[].add_discount.discount_end.type from literal('timestamp') to literal('line_ends_at')
Remove support for index on QuoteLine.actions[].add_item.discounts[], QuoteLine.actions[].remove_discount, QuoteLine.actions[].set_discounts[], QuoteLine.actions[].set_items[].discounts[], SubscriptionSchedule.phases[].add_invoice_items[].discounts[], SubscriptionSchedule.phases[].discounts[], and SubscriptionSchedule.phases[].items[].discounts[]
Change QuoteLine.actions[].add_discount.index to be required
Add support for new values quote.accepting, quote.reestimated, and quote.stale on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]
Change quote.draft_quote implementation from hitting POST /v1/quotes/{quote}/draft to POST /v1/quotes/{quote}/mark_draft
Updated stable APIs to the latest version
mark_stale_quote method on resource Quoteduration and line_ends_at on QuoteCreateParams.subscription_data.bill_on_acceptance.bill_until, QuoteCreateParams.subscription_data_overrides[].bill_on_acceptance.bill_until, QuoteUpdateParams.subscription_data.bill_on_acceptance.bill_until, and QuoteUpdateParams.subscription_data_overrides[].bill_on_acceptance.bill_untilline_starts_at on QuoteCreateParams.subscription_data.bill_on_acceptance.bill_until, QuoteCreateParams.subscription_data_overrides[].bill_on_acceptance.bill_until, QuoteUpdateParams.subscription_data.bill_on_acceptance.bill_until, and QuoteUpdateParams.subscription_data_overrides[].bill_on_acceptance.bill_untilmetadata on Terminal.Reader.action.refund_payment and TerminalReaderRefundPaymentParamsAdd support for card_issuing on Issuing.Cardholder.individual
card_issuing on Issuing.Cardholder.individualAdd support for new value merchant_default on enums CashBalanceUpdateParams.settings.reconciliation_mode, CustomerCreateParams.cash_balance.settings.r
merchant_default on enums CashBalanceUpdateParams.settings.reconciliation_mode, CustomerCreateParams.cash_balance.settings.reconciliation_mode, and CustomerUpdateParams.cash_balance.settings.reconciliation_modeusing_merchant_default on CashBalance.settingsCheckout.SessionCreateParams.cancel_url to be optionalCheckout.Session.cancel_url from string to string | nullUpdated stable APIs to the latest version
QuoteLine, TaxCalculation, and TaxTransactioncreate and list_line_items methods on resource TaxCalculationcreate_reversal, create, and retrieve methods on resource TaxTransactionAdd support for new value invoice_overpaid on enum CustomerBalanceTransaction.type
Change CustomerListPaymentMethodsParams.type and PaymentMethodListParams.type to be optional
CustomerListPaymentMethodsParams.type and PaymentMethodListParams.type to be optionalThis release changes the pinned API version to 2022-11-15.
Add support for flow_data on BillingPortal.SessionCreateParams
flow_data on BillingPortal.SessionCreateParamsflow on BillingPortal.Sessionindia_international_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiesinvoice_creation on Checkout.Session and Checkout.SessionCreateParamsinvoice on Checkout.Sessionmetadata on SubscriptionSchedule.phases[].items[], SubscriptionScheduleCreateParams.phases[].items[], and SubscriptionScheduleUpdateParams.phases[].items[]flow_data on BillingPortal.SessionCreateParamsflow on BillingPortal.Sessionindia_international_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilitiesinvoice_creation on Checkout.Session and Checkout.SessionCreateParamsinvoice on Checkout.Sessionmetadata on SubscriptionSchedule.phases[].items[], SubscriptionScheduleCreateParams.phases[].items[], and SubscriptionScheduleUpdateParams.phases[].items[]Add support for hosted_instructions_url on PaymentIntent.next_action.wechat_pay_display_qr_code
hosted_instructions_url on PaymentIntent.next_action.wechat_pay_display_qr_codecustom_text on Checkout.Session, Checkout.SessionCreateParams, PaymentLinkCreateParams, PaymentLinkUpdateParams, and PaymentLinkhosted_instructions_url on PaymentIntent.next_action.paynow_display_qr_codeThis release includes breaking changes resulting from moving to use the new API version "2022-11-15". To learn more about these changes to Stripe prod…
This release changes the pinned API version to 2022-11-15.
This release includes breaking changes resulting from moving to use the new API version "2022-11-15". To learn more about these changes to Stripe products, see https://docs.stripe.com/changelog/2022-11-15
"⚠️" symbol highlights breaking changes.
tos_shown_and_accepted on Checkout.SessionCreateParams.payment_method_options.paynow. The property was mistakenly released and never worked.StripeSignatureVerificationError to have header and payload fields instead of detail. To access these properties, use err.header and err.payload instead of err.detail.header and err.detail.payload.⚠️ #1580 Remove deprecated Checkout.SessionCreateParams.subscription_data.items.
⚠️ #1580 Remove Orders resource.
⚠️ #1583 Remove SKU resource
⚠️ #1597 Remove deprecated configuration setter methods (setHost, setProtocol, setPort, setApiVersion, setApiKey, setTimeout, setAppInfo, setHttpAgent, setMaxNetworkRetries, and setTelemetryEnabled).
Use the config object to set these options instead, for example:
const stripe = Stripe('sk_test_...', {
apiVersion: '2019-08-08',
maxNetworkRetries: 1,
httpAgent: new ProxyAgent(process.env.http_proxy),
timeout: 1000,
host: 'api.example.com',
port: 123,
telemetry: true,
});
⚠️ #1600 Remove deprecated basic method definitions.
Use basic methods defined on the resource instead.
// Before
basicMethods: true
// After
create: stripeMethod({
method: 'POST',
fullPath: '/v1/resource',
}),
list: stripeMethod({
method: 'GET',
methodType: 'list',
fullPath: '/v1/resource',
}),
retrieve: stripeMethod({
method: 'GET',
fullPath: '/v1/resource/{id}',
}),
update: stripeMethod({
method: 'POST',
fullPath: '/v1/resource/{id}',
}),
// Avoid 'delete' keyword in JS
del: stripeMethod({
method: 'DELETE',
fullPath: '/v1/resource/{id}',
}),
⚠️ #1600 Remove deprecated option names. Use the following option names instead (OLD->NEW): api_key->apiKey, idempotency_key->idempotencyKey, stripe_account->stripeAccount, stripe_version->apiVersion, stripeVersion->apiVersion.
⚠️ Remove charges field on PaymentIntent and replace it with latest_charge. (#1614 )
⚠️ Remove deprecated amount field on Checkout.Session.LineItem. (#1614 )
⚠️ Remove support for tos_shown_and_accepted on Checkout.Session.PaymentMethodOptions.Paynow. (#1614 )
This release includes breaking changes resulting from moving to use the new API version "2022-11-15". To learn more about these changes to Stripe products, see https://docs.stripe.com/changelog/2022-11-15
"⚠️" symbol highlights breaking changes.
tos_shown_and_accepted on Checkout.SessionCreateParams.payment_method_options.paynow. The property was mistakenly released and never worked.StripeSignatureVerificationError to have header and payload fields instead of detail. To access these properties, use err.header and err.payload instead of err.detail.header and err.detail.payload. (#1574)Remove Orders resource. (#1580)
Remove SKU resource (#1583)
Remove deprecated Checkout.SessionCreateParams.subscription_data.items. (#1580)
Remove deprecated configuration setter methods (setHost, setProtocol, setPort, setApiVersion, setApiKey, setTimeout, setAppInfo, setHttpAgent, setMaxNetworkRetries, and setTelemetryEnabled). (#1597)
Use the config object to set these options instead, for example:
const stripe = Stripe('sk_test_...', {
apiVersion: '2019-08-08',
maxNetworkRetries: 1,
httpAgent: new ProxyAgent(process.env.http_proxy),
timeout: 1000,
host: 'api.example.com',
port: 123,
telemetry: true,
});
Remove deprecated basic method definitions. (#1600) Use basic methods defined on the resource instead.
// Before
basicMethods: true
// After
create: stripeMethod({
method: 'POST',
fullPath: '/v1/resource',
}),
list: stripeMethod({
method: 'GET',
methodType: 'list',
fullPath: '/v1/resource',
}),
retrieve: stripeMethod({
method: 'GET',
fullPath: '/v1/resource/{id}',
}),
update: stripeMethod({
method: 'POST',
fullPath: '/v1/resource/{id}',
}),
// Avoid 'delete' keyword in JS
del: stripeMethod({
method: 'DELETE',
fullPath: '/v1/resource/{id}',
}),
Remove deprecated option names. Use the following option names instead (OLD->NEW): api_key->apiKey, idempotency_key->idempotencyKey, stripe_account->stripeAccount, stripe_version->apiVersion, stripeVersion->apiVersion. (#1600)
Remove charges field on PaymentIntent and replace it with latest_charge. (#1614 )
Remove deprecated amount field on Checkout.Session.LineItem. (#1614 )
Remove support for tos_shown_and_accepted on Checkout.Session.PaymentMethodOptions.Paynow. (#1614 )
Updated stable APIs to the latest version
discount_end to Discount.url to MerchantData.Add support for new values eg_tin, ph_tin, and tr_tin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Orde
eg_tin, ph_tin, and tr_tin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Order.tax_details.tax_ids[].type, and TaxId.typeeg_tin, ph_tin, and tr_tin on enums CustomerCreateParams.tax_id_data[].type, InvoiceUpcomingLinesParams.customer_details.tax_ids[].type, InvoiceUpcomingParams.customer_details.tax_ids[].type, OrderCreateParams.tax_details.tax_ids[].type, OrderUpdateParams.tax_details.tax_ids[].type, and TaxIdCreateParams.typereason_message on Issuing.Authorization.request_history[]webhook_error on enum Issuing.Authorization.request_history[].reasonAdd support for on_behalf_of on Checkout.SessionCreateParams.subscription_data, SubscriptionCreateParams, SubscriptionSchedule.default_settings, Subsc
on_behalf_of on Checkout.SessionCreateParams.subscription_data, SubscriptionCreateParams, SubscriptionSchedule.default_settings, SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.default_settings, SubscriptionScheduleCreateParams.phases[], SubscriptionScheduleUpdateParams.default_settings, SubscriptionScheduleUpdateParams.phases[], SubscriptionUpdateParams, and Subscriptiontax_behavior and tax_code on InvoiceItemCreateParams, InvoiceItemUpdateParams, InvoiceUpcomingLinesParams.invoice_items[], and InvoiceUpcomingParams.invoice_items[]Updated beta APIs to the latest stable version
cashappPayments and zipPayments on Account.cashapp and zip on Charge, PaymentMethod.trialSettings on SubscriptionSchedule.Updated stable APIs to the latest version
revoked on enum CapitalFinancingOfferListParams.statuspaypal on Charge.payment_method_details and Sourcenetwork_data on Issuing.Transactionpaypal on enum Source.typebilling_cycle_anchor on SubscriptionScheduleAmendParams.amendments[]Add support for new values jp_trn and ke_pin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Order.tax_det
jp_trn and ke_pin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Order.tax_details.tax_ids[].type, and TaxId.typejp_trn and ke_pin on enums CustomerCreateParams.tax_id_data[].type, InvoiceUpcomingLinesParams.customer_details.tax_ids[].type, InvoiceUpcomingParams.customer_details.tax_ids[].type, OrderCreateParams.tax_details.tax_ids[].type, OrderUpdateParams.tax_details.tax_ids[].type, and TaxIdCreateParams.typetipping on Terminal.Reader.action.process_payment_intent.process_config and Terminal.ReaderProcessPaymentIntentParams.process_configAdd support for new value upcoming_invoice on enum SubscriptionScheduleAmendParams.amendments[].amendment_end.type
upcoming_invoice on enum SubscriptionScheduleAmendParams.amendments[].amendment_end.typeschedule_end and upcoming_invoice on enum SubscriptionScheduleAmendParams.amendments[].amendment_start.typeschedule_settings on SubscriptionScheduleAmendParamsAdd support for new values invalid_representative_country and verification_failed_residential_address on enums Account.future_requirements.errors[].co
invalid_representative_country and verification_failed_residential_address on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, Capability.future_requirements.errors[].code, Capability.requirements.errors[].code, Person.future_requirements.errors[].code, and Person.requirements.errors[].coderequest_log_url on StripeError objectsnetwork_data on Issuing.Authorizationcurrency, description, images, and name from Checkout.SessionCreateParams. These properties do not work on the latest API version. (fixes #1575)Updated stable APIs to the latest version
reference_id to Paypal interface.Add support for new value invalid_dob_age_under_18 on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, Capability.
invalid_dob_age_under_18 on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, Capability.future_requirements.errors[].code, Capability.requirements.errors[].code, Person.future_requirements.errors[].code, and Person.requirements.errors[].codebank_of_china on enums Charge.payment_method_details.fpx.bank, PaymentIntentConfirmParams.payment_method_data.fpx.bank, PaymentIntentCreateParams.payment_method_data.fpx.bank, PaymentIntentUpdateParams.payment_method_data.fpx.bank, PaymentMethod.fpx.bank, PaymentMethodCreateParams.fpx.bank, SetupIntentConfirmParams.payment_method_data.fpx.bank, SetupIntentCreateParams.payment_method_data.fpx.bank, and SetupIntentUpdateParams.payment_method_data.fpx.bankAmerica/Nuuk, Europe/Kyiv, and Pacific/Kanton on enum Reporting.ReportRunCreateParams.parameters.timezoneklarna on SetupAttempt.payment_method_detailsDeprecate Checkout.SessionCreateParams.subscription_data.items (use the line_items param instead). This will be removed in the next major version.
Charge.payment_method_details.card_present.incremental_authorization_supported and Charge.payment_method_details.card_present.overcapture_supported from boolean | null to booleancreated on Checkout.Sessionsetup_future_usage on PaymentIntent.payment_method_options.pix, PaymentIntentConfirmParams.payment_method_options.pix, PaymentIntentCreateParams.payment_method_options.pix, and PaymentIntentUpdateParams.payment_method_options.pixCheckout.SessionCreateParams.subscription_data.items (use the line_items param instead). This will be removed in the next major version.Updated stable APIs to the latest version
FinancingOffer, FinancingSummary and FinancingTransaction resources.Add support for terms_of_service on Checkout.Session.consent_collection, Checkout.Session.consent, Checkout.SessionCreateParams.consent_collection, Pa
terms_of_service on Checkout.Session.consent_collection, Checkout.Session.consent, Checkout.SessionCreateParams.consent_collection, PaymentLink.consent_collection, and PaymentLinkCreateParams.consent_collectionplan on Checkout.SessionCreateParams.payment_method_options.card.installments. The property was mistakenly released and never worked.statement_descriptor on PaymentIntentIncrementAuthorizationParamsSubscriptionSchedule.phases[].currency to be requiredAdd support for pix on Charge.payment_method_details, Checkout.Session.payment_method_options, Checkout.SessionCreateParams.payment_method_options, Pa
pix on Charge.payment_method_details, Checkout.Session.payment_method_options, Checkout.SessionCreateParams.payment_method_options, 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, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_datapix on enum Checkout.SessionCreateParams.payment_method_types[]pix on enums CustomerListPaymentMethodsParams.type and PaymentMethodListParams.typefrom_invoice on InvoiceCreateParams and Invoicelatest_revision on Invoiceamount on Issuing.DisputeCreateParams and Issuing.DisputeUpdateParamspix 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.typepix_display_qr_code on PaymentIntent.next_actionpix on enums PaymentLink.payment_method_types[], PaymentLinkCreateParams.payment_method_types[], and PaymentLinkUpdateParams.payment_method_types[]pix on enum PaymentMethodCreateParams.typepix on enum PaymentMethod.typecreated on Treasury.CreditReversal and Treasury.DebitReversalAdd support for new value terminal_reader_splashscreen on enums File.purpose and FileListParams.purpose
terminal_reader_splashscreen on enums File.purpose and FileListParams.purposeAdd support for new values de-CH, en-CH, en-PL, en-PT, fr-CH, it-CH, pl-PL, and pt-PT on enums OrderCreateParams.payment.settings.payment_method_optio
de-CH, en-CH, en-PL, en-PT, fr-CH, it-CH, pl-PL, and pt-PT on enums OrderCreateParams.payment.settings.payment_method_options.klarna.preferred_locale, OrderUpdateParams.payment.settings.payment_method_options.klarna.preferred_locale, PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale, PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale, and PaymentIntentUpdateParams.payment_method_options.klarna.preferred_localedescription on PaymentLink.subscription_data and PaymentLinkCreateParams.subscription_dataChange Account.company.name, Charge.refunds, PaymentIntent.charges, Product.caption, Product.statement_descriptor, Product.unit_label, Terminal.Config
Account.company.name, Charge.refunds, PaymentIntent.charges, Product.caption, Product.statement_descriptor, Product.unit_label, Terminal.Configuration.tipping.aud.fixed_amounts, Terminal.Configuration.tipping.aud.percentages, Terminal.Configuration.tipping.cad.fixed_amounts, Terminal.Configuration.tipping.cad.percentages, Terminal.Configuration.tipping.chf.fixed_amounts, Terminal.Configuration.tipping.chf.percentages, Terminal.Configuration.tipping.czk.fixed_amounts, Terminal.Configuration.tipping.czk.percentages, Terminal.Configuration.tipping.dkk.fixed_amounts, Terminal.Configuration.tipping.dkk.percentages, Terminal.Configuration.tipping.eur.fixed_amounts, Terminal.Configuration.tipping.eur.percentages, Terminal.Configuration.tipping.gbp.fixed_amounts, Terminal.Configuration.tipping.gbp.percentages, Terminal.Configuration.tipping.hkd.fixed_amounts, Terminal.Configuration.tipping.hkd.percentages, Terminal.Configuration.tipping.myr.fixed_amounts, Terminal.Configuration.tipping.myr.percentages, Terminal.Configuration.tipping.nok.fixed_amounts, Terminal.Configuration.tipping.nok.percentages, Terminal.Configuration.tipping.nzd.fixed_amounts, Terminal.Configuration.tipping.nzd.percentages, Terminal.Configuration.tipping.sek.fixed_amounts, Terminal.Configuration.tipping.sek.percentages, Terminal.Configuration.tipping.sgd.fixed_amounts, Terminal.Configuration.tipping.sgd.percentages, Terminal.Configuration.tipping.usd.fixed_amounts, Terminal.Configuration.tipping.usd.percentages, Treasury.FinancialAccount.active_features, Treasury.FinancialAccount.pending_features, Treasury.FinancialAccount.platform_restrictions, and Treasury.FinancialAccount.restricted_features to be optional
login_page on BillingPortal.Configuration, BillingPortal.ConfigurationCreateParams, and BillingPortal.ConfigurationUpdateParamsdeutsche_bank_ag on enums Charge.payment_method_details.eps.bank, PaymentIntentConfirmParams.payment_method_data.eps.bank, PaymentIntentCreateParams.payment_method_data.eps.bank, PaymentIntentUpdateParams.payment_method_data.eps.bank, PaymentMethod.eps.bank, PaymentMethodCreateParams.eps.bank, SetupIntentConfirmParams.payment_method_data.eps.bank, SetupIntentCreateParams.payment_method_data.eps.bank, and SetupIntentUpdateParams.payment_method_data.eps.bankcustoms and phone_number on Issuing.Card.shipping and Issuing.CardCreateParams.shippingdescription on Quote.subscription_data, QuoteCreateParams.subscription_data, QuoteUpdateParams.subscription_data, SubscriptionSchedule.default_settings, SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.default_settings, SubscriptionScheduleCreateParams.phases[], SubscriptionScheduleUpdateParams.default_settings, and SubscriptionScheduleUpdateParams.phases[]Updated stable APIs to the latest version
* #1526 Add test coverage using Coveralls * #1527 fix: Update FetchHttpClient to send empty string for empty POST/PUT/PATCH requests. * #1528 Update R
This would generally be considered a breaking change, but we've worked with all existing users to migrate and are comfortable releasing this as a mino…
Terminal.Reader.action to be requiredTreasury.OutboundTransferCreateParams.destination_payment_method to be optionalTreasury.OutboundTransfer.destination_payment_method from string to string | nullCustomer.fundCashBalance test helper from CustomerBalanceTransaction to CustomerCashBalanceTransaction.
Updated stable APIs to the latest version
Stripe-Version beta headers are not pinned by-default and need to be manually specified, please refer to beta SDKs README sectionAdd support for new resource CustomerCashBalanceTransaction
CustomerCashBalanceTransactionpaypal from enums Order.payment.settings.payment_method_types[], OrderCreateParams.payment.settings.payment_method_types[], and OrderUpdateParams.payment.settings.payment_method_types[]currency on PaymentLinknetwork on SetupIntentConfirmParams.payment_method_options.card, SetupIntentCreateParams.payment_method_options.card, SetupIntentUpdateParams.payment_method_options.card, Subscription.payment_settings.payment_method_options.card, SubscriptionCreateParams.payment_settings.payment_method_options.card, and SubscriptionUpdateParams.payment_settings.payment_method_options.cardSubscription.currency to be requiredTopup.source from Source to Source | nullcustomer_cash_balance_transaction.created on enums WebhookEndpointCreateParams.enabled_events[] and WebhookEndpointUpdateParams.enabled_events[]Updated stable APIs to the latest version
Add support for payment_method_collection on Checkout.Session, Checkout.SessionCreateParams, PaymentLinkCreateParams, PaymentLinkUpdateParams, and Pay
payment_method_collection on Checkout.Session, Checkout.SessionCreateParams, PaymentLinkCreateParams, PaymentLinkUpdateParams, and PaymentLinkRename AddressParam to ShippingAddressParam, and change type of Source.source_order.shipping.address, SourceUpdateParams.SourceOrder.Shipping.address,
AddressParam to ShippingAddressParam, and change type of Source.source_order.shipping.address, SourceUpdateParams.SourceOrder.Shipping.address, and SessionCreateParams.PaymentIntentData.Shipping.address to ShippingAddressParamAccountAddressParam go AddressParam, and change type of AccountCreateParams.BusinessProfile.support_address, AccountCreateParams.Company.address, AccountCreateParams.Individual.address , AccountCreateParams.Individual.registered_address, AccountUpdateParams.BusinessProfile.support_address, AccountUpdateParams.Company.address, AccountUpdateParams.Individual.address, AccountUpdateParams.Individual.registered_address, ChargeCreateParams.Shipping.address, ChargeUpdateParams.Shipping.address, CustomerCreateParams.Shipping.address, CustomerUpdateParams.Shipping.address, CustomerSourceUpdateParams.Owner.address, InvoiceListUpcomingLinesParams.CustomerDetails.Shipping.address, InvoiceRetrieveUpcomingParams.CustomerDetails.Shipping.address, OrderCreateParams.BillingDetails.address, OrderCreateParams.ShippingDetails.address, OrderUpdateParams.BillingDetails.address, OrderUpdateParams.ShippingDetails.address, PaymentIntentCreateParams.Shipping.address, PaymentIntentUpdateParams.Shipping.address, PaymentIntentConfirmParams.Shipping.address, PersonCreateParams.address, PersonCreateParams.registered_address, PersonUpdateParams.address, PersonUpdateParams.registered_address, SourceCreateParams.Owner.address, SourceUpdateParams.Owner.address, TokenCreateParams.Account.Company.address, TokenCreateParams.Account.Individual.address, TokenCreateParams.Account.Individual.registered_address, TokenCreateParams.Person.address, TokenCreateParams.Person.registered_address, and Terminal.LocationUpdateParams.address to AddressParamexpires_at on Apps.Secret and Apps.SecretCreateParamsprocess_config on Terminal.Reader.action.process_payment_intentUpdated stable APIs to the latest version
Order resource supportYour coding agent can read these notes before it upgrades. Set up the MCP server →