-
#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
andSubscriptionItemUsageRecord
- Remove support for
listUpcomingLines
andretrieveUpcoming
methods on resourceInvoice
- Remove support for
createUsageRecord
andlistUsageRecordSummaries
methods on resourceSubscriptionItems
- Remove support for
invoice
onCharge
andPaymentIntent
- Remove support for
shipping_details
onCheckout.Session
- Remove support for
carrier
,phone
, andtracking_number
onCheckout.Session.collected_information.shipping_details
. Makename
andaddress
required instead of optional. - Remove support for
refund
onCreditNoteCreateParams
,CreditNoteListPreviewLineItemsParams
,CreditNotePreviewParams
, andCreditNote
- Remove support for
tax_amounts
onCreditNoteLineItem
,CreditNote
, andInvoiceLineItem
- Remove support for
amount_excluding_tax
andunit_amount_excluding_tax
onCreditNoteLineItem
andInvoiceLineItem
- Remove support for
coupon
onCustomerCreateParams
,CustomerUpdateParams
,InvoiceCreatePreviewParams.schedule_details.phases[]
,InvoiceCreatePreviewParams
,SubscriptionCreateParams
,SubscriptionSchedule.phases[]
,SubscriptionScheduleCreateParams.phases[]
,SubscriptionScheduleUpdateParams.phases[]
, andSubscriptionUpdateParams
- Remove support for
promotion_code
onCustomerCreateParams
,CustomerUpdateParams
,SubscriptionCreateParams
, andSubscriptionUpdateParams
- Remove support for
price
onInvoiceAddLinesParams.lines[]
,InvoiceItemCreateParams
,InvoiceItemUpdateParams
,InvoiceItem
,InvoiceLineItemUpdateParams
,InvoiceLineItem
, andInvoiceUpdateLinesParams.lines[]. Use
pricing` instead. - Remove support for
billing_thresholds
onInvoiceCreatePreviewParams.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
, andSubscription
- 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
, andtransfer_data
onInvoice
- Remove support for
discount
onInvoice
andSubscription
- Remove support for
invoice_item
,proration_details
,proration
,tax_rates
, andtype
onInvoiceLineItem
- Remove support for
plan
andsubscription_item
onInvoiceItem
andInvoiceLineItem
- Remove support for
unit_amount
onInvoiceItemCreateParams
,InvoiceItemUpdateParams
, andInvoiceItem
- Remove support for
subscription
andunit_amount_decimal
onInvoiceItem
- Remove support for
naver_pay
onPaymentMethodUpdateParams
- Remove support for
aggregate_usage
onPlanCreateParams
,Plan
,Price.recurring
, andPriceCreateParams.recurring
- Remove support for
current_period_end
andcurrent_period_start
onSubscription
page
has been removed from all V2 list method params (e.g.EventService.list()
); use the auto paginator or thenext_page_url
andprevious_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
, andPaymentIntentUpdateParams.payment_method_options.wechat_pay.client
to be optional - Change
political_exposure
on resourcesPerson
andToken
and paramsToken.CreateParams
from string to enum("existing" | "none")
Additions
- Add support for new resource
InvoicePayment
- Add support for
list
andretrieve
methods on resourceInvoicePayment
- Add support for
billie_payments
,nz_bank_account_becs_debit_payments
, andsatispay_payments
onAccount.capabilities
,AccountCreateParams.capabilities
, andAccountUpdateParams.capabilities
- Add support for
hosted_payment_method_save
onAccount.settings.invoices
andAccountUpdateParams.settings.invoices
- Add support for
invoices
onAccountCreateParams.settings
- Add support for new values
information_missing
,invalid_signator
,verification_failed_authorizer_authority
, andverification_rejected_ownership_exemption_reason
on enumsAccount.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
, andBankAccount.requirements.errors[].code
- Add support for new values
forwarding_api_retryable_upstream_error
andsetup_intent_mobile_wallet_unsupported
on enumsInvoice.last_finalization_error.code
,PaymentIntent.last_payment_error.code
,SetupAttempt.setup_error.code
,SetupIntent.last_setup_error.code
, andStripeError.code
- Add support for new values
stripe_balance_payment_debit_reversal
andstripe_balance_payment_debit
on enumBalanceTransaction.type
- Add support for new value
last
on enumsBilling.Meter.default_aggregation.formula
andBilling.MeterCreateParams.default_aggregation.formula
- Add support for
presentment_details
onCharge
,Checkout.Session
,PaymentIntent
, andRefund
- Add support for
billie
andsatispay
onCharge.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
, andSetupIntentUpdateParams.payment_method_data
- Add support for
nz_bank_account
onCharge.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
, andSetupIntentUpdateParams.payment_method_data
- Add support for
optional_items
onCheckout.SessionCreateParams
,Checkout.Session
,PaymentLinkCreateParams
, andPaymentLink
- Add support for
permissions
onCheckout.SessionCreateParams
andCheckout.Session
- Add support for new values
billie
andsatispay
on enumCheckout.SessionCreateParams.payment_method_types
- Add support for new value
custom
on enumsCheckout.Session.ui_mode
andCheckout.SessionCreateParams.ui_mode
- Add support for
shipping_options
onCheckout.SessionUpdateParams
- Add support for new values
billie
,nz_bank_account
, andsatispay
on enumsConfirmationTokenCreateParams.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
, andSetupIntentUpdateParams.payment_method_data.type
- Add support for
buyer_id
onConfirmationToken.payment_method_preview.naver_pay
,CustomerPaymentMethod.naver_pay
, andPaymentMethod.naver_pay
- Add support for new values
billie
,nz_bank_account
, andsatispay
on enumsConfirmationToken.payment_method_preview.type
,CustomerPaymentMethod.type
, andPaymentMethod.type
- Add support for
refunds
onCreditNoteCreateParams
,CreditNoteListPreviewLineItemsParams
,CreditNotePreviewParams
, andCreditNote
- Add support for
total_taxes
onCreditNote
andInvoice
- Add support for
taxes
onCreditNoteLineItem
andInvoiceLineItem
- Add support for
checkout_session
onCustomerBalanceTransaction
- Add support for new values
checkout_session_subscription_payment_canceled
andcheckout_session_subscription_payment
on enumCustomerBalanceTransaction.type
- Add support for new values
billie
,nz_bank_account
, andsatispay
on enumsCustomerPaymentMethodListParams.type
,PaymentMethodCreateParams.type
, andPaymentMethodListParams.type
- Add support for new value
invoice.overpaid
on enumEvent.type
- Add support for new values
klarna
andnz_bank_account
on enumsInvoice.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
, andSubscriptionUpdateParams.payment_settings.payment_method_types
- Add support for
pricing
onInvoiceAddLinesParams.lines[]
,InvoiceItemCreateParams
,InvoiceItemUpdateParams
,InvoiceItem
,InvoiceLineItemUpdateParams
,InvoiceLineItem
, andInvoiceUpdateLinesParams.lines[]
- Add support for
taxability_reason
onInvoiceAddLinesParams.lines[].tax_amounts[]
,InvoiceLineItemUpdateParams.tax_amounts[]
, andInvoiceUpdateLinesParams.lines[].tax_amounts[]
- Add support for
jurisdiction_level
onInvoiceAddLinesParams.lines[].tax_amounts[].tax_rate_data
,InvoiceLineItemUpdateParams.tax_amounts[].tax_rate_data
, andInvoiceUpdateLinesParams.lines[].tax_amounts[].tax_rate_data
- Add support for
amount_overpaid
,confirmation_secret
, andpayments
onInvoice
- Add support for
parent
onInvoiceItem
,InvoiceLineItem
, andInvoice
- Add support for new value
expired
on enumsIssuing.Authorization.status
andIssuing.AuthorizationListParams.status
- Add support for new value
network_fallback
on enumIssuing.Authorization.request_history[].reason
- Add support for
naver_pay
onMandate.payment_method_details
andSetupAttempt.payment_method_details
- Add support for
setup_future_usage
onPaymentIntent.payment_method_options.naver_pay
,PaymentIntentConfirmParams.payment_method_options.naver_pay
,PaymentIntentCreateParams.payment_method_options.naver_pay
, andPaymentIntentUpdateParams.payment_method_options.naver_pay
- Add support for new value
expired
on enumPaymentIntent.cancellation_reason
- Add support for
default_value
onPaymentLink.custom_fields[].dropdown
,PaymentLink.custom_fields[].numeric
,PaymentLink.custom_fields[].text
,PaymentLinkCreateParams.custom_fields[].dropdown
,PaymentLinkCreateParams.custom_fields[].numeric
,PaymentLinkCreateParams.custom_fields[].text
,PaymentLinkUpdateParams.custom_fields[].dropdown
,PaymentLinkUpdateParams.custom_fields[].numeric
, andPaymentLinkUpdateParams.custom_fields[].text
- Add support for new values
billie
andsatispay
on enumsPaymentLink.payment_method_types
,PaymentLinkCreateParams.payment_method_types
, andPaymentLinkUpdateParams.payment_method_types
- Add support for
nz_bank_transfer
onRefund.destination_details
- Add support for new value
canceled
on enumReview.closed_reason
- Add support for
current_period_end
andcurrent_period_start
onSubscriptionItem
- Add support for
wifi
onTerminal.ConfigurationCreateParams
,Terminal.ConfigurationUpdateParams
, andTerminal.Configuration
- Add support for new value
invoice.overpaid
on enumsWebhookEndpointCreateParams.enabled_events
andWebhookEndpointUpdateParams.enabled_events
- Add support for new values
2025-03-01.dashboard
and2025-03-31.basil
on enumWebhookEndpointCreateParams.api_version
- Remove support for resources