-
#1950 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
create
method on resourceSubscriptionItemUsageRecord
- Remove support for
list
method on resourceSubscriptionItemUsageRecordSummary
- Remove support for
upcomingLines
andupcoming
methods on resourceInvoice
- Remove support for
invoice
onCharge
andPaymentIntent
- Remove support for
shippingDetails
onCheckout.Session
- Remove support for
carrier
,phone
, andtrackingNumber
onCheckout.Session.collected_information.shipping_details
- Remove support for
refund
onCreditNoteCreateParams
,CreditNotePreviewLinesListParams
,CreditNotePreviewParams
, andCreditNote
- Remove support for
taxAmounts
onCreditNoteLineItem
,CreditNote
, andInvoiceLineItem
- Remove support for
amountExcludingTax
andunitAmountExcludingTax
onCreditNoteLineItem
andInvoiceLineItem
- Remove support for
coupon
onCustomerCreateParams
,CustomerUpdateParams
,InvoiceCreatePreviewParams.schedule_details.phases[]
,InvoiceCreatePreviewParams
,SubscriptionCreateParams
,SubscriptionSchedule.phases[]
,SubscriptionScheduleCreateParams.phases[]
,SubscriptionScheduleUpdateParams.phases[]
, andSubscriptionUpdateParams
- Remove support for
promotionCode
onCustomerCreateParams
,CustomerUpdateParams
,SubscriptionCreateParams
, andSubscriptionUpdateParams
- Remove support for
price
onInvoiceAddLinesParams.lines[]
,InvoiceItemCreateParams
,InvoiceItemUpdateParams
,InvoiceItem
,InvoiceLineItemUpdateParams
,InvoiceLineItem
, andInvoiceUpdateLinesParams.lines[]
- Remove support for
billingThresholds
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
applicationFeeAmount
,charge
,paidOutOfBand
,paid
,paymentIntent
,quote
,subscription
,subscriptionDetails
,subscriptionProrationDate
,tax
,totalTaxAmounts
, andtransferData
onInvoice
- Remove support for
discount
onInvoice
andSubscription
- Remove support for
invoiceItem
,prorationDetails
,proration
,taxRates
, andtype
onInvoiceLineItem
- Remove support for
plan
andsubscriptionItem
onInvoiceItem
andInvoiceLineItem
- Remove support for
unitAmount
onInvoiceItemCreateParams
,InvoiceItemUpdateParams
, andInvoiceItem
- Remove support for
subscription
andunitAmountDecimal
onInvoiceItem
- Remove support for
naverPay
onPaymentMethodUpdateParams
- Remove support for
aggregateUsage
onPlanCreateParams
,Plan
,Price.recurring
, andPriceCreateParams.recurring
- Remove support for
currentPeriodEnd
andcurrentPeriodStart
onSubscription
- Remove support for page on
V2.EventDestinationListParams
andV2.EventListParams
Changes to the Stripe API
- 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
politicalExposure
onAccountPersonUpdateParams
,AccountPersonCreateParams
fromstring
toPoliticalExposure
enum.
Additions to the Stripe API
- Add support for new resource
InvoicePayment
- Add support for
list
andretrieve
methods on resourceInvoicePayment
- Add support for
billiePayments
,nzBankAccountBecsDebitPayments
, andsatispayPayments
onAccount.capabilities
,AccountCreateParams.capabilities
, andAccountUpdateParams.capabilities
- Add support for
hostedPaymentMethodSave
onAccount.settings.invoices
andAccountUpdateParams.settings.invoices
- Add support for
invoices
onAccountCreateParams.settings
- Add support for new value
last
on enumbilling.MeterCreateParams.default_aggregation.formula
- Add support for
presentmentDetails
onCharge
,Checkout.Session
,PaymentIntent
, andRefund
- Add support for
billie
andsatispay
onCharge.payment_method_details
,ConfirmationToken.payment_method_preview
,ConfirmationTokenCreateParams.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
nzBankAccount
onCharge.payment_method_details
,ConfirmationToken.payment_method_preview
,ConfirmationTokenCreateParams.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
optionalItems
onCheckout.Session
,PaymentLinkCreateParams
,PaymentLink
, andcheckout.SessionCreateParams
- Add support for
permissions
onCheckout.Session
andcheckout.SessionCreateParams
- Add support for new values
billie
andsatispay
on enumcheckout.SessionCreateParams.paymentMethodTypes
- Add support for new value
custom
on enumcheckout.SessionCreateParams.uiMode
- Add support for
shippingOptions
oncheckout.SessionUpdateParams
- Add support for new values
billie
,nz_bank_account
, andsatispay
on enumsConfirmationTokenCreateParams.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
buyerId
onConfirmationToken.payment_method_preview.naver_pay
,CustomerPaymentMethod.naver_pay
, andPaymentMethod.naver_pay
- Add support for
refunds
onCreditNoteCreateParams
,CreditNotePreviewLinesListParams
,CreditNotePreviewParams
, andCreditNote
- Add support for
totalTaxes
onCreditNote
andInvoice
- Add support for
taxes
onCreditNoteLineItem
andInvoiceLineItem
- Add support for
taxabilityReason
onInvoiceAddLinesParams.lines[].tax_amounts[]
,InvoiceLineItemUpdateParams.tax_amounts[]
, andInvoiceUpdateLinesParams.lines[].tax_amounts[]
- Add support for
jurisdictionLevel
onInvoiceAddLinesParams.lines[].tax_amounts[].tax_rate_data
,InvoiceLineItemUpdateParams.tax_amounts[].tax_rate_data
, andInvoiceUpdateLinesParams.lines[].tax_amounts[].tax_rate_data
- Add support for
amountOverpaid
,confirmationSecret
, andpayments
onInvoice
- Add support for
parent
onInvoiceItem
,InvoiceLineItem
, andInvoice
- Add support for new values
klarna
andnz_bank_account
on enumsInvoiceCreateParams.payment_settings.paymentMethodTypes
,InvoiceUpdateParams.payment_settings.paymentMethodTypes
,SubscriptionCreateParams.payment_settings.paymentMethodTypes
, andSubscriptionUpdateParams.payment_settings.paymentMethodTypes
- Add support for
pricing
onInvoiceAddLinesParams.lines[]
,InvoiceItemCreateParams
,InvoiceItemUpdateParams
,InvoiceItem
,InvoiceLineItemUpdateParams
,InvoiceLineItem
, andInvoiceUpdateLinesParams.lines[]
- Add support for
taxabilityReason
onInvoiceAddLinesParams.lines[].tax_amounts[]
,InvoiceLineItemUpdateParams.tax_amounts[]
, andInvoiceUpdateLinesParams.lines[].tax_amounts[]
- Add support for
defaultValue
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 enumsPaymentLinkCreateParams.paymentMethodTypes
andPaymentLinkUpdateParams.paymentMethodTypes
- Add support for
nzBankTransfer
onRefund.destination_details
- Add support for
currentPeriodEnd
andcurrentPeriodStart
onSubscriptionItem
- Add support for
wifi
onTerminal.Configuration
,terminal.ConfigurationCreateParams
, andterminal.ConfigurationUpdateParams
- Add support for new value
invoice.overpaid
on enumsWebhookEndpointCreateParams.enabledEvents
andWebhookEndpointUpdateParams.enabledEvents
- Add support for new values
2025-03-01.dashboard
and2025-03-31.basil
on enumWebhookEndpointCreateParams.apiVersion
- Remove support for resources
-
#1958 Support for StripeAccount in StripeClient, and StripeContext on V1
- ⚠️ Adds
getStripeAccount
toStripeResponseGetterOptions
. If you have a class that extendsStripeResponseGetterOptions
you will need to implement this method. - Adds
setStripeAccount
to StripeClientBuilder, so you can specify the Stripe-Account header at the client (instead of the individual request) level.
- ⚠️ Adds
-
#1955 Add @EqualsAndHashCode annotations
- Adds
@EqualsAndHashCode(callSuper = false)
to all Params objects which is useful for unit test assertions and caching scenarios.
- Adds