v18.2.1

• #2346 Allow data to be set in only POST rawRequests
  • Fix bug where rawRequest incorrectly emits a warning when sending v2 GET requests

See the changelog for more details.

v18.3.0-beta.1

This release changes the pinned API version to 2025-05-28.preview.

• #2324 Update generated code for beta

  Breaking changes

  • Remove support for deprecated previews
    • Remove support for resources Billing.MeterErrorReport, GiftCards.Card, and GiftCards.Transaction
    • Remove support for create, list, retrieve, update, and validate methods on resource GiftCards.Card
    • Remove support for cancel, confirm, create, list, retrieve, and update methods on resource GiftCards.Transaction
    • Remove support for provisioning on ProductCreateParams and Product
    • Remove support for snapshot event BillingMeterErrorReportTriggeredEvent with resource Billing.MeterErrorReport
    • Remove support for error codes gift_card_balance_insufficient, gift_card_code_exists, and gift_card_inactive on QuotePreviewInvoice.last_finalization_error and StripeError
  • Remove support for values credits_attributed_to_debits and legacy_prorations from enums Checkout.SessionCreateParams.subscription_data.billing_mode, InvoiceCreatePreviewParams.schedule_details.billing_mode, InvoiceCreatePreviewParams.subscription_details.billing_mode, Quote.subscription_data.billing_mode, QuoteCreateParams.subscription_data.billing_mode, QuotePreviewSubscriptionSchedule.billing_mode, Subscription.billing_mode, SubscriptionCreateParams.billing_mode, SubscriptionSchedule.billing_mode, and SubscriptionScheduleCreateParams.billing_mode
  • Change type of Checkout.SessionUpdateParams.line_items[].quantity from emptyable(longInteger) to longInteger
  • Change CreditNote.post_payment_amount to be required
  • Change CreditNote.pre_payment_amount to be required
  • Change type of InvoiceCreatePreviewParams.subscription_details.cancel_at, SubscriptionCreateParams.cancel_at, and SubscriptionUpdateParams.cancel_at from DateTime to DateTime | enum('max_period_end'|'min_period_end')
  • Remove support for credits on OrderCreateParams, OrderUpdateParams, and Order
  • Remove support for amount_remaining on Order
  • Remove support for amount_credit on Order.total_details
  • Change type of PaymentAttemptRecord.metadata and PaymentRecord.metadata from map(string: string) | null to map(string: string)
  • Change type of PaymentRecordReportPaymentAttemptCanceledParams.metadata, PaymentRecordReportPaymentAttemptFailedParams.metadata, PaymentRecordReportPaymentAttemptGuaranteedParams.metadata, PaymentRecordReportPaymentAttemptParams.metadata, and PaymentRecordReportPaymentParams.metadata from map(string: string) to emptyable(map(string: string))
  • Change type of Privacy.RedactionJob.status from string to enum
  • Change type of Privacy.RedactionJob.validation_behavior from string to enum('error'|'fix')
  • Change type of Privacy.RedactionJobValidationError.code from string to enum
  • Change type of Privacy.RedactionJobValidationError.erroring_object from map(string: string) to RedactionResourceErroringObject
  • Remove support for status_details and status on Tax.Association

  Other changes

  • Add support for migrate method on resource Subscription
  • Add support for distance, pickup_location_name, return_location_name, and vehicle_identification_number on ChargeCaptureParams.payment_details.car_rental, ChargeUpdateParams.payment_details.car_rental, PaymentIntent.payment_details.car_rental, PaymentIntentCaptureParams.payment_details.car_rental, PaymentIntentConfirmParams.payment_details.car_rental, PaymentIntentCreateParams.payment_details.car_rental, and PaymentIntentUpdateParams.payment_details.car_rental
  • Add support for driver_identification_number and driver_tax_number on ChargeCaptureParams.payment_details.car_rental.drivers[], ChargeUpdateParams.payment_details.car_rental.drivers[], PaymentIntent.payment_details.car_rental.drivers[], PaymentIntentCaptureParams.payment_details.car_rental.drivers[], PaymentIntentConfirmParams.payment_details.car_rental.drivers[], PaymentIntentCreateParams.payment_details.car_rental.drivers[], and PaymentIntentUpdateParams.payment_details.car_rental.drivers[]
  • Add support for new values classic and flexible on enums Checkout.SessionCreateParams.subscription_data.billing_mode, InvoiceCreatePreviewParams.schedule_details.billing_mode, InvoiceCreatePreviewParams.subscription_details.billing_mode, Quote.subscription_data.billing_mode, QuoteCreateParams.subscription_data.billing_mode, QuotePreviewSubscriptionSchedule.billing_mode, Subscription.billing_mode, SubscriptionCreateParams.billing_mode, SubscriptionSchedule.billing_mode, and SubscriptionScheduleCreateParams.billing_mode
  • Add support for institution on FinancialConnections.Account
  • Add support for countries on FinancialConnections.Institution
  • Add support for location and reader on PaymentAttemptRecord.payment_method_details.affirm, PaymentAttemptRecord.payment_method_details.wechat_pay, PaymentRecord.payment_method_details.affirm, and PaymentRecord.payment_method_details.wechat_pay
  • Add support for hooks on PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentDecrementAuthorizationParams, PaymentIntentIncrementAuthorizationParams, PaymentIntentUpdateParams, and PaymentIntent
  • Remove support for async_workflows on PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentDecrementAuthorizationParams, PaymentIntentIncrementAuthorizationParams, PaymentIntentUpdateParams, and PaymentIntent
  • Add support for card_present on PaymentIntentAmountDetailsLineItem.payment_method_options
  • Add support for livemode on Privacy.RedactionJob
  • Add support for billing_thresholds on QuotePreviewSubscriptionSchedule.default_settings, QuotePreviewSubscriptionSchedule.phases[].items[], and QuotePreviewSubscriptionSchedule.phases[]
  • Add support for billing_mode_details on Subscription
  • Add support for tax_transaction_attempts on Tax.Association
  • Add support for confirm_config on Terminal.Reader.action.confirm_payment_intent and Terminal.ReaderConfirmPaymentIntentParams
  • Add support for error code forwarding_api_upstream_error on QuotePreviewInvoice.last_finalization_error

See the changelog for more details.

v18.2.0

This release changes the pinned API version to 2025-05-28.basil.

• #2338 Update generated code
  • Add support for attach_payment method on resource Invoice
  • Add support for collect_inputs method on resource Terminal.Reader
  • Add support for succeed_input_collection and timeout_input_collection test helper methods on resource Terminal.Reader
  • Add support for pix_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilities
  • Add support for disputes_list and payment_disputes on AccountSession.components and AccountSessionCreateParams.components
  • Add support for refund_and_dispute_prefunding on Balance
  • Add support for balance_type on BalanceTransaction
  • Change Billing.AlertCreateParams.usage_threshold.meter to be required
  • Add support for location and reader on Charge.payment_method_details.affirm and Charge.payment_method_details.wechat_pay
  • Add support for payment_method_remove on Checkout.SessionCreateParams.saved_payment_method_options
  • Add support for setup_future_usage on Checkout.Session.payment_method_options.naver_pay
  • Change ConfirmationToken.payment_method_preview.naver_pay.buyer_id and PaymentMethod.naver_pay.buyer_id to be required
  • Add support for post_payment_amount and pre_payment_amount on CreditNote
  • Add support for new value mixed on enum CreditNote.type
  • Add support for new value invoice_payment.paid on enum Event.type
  • Add support for sex, unparsed_place_of_birth, and unparsed_sex on Identity.VerificationReport.document and Identity.VerificationSession.verified_outputs
  • Add support for billing_thresholds on InvoiceCreatePreviewParams.schedule_details.phases[].items[], InvoiceCreatePreviewParams.schedule_details.phases[], InvoiceCreatePreviewParams.subscription_details.items[], SubscriptionCreateParams.items[], SubscriptionCreateParams, SubscriptionItemCreateParams, SubscriptionItemUpdateParams, SubscriptionItem, SubscriptionSchedule.default_settings, SubscriptionSchedule.phases[].items[], SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.default_settings, SubscriptionScheduleCreateParams.phases[].items[], SubscriptionScheduleCreateParams.phases[], SubscriptionScheduleUpdateParams.default_settings, SubscriptionScheduleUpdateParams.phases[].items[], SubscriptionScheduleUpdateParams.phases[], SubscriptionUpdateParams.items[], SubscriptionUpdateParams, and Subscription
  • Add support for satispay on PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_method_options, and PaymentIntentUpdateParams.payment_method_options
  • Add support for capture_method on PaymentIntent.payment_method_options.billie
  • Add support for kakao_pay, kr_card, naver_pay, payco, and samsung_pay on PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, and PaymentMethodConfiguration
  • Add support for network_decline_code on Refund.destination_details.paypal
  • Add support for metadata on Tax.CalculationCreateParams.line_items[] and Tax.CalculationLineItem
  • Add support for new value simulated_stripe_s700 on enums Terminal.Reader.device_type and Terminal.ReaderListParams.device_type
  • Add support for return_url on Terminal.Reader.action.process_payment_intent.process_config and Terminal.ReaderProcessPaymentIntentParams.process_config
  • Add support for collect_inputs on Terminal.Reader.action
  • Add support for new value collect_inputs on enum Terminal.Reader.action.type
  • Add support for new value invoice_payment.paid on enums WebhookEndpointCreateParams.enabled_events and WebhookEndpointUpdateParams.enabled_events
  • Add support for new value 2025-05-28.basil on enum WebhookEndpointCreateParams.api_version
  • Add support for snapshot event InvoicePaymentPaidEvent with resource InvoicePayment
  • Add support for error code forwarding_api_upstream_error on Invoice.last_finalization_error, PaymentIntent.last_payment_error, SetupAttempt.setup_error, SetupIntent.last_setup_error, and StripeError

See the changelog for more details.

v18.1.1

• #2308 RawRequest now allows you set host and streaming in request options.

  const file = await stripe.rawRequest(
    'GET',
    '/v1/files/file_123/contents',
    {},
    {host: 'files.stripe.com', streaming: true}
  );

• #2320 fix: examples/webhook-signing/nestjs/package.json to reduce vulnerabilities
• #2326 Adds CONTRIBUTING.md

See the changelog for more details.

v18.2.0-beta.1

• #2307 Update generated code for beta
  This release changes the pinned API version to 2025-04-30.preview.

  • Add support for billing_mode on Checkout.SessionCreateParams.subscription_data, InvoiceCreatePreviewParams.schedule_details, InvoiceCreatePreviewParams.subscription_details, Quote.subscription_data, QuoteCreateParams.subscription_data, QuotePreviewSubscriptionSchedule, SubscriptionCreateParams, SubscriptionScheduleCreateParams, SubscriptionSchedule, and Subscription
  • Add support for new values aw_tin, az_tin, bd_bin, bf_ifu, bj_ifu, cm_niu, cv_nif, et_tin, kg_tin, and la_tin on enums Checkout.Session.collected_information.tax_ids[].type, Order.tax_details.tax_ids[].type, and QuotePreviewInvoice.customer_tax_ids[].type
  • Change Checkout.Session.automatic_tax.provider, Invoice.automatic_tax.provider, Quote.automatic_tax.provider, and QuotePreviewInvoice.automatic_tax.provider to be required
  • Add support for account_number on ConfirmationToken.payment_method_preview.acss_debit and PaymentMethod.acss_debit
  • Add support for new value balance_settings.updated on enum Event.type
  • Add support for new values aw_tin, az_tin, bd_bin, bf_ifu, bj_ifu, cm_niu, cv_nif, et_tin, kg_tin, and la_tin on enums OrderCreateParams.tax_details.tax_ids[].type and OrderUpdateParams.tax_details.tax_ids[].type
  • Add support for new value balance_settings.updated on enums WebhookEndpointUpdateParams.enabled_events

See the changelog for more details.

v18.1.0

This release changes the pinned API version to 2025-04-30.basil.

• #2311 Update generated code
  • Add support for minority_owned_business_designation on Account.business_profile, AccountCreateParams.business_profile, and AccountUpdateParams.business_profile
  • Add support for registration_date on Account.company, AccountCreateParams.company, AccountUpdateParams.company, and TokenCreateParams.account.company
  • Add support for us_cfpb_data on AccountCreatePersonParams, AccountUpdatePersonParams, Person, and TokenCreateParams.person
  • Add support for new value verification_legal_entity_structure_mismatch on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, BankAccount.future_requirements.errors[].code, BankAccount.requirements.errors[].code, Capability.future_requirements.errors[].code, Capability.requirements.errors[].code, Person.future_requirements.errors[].code, and Person.requirements.errors[].code
  • Add support for new value tax_id_prohibited on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.code
  • Add support for tax_id on Charge.billing_details, ConfirmationToken.payment_method_preview.billing_details, ConfirmationTokenCreateParams.testHelpers.payment_method_data.billing_details, PaymentIntentConfirmParams.payment_method_data.billing_details, PaymentIntentCreateParams.payment_method_data.billing_details, PaymentIntentUpdateParams.payment_method_data.billing_details, PaymentMethod.billing_details, PaymentMethodCreateParams.billing_details, PaymentMethodUpdateParams.billing_details, SetupIntentConfirmParams.payment_method_data.billing_details, SetupIntentCreateParams.payment_method_data.billing_details, and SetupIntentUpdateParams.payment_method_data.billing_details
  • Add support for wallet_options on Checkout.SessionCreateParams and Checkout.Session
  • Add support for provider on Checkout.Session.automatic_tax, Invoice.automatic_tax, and Quote.automatic_tax
  • Add support for new values aw_tin, az_tin, bd_bin, bf_ifu, bj_ifu, cm_niu, cv_nif, et_tin, kg_tin, and la_tin on enums Checkout.Session.customer_details.tax_ids[].type, Invoice.customer_tax_ids[].type, Tax.Calculation.customer_details.tax_ids[].type, Tax.Transaction.customer_details.tax_ids[].type, and TaxId.type
  • Add support for payment_method_options on ConfirmationTokenCreateParams.testHelpers
  • Add support for installments on ConfirmationToken.payment_method_options.card
  • Add support for new values aw_tin, az_tin, bd_bin, bf_ifu, bj_ifu, cm_niu, cv_nif, et_tin, kg_tin, and la_tin on enums CustomerCreateParams.tax_id_data[].type, CustomerCreateTaxIdParams.type, InvoiceCreatePreviewParams.customer_details.tax_ids[].type, Tax.CalculationCreateParams.customer_details.tax_ids[].type, and TaxIdCreateParams.type
  • Add support for context on Event
  • Add support for new value affirm 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
  • Change type of InvoiceLineItem.parent.subscription_item_details.subscription from string to string | null
  • Add support for billie on PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_method_options, and PaymentIntentUpdateParams.payment_method_options
  • Add support for pix on PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, and PaymentMethodConfiguration
  • Add support for klarna on PaymentMethodDomain
  • Add support for pending_reason on Refund
  • Change type of Tax.CalculationLineItem.reference from string | null to string
  • Add support for aw, az, bd, bf, bj, cm, cv, et, in, kg, la, and ph on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_options
  • Add support for new value 2025-04-30.basil on enum WebhookEndpointCreateParams.api_version
• #2202 Add build scripts to generate source maps
• #2169 Put @types/node as an optional peerDependency
• #2164 Bump micromatch from 4.0.5 to 4.0.8
• #2230 Bump cross-spawn from 7.0.3 to 7.0.6

See the changelog for more details.

v18.1.0-beta.3

• #2302 Update generated code for beta
  • Add support for new resources FxQuote and PaymentIntentAmountDetailsLineItem
  • Add support for create, list, and retrieve methods on resource FxQuote
  • Remove support for attach_payment_intent method on resource Invoice
  • Add support for registration_date on Account.company, AccountCreateParams.company, AccountUpdateParams.company, and TokenCreateParams.account.company
  • Add support for customer_reference and order_reference on ChargeCaptureParams.payment_details, ChargeUpdateParams.payment_details, PaymentIntent.payment_details, PaymentIntentCaptureParams.payment_details, PaymentIntentConfirmParams.payment_details, PaymentIntentCreateParams.payment_details, and PaymentIntentUpdateParams.payment_details
  • Add support for tax_id on Charge.billing_details, ConfirmationToken.payment_method_preview.billing_details, ConfirmationTokenCreateParams.testHelpers.payment_method_data.billing_details, PaymentIntentConfirmParams.payment_method_data.billing_details, PaymentIntentCreateParams.payment_method_data.billing_details, PaymentIntentUpdateParams.payment_method_data.billing_details, PaymentMethod.billing_details, PaymentMethodCreateParams.billing_details, PaymentMethodUpdateParams.billing_details, SetupIntentConfirmParams.payment_method_data.billing_details, SetupIntentCreateParams.payment_method_data.billing_details, SetupIntentUpdateParams.payment_method_data.billing_details, and Treasury.OutboundPaymentCreateParams.destination_payment_method_data.billing_details
  • Add support for price_data on Checkout.SessionUpdateParams.line_items[]
  • Change type of Checkout.SessionUpdateParams.line_items[].quantity from longInteger to emptyable(longInteger)
  • Add support for script on CouponCreateParams and Coupon
  • Add support for type on Coupon
  • Add support for new value fx_quote.expired on enum Event.type
  • Add support for new value affirm on enums Invoice.payment_settings.payment_method_types, InvoiceCreateParams.payment_settings.payment_method_types, InvoiceUpdateParams.payment_settings.payment_method_types, QuotePreviewInvoice.payment_settings.payment_method_types, Subscription.payment_settings.payment_method_types, SubscriptionCreateParams.payment_settings.payment_method_types, and SubscriptionUpdateParams.payment_settings.payment_method_types
  • Add support for fx_quote on PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentUpdateParams, PaymentIntent, TransferCreateParams, and Transfer
  • Add support for discount_amount, line_items, shipping, and tax on PaymentIntent.amount_details
  • Add support for pix on PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, and PaymentMethodConfiguration
  • Add support for us_cfpb_data on Person and TokenCreateParams.person
  • Add support for pending_reason on Refund
  • Add support for aw, az, bd, bj, et, kg, la, and ph on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_options
  • Add support for new value fx_quote.expired on enums WebhookEndpointCreateParams.enabled_events and WebhookEndpointUpdateParams.enabled_events
  • Add support for snapshot event FxQuoteExpiredEvent with resource FxQuote

See the changelog for more details.

v18.1.0-beta.2

• #2298 Update generated code for beta

  Breaking changes

  • Change type of V2.MoneyManagement.ReceivedDebit.status_transitions from an object to an object | null
  • Remove support for values bank_accounts.local_uk, bank_accounts.wire_uk, cards_uk, and crypto_wallets_v2 from enum EventsV2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.updated_capability

  Additions

  • Add support for new resources Privacy.RedactionJobRootObjects, Privacy.RedactionJobValidationError, and Privacy.RedactionJob
  • Add support for cancel, create, list, retrieve, run, update, and validate methods on resource RedactionJob
  • Add support for list and retrieve methods on resource RedactionJobValidationError
  • Add support for minority_owned_business_designation on Account.business_profile, AccountCreateParams.business_profile, and AccountUpdateParams.business_profile
  • Add support for new value verification_legal_entity_structure_mismatch on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, AccountCapability.future_requirements.errors[].code, AccountCapability.requirements.errors[].code, AccountPerson.future_requirements.errors[].code, AccountPerson.requirements.errors[].code, BankAccount.future_requirements.errors[].code, and BankAccount.requirements.errors[].code
  • Add support for export_tax_transactions and payment_disputes on AccountSessionCreateParams.components
  • Add support for new value tax_id_prohibited on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, QuotePreviewInvoice.last_finalization_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.code
  • Add support for new value fixed_term_loan on enum Capital.FinancingOffer.type
  • Add support for wallet_options on Checkout.SessionCreateParams and Checkout.Session
  • Add support for new values privacy.redaction_job.canceled, privacy.redaction_job.created, privacy.redaction_job.ready, privacy.redaction_job.succeeded, and privacy.redaction_job.validation_error on enum Event.type
  • Add support for klarna on PaymentMethodDomain
  • Change type of Tax.CalculationLineItem.reference from string | null to string
  • Add support for in on Tax.Registration.country_options and Tax.RegistrationCreateParams.country_options
  • Add support for new values privacy.redaction_job.canceled, privacy.redaction_job.created, privacy.redaction_job.ready, privacy.redaction_job.succeeded, and privacy.redaction_job.validation_error on enums WebhookEndpointCreateParams.enabled_events and WebhookEndpointUpdateParams.enabled_events

• #2300 Handle external_resource field

  • Changes external_account field in ExternalAccountsCreateParams from a string to a union type.

See the changelog for more details.

v18.1.0-beta.1

• #2288 Update generated code for beta
  This release changes the pinned API version to 2025-03-31.preview

  Breaking Changes

  • Remove support for amount_overpaid on InvoicePayment
  • Remove support for values out_of_band_payment and payment_record from enum InvoicePayment.payment.type
  • Remove support for interchange_fees, net_total, network_fees, and transaction_volume on Issuing.Settlement
  • Remove support for billing_thresholds on QuotePreviewSubscriptionSchedule.default_settings, QuotePreviewSubscriptionSchedule.phases[].items[], and QuotePreviewSubscriptionSchedule.phases[]
  • Remove support for coupon on QuotePreviewSubscriptionSchedule.phases[]
  • Remove support for value on Terminal.Reader.action.collect_inputs.inputs[].selection.choices[], Terminal.Reader.action.collect_inputs.inputs[].selection, and Terminal.ReaderCollectInputsParams.inputs[].selection.choices[]
  • Change Checkout.Session.permissions.update to be optional
  • Change type of InvoicePayment.is_default from boolean | null to boolean
  • Change Invoice.amount_overpaid and QuotePreviewInvoice.amount_overpaid to be required
  • Change type of PaymentAttemptRecord.payment_method_details.type and PaymentRecord.payment_method_details.type from literal('custom') to string
  • Change type of PaymentAttemptRecord.payment_record from string to string | null
  • Change PaymentAttemptRecord.payment_method_details.custom and PaymentRecord.payment_method_details.custom to be optional
  • Change PaymentRecordReportPaymentParams.payment_reference to be optional
  • Change type of PaymentRecord.latest_payment_attempt_record from string to string | null

  Additions

  • Add support for new resources BalanceSettings
  • Add support for retrieve and update methods on resource BalanceSettings
  • Add support for create, del, list, retrieve, and update methods on a new ExternalAccountService class to access cards and bank accounts made available in the new path v1/external_accounts. Access this via StripeClient.externalAccounts
  • Add support for stripe_balance_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilities
  • Add support for customer_account on Billing.CreditBalanceSummaryRetrieveParams, Billing.CreditBalanceSummary, Billing.CreditBalanceTransactionListParams, Billing.CreditGrantCreateParams, Billing.CreditGrantListParams, Billing.CreditGrant, BillingPortal.SessionCreateParams, BillingPortal.Session, Checkout.SessionCreateParams, Checkout.SessionListParams, Checkout.Session, ConfirmationToken.payment_method_preview, CreditNoteListParams, CreditNote, CustomerBalanceTransaction, CustomerCashBalanceTransaction, CustomerCashBalance, CustomerPaymentMethod, CustomerSessionCreateParams, CustomerSession, CustomerTaxId.owner, CustomerTaxId, Customer, Discount, FinancialConnections.Account.account_holder, FinancialConnections.AccountListParams.account_holder, FinancialConnections.Session.account_holder, FinancialConnections.SessionCreateParams.account_holder, InvoiceCreateParams, InvoiceCreatePreviewParams, InvoiceItemCreateParams, InvoiceItemListParams, InvoiceItem, InvoiceListParams, Invoice, PaymentIntentCreateParams, PaymentIntentListParams, PaymentIntentUpdateParams, PaymentIntent, PaymentMethodAttachParams, PaymentMethod, PromotionCodeCreateParams, PromotionCodeListParams, PromotionCode, QuoteCreateParams, QuoteListParams, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, QuoteUpdateParams, Quote, SetupAttempt, SetupIntentCreateParams, SetupIntentListParams, SetupIntentUpdateParams, SetupIntent, SubscriptionCreateParams, SubscriptionListParams, SubscriptionScheduleCreateParams, SubscriptionScheduleListParams, SubscriptionSchedule, Subscription, TaxId.owner, TaxIdCreateParams.owner, TaxIdListParams.owner, and TaxId
  • Add support for stripe_balance on Charge.payment_method_details, ConfirmationToken.payment_method_preview, ConfirmationTokenCreateParams.testHelpers.payment_method_data, CustomerPaymentMethod, PaymentAttemptRecord.payment_method_details, PaymentIntent.payment_method_options, PaymentIntentConfirmParams.payment_method_data, PaymentIntentConfirmParams.payment_method_options, PaymentIntentCreateParams.payment_method_data, PaymentIntentCreateParams.payment_method_options, PaymentIntentUpdateParams.payment_method_data, PaymentIntentUpdateParams.payment_method_options, PaymentMethodCreateParams, PaymentMethod, PaymentRecord.payment_method_details, SetupAttempt.payment_method_details, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_data
  • Add support for update_line_items and update_shipping_details on Checkout.Session.permissions and Checkout.SessionCreateParams.permissions
  • Add support for provider on Checkout.Session.automatic_tax, Invoice.automatic_tax, Quote.automatic_tax, and QuotePreviewInvoice.automatic_tax
  • Add support for tax_calculation_reference on CreditNoteLineItem, CreditNotePreviewLines, InvoiceLineItem, LineItem, PaymentLinkLineItem, QuoteComputedUpfrontLineItems, QuoteLineItem, and SessionLineItem
  • Add support for payment_method_options on ConfirmationTokenCreateParams.testHelpers
  • Add support for installments on ConfirmationToken.payment_method_options.card
  • Add support for context on Event
  • Add support for related_customer_account on Identity.VerificationSession, identity.VerificationSessionCreateParams, and identity.VerificationSessionListParams
  • Add support for network_data on Issuing.DisputeSettlementDetail
  • Add support for interchange_fees_amount, net_total_amount, network_fees_amount, other_fees_amount, other_fees_count, and transaction_amount on Issuing.Settlement
  • Add support for reported_by on PaymentAttemptRecord
  • Add support for ach_credit_transfer, ach_debit, acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card_present, card, cashapp, customer_balance, eps, fpx, giropay, gopay, grabpay, id_bank_transfer, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, sepa_credit_transfer, sepa_debit, shopeepay, sofort, stripe_account, swish, twint, us_bank_account, wechat_pay, wechat, and zip on PaymentAttemptRecord.payment_method_details and PaymentRecord.payment_method_details
  • Add support for payout_method on PayoutCreateParams and Payout
  • Add support for confirmation_secret, parent, and total_taxes on QuotePreviewInvoice
  • Add support for new values forwarding_api_retryable_upstream_error, setup_intent_mobile_wallet_unsupported, v2_account_disconnection_unsupported, and v2_account_missing_configuration on enum QuotePreviewInvoice.last_finalization_error.code
  • Add support for new values klarna, nz_bank_account, and stripe_balance on enum QuotePreviewInvoice.payment_settings.payment_method_types
  • Add support for id and text on Terminal.Reader.action.collect_inputs.inputs[].selection.choices[], Terminal.Reader.action.collect_inputs.inputs[].selection, and Terminal.ReaderCollectInputsParams.inputs[].selection.choices[]

  New APIs for Money CardManagement

  • Add support for new resources V2.FinancialAddressCreditSimulation, V2.FinancialAddressGeneratedMicrodeposits, V2.MoneyManagement.Adjustment, V2.MoneyManagement.FinancialAccount, V2.MoneyManagement.FinancialAddress, V2.MoneyManagement.InboundTransfer, V2.MoneyManagement.OutboundPaymentQuote, V2.MoneyManagement.OutboundPayment, V2.MoneyManagement.OutboundSetupIntent, V2.MoneyManagement.OutboundTransfer, V2.MoneyManagement.PayoutMethod, V2.MoneyManagement.PayoutMethodsBankAccountSpec, V2.MoneyManagement.ReceivedCredit, V2.MoneyManagement.ReceivedDebit, V2.MoneyManagement.TransactionEntry, and V2.MoneyManagement.Transaction
  • Add support for create method on resource V2.MoneyManagement.OutboundPaymentQuote
  • Add support for list and retrieve methods on resources V2.MoneyManagement.Adjustment, V2.MoneyManagement.FinancialAccount, V2.MoneyManagement.ReceivedCredit, V2.MoneyManagement.ReceivedDebit, V2.MoneyManagement.TransactionEntry, and V2.MoneyManagement.Transaction
  • Add support for create, list, and retrieve methods on resources V2.MoneyManagement.FinancialAddress and V2.MoneyManagement.InboundTransfer
  • Add support for cancel, create, list, and retrieve methods on resources V2.MoneyManagement.OutboundPayment and V2.MoneyManagement.OutboundTransfer
  • Add support for archive, list, retrieve, and unarchive methods on resource V2.MoneyManagement.PayoutMethod
  • Add support for cancel, create, list, retrieve, and update methods on resource V2.MoneyManagement.OutboundSetupIntent
  • Add support for retrieve method on resource V2.MoneyManagement.PayoutMethodsBankAccountSpec
  • Add support for new values account_number, fedwire_routing_number, and routing_number on enum invalid_payment_method.invalid_param
  • Add support for new thin event V2MoneyManagementFinancialAccountCreatedEvent with related object V2.MoneyManagement.FinancialAccount
  • Add support for new thin events `V2MoneyManagementFinancialAddressActivat...

v18.0.0

• #2279 Support for APIs in the new API version 2025-03-31.basil

  This release changes the pinned API version to 2025-03-31.basil.

  ⚠️ Breaking changes due to changes in the Stripe API

  Please review details for the breaking changes and alternatives in the Stripe API changelog before upgrading.

  • Remove support for resources SubscriptionItemUsageRecordSummary and SubscriptionItemUsageRecord
  • Remove support for listUpcomingLines and retrieveUpcoming methods on resource Invoice
  • Remove support for createUsageRecord and listUsageRecordSummaries methods on resource SubscriptionItems
  • Remove support for invoice on Charge and PaymentIntent
  • Remove support for shipping_details on Checkout.Session
  • Remove support for carrier, phone, and tracking_number on Checkout.Session.collected_information.shipping_details. Make name and address required instead of optional.
  • Remove support for refund on CreditNoteCreateParams, CreditNoteListPreviewLineItemsParams, CreditNotePreviewParams, and CreditNote
  • Remove support for tax_amounts on CreditNoteLineItem, CreditNote, and InvoiceLineItem
  • Remove support for amount_excluding_tax and unit_amount_excluding_tax on CreditNoteLineItem and InvoiceLineItem
  • Remove support for coupon on CustomerCreateParams, CustomerUpdateParams, InvoiceCreatePreviewParams.schedule_details.phases[], InvoiceCreatePreviewParams, SubscriptionCreateParams, SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.phases[], SubscriptionScheduleUpdateParams.phases[], and SubscriptionUpdateParams
  • Remove support for promotion_code on CustomerCreateParams, CustomerUpdateParams, SubscriptionCreateParams, and SubscriptionUpdateParams
  • Remove support for price on InvoiceAddLinesParams.lines[], InvoiceItemCreateParams, InvoiceItemUpdateParams, InvoiceItem, InvoiceLineItemUpdateParams, InvoiceLineItem, and InvoiceUpdateLinesParams.lines[]. Use pricing` instead.
  • Remove support for billing_thresholds on InvoiceCreatePreviewParams.schedule_details.phases[].items[], InvoiceCreatePreviewParams.schedule_details.phases[], InvoiceCreatePreviewParams.subscription_details.items[], SubscriptionCreateParams.items[], SubscriptionCreateParams, SubscriptionItemCreateParams, SubscriptionItemUpdateParams, SubscriptionItem, SubscriptionSchedule.default_settings, SubscriptionSchedule.phases[].items[], SubscriptionSchedule.phases[], SubscriptionScheduleCreateParams.default_settings, SubscriptionScheduleCreateParams.phases[].items[], SubscriptionScheduleCreateParams.phases[], SubscriptionScheduleUpdateParams.default_settings, SubscriptionScheduleUpdateParams.phases[].items[], SubscriptionScheduleUpdateParams.phases[], SubscriptionUpdateParams.items[], SubscriptionUpdateParams, and Subscription
  • Remove support for application_fee_amount, charge, paid_out_of_band, paid, payment_intent, quote, subscription, subscription_details, subscription_proration_date, tax, total_tax_amounts, and transfer_data on Invoice
  • Remove support for discount on Invoice and Subscription
  • Remove support for invoice_item, proration_details, proration, tax_rates, and type on InvoiceLineItem
  • Remove support for plan and subscription_item on InvoiceItem and InvoiceLineItem
  • Remove support for unit_amount on InvoiceItemCreateParams, InvoiceItemUpdateParams, and InvoiceItem
  • Remove support for subscription and unit_amount_decimal on InvoiceItem
  • Remove support for naver_pay on PaymentMethodUpdateParams
  • Remove support for aggregate_usage on PlanCreateParams, Plan, Price.recurring, and PriceCreateParams.recurring
  • Remove support for current_period_end and current_period_start on Subscription
  • page has been removed from all V2 list method params (e.g. EventService.list()); use the auto paginator or the next_page_url and previous_page_url fields instead (more info)

  Changes

  • Change Checkout.Session.collected_information to be required
  • Change Checkout.Session.collected_information.shipping_details to be required
  • Change Checkout.Session.collected_information.shipping_details.address to be required
  • Change Checkout.Session.collected_information.shipping_details.name to be required
  • Change PaymentIntentConfirmParams.payment_method_options.wechat_pay.client, PaymentIntentCreateParams.payment_method_options.wechat_pay.client, and PaymentIntentUpdateParams.payment_method_options.wechat_pay.client to be optional
  • Change political_exposure on resources Person and Token and params Token.CreateParams from string to enum("existing" | "none")

  Additions

  • Add support for new resource InvoicePayment
  • Add support for list and retrieve methods on resource InvoicePayment
  • Add support for billie_payments, nz_bank_account_becs_debit_payments, and satispay_payments on Account.capabilities, AccountCreateParams.capabilities, and AccountUpdateParams.capabilities
  • Add support for hosted_payment_method_save on Account.settings.invoices and AccountUpdateParams.settings.invoices
  • Add support for invoices on AccountCreateParams.settings
  • Add support for new values information_missing, invalid_signator, verification_failed_authorizer_authority, and verification_rejected_ownership_exemption_reason on enums Account.future_requirements.errors[].code, Account.requirements.errors[].code, AccountCapability.future_requirements.errors[].code, AccountCapability.requirements.errors[].code, AccountPerson.future_requirements.errors[].code, AccountPerson.requirements.errors[].code, BankAccount.future_requirements.errors[].code, and BankAccount.requirements.errors[].code
  • Add support for new values forwarding_api_retryable_upstream_error and setup_intent_mobile_wallet_unsupported on enums Invoice.last_finalization_error.code, PaymentIntent.last_payment_error.code, SetupAttempt.setup_error.code, SetupIntent.last_setup_error.code, and StripeError.code
  • Add support for new values stripe_balance_payment_debit_reversal and stripe_balance_payment_debit on enum BalanceTransaction.type
  • Add support for new value last on enums Billing.Meter.default_aggregation.formula and Billing.MeterCreateParams.default_aggregation.formula
  • Add support for presentment_details on Charge, Checkout.Session, PaymentIntent, and Refund
  • Add support for billie and satispay on Charge.payment_method_details, ConfirmationToken.payment_method_preview, ConfirmationTokenCreateParams.testHelpers.payment_method_data, CustomerPaymentMethod, PaymentIntentConfirmParams.payment_method_data, PaymentIntentCreateParams.payment_method_data, PaymentIntentUpdateParams.payment_method_data, PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, PaymentMethodConfiguration, PaymentMethodCreateParams, PaymentMethod, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_data
  • Add support for nz_bank_account on Charge.payment_method_details, ConfirmationToken.payment_method_preview, ConfirmationTokenCreateParams.testHelpers.payment_method_data, CustomerPaymentMethod, 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, PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationUpdateParams, PaymentMethodConfiguration, PaymentMethodCreateParams, PaymentMethod, SetupAttempt.payment_method_details, SetupIntentConfirmParams.payment_method_data, SetupIntentCreateParams.payment_method_data, and SetupIntentUpdateParams.payment_method_data
  • Add support for optional_items on Checkout.SessionCreateParams, Checkout.Session, PaymentLinkCreateParams, and PaymentLink
  • Add support for permissions on Checkout.SessionCreateParams and Checkout.Session
  • Add support for new values billie and satispay on enum Checkout.SessionCreateParams.payment_method_types
  • Add support for new value custom on enums Checkout.Session.ui_mode and Checkout.SessionCreateParams.ui_mode
  • Add support for shipping_options on Checkout.SessionUpdateParams
  • Add support for new values billie, nz_bank_account, and satispay on enums ConfirmationTokenCreateParams.testHelpers.payment_method_data.type, PaymentIntentConfirmParams.payment_method_data.type, PaymentIntentCreateParams.payment_method_data.type, PaymentIntentUpdateParams.payment_method_data.type, SetupIntentConfirmParams.payment_method_data.type, SetupIntentCreateParams.payment_method_data.type, and SetupIntentUpdateParams.payment_method_data.type
  • Add support for buyer_id on ConfirmationToken.payment_method_preview.naver_pay, CustomerPaymentMethod.naver_pay, and PaymentMethod.naver_pay
  • Add support for new values billie, nz_bank_account, and satispay on enums ConfirmationToken.payment_method_preview.type, CustomerPaymentMethod.type, and PaymentMethod.type
  • Add support for refunds on CreditNoteCreateParams, CreditNoteListPreviewLineItemsParams, CreditNotePreviewParams, an...