v31.4.0-alpha.4

• #2156 Update generated code for private-preview
  • Add support for new value spend_threshold on enums billing.AlertCreateParams.alertType and billing.AlertListParams.alertType
  • Add support for spendThreshold on billing.AlertCreateParams and billing.Alert
  • Add support for invoiceItem, prorationDetails, proration, and subscription on InvoiceLineItem.parent.schedule_details
  • Add support for custom on PaymentMethodUpdateParams
  • Add support for paymentMethodReference and usage on PaymentMethod.custom
  • Add support for outstandingUsageThrough and unusedTimeFrom on SubscriptionPauseParams.bill_for
  • ⚠️ Remove support for outstandingUsage and unusedTime on SubscriptionPauseParams.bill_for
  • ⚠️ Remove support for paymentBehavior on SubscriptionResumeParams

See the changelog for more details.

v31.4.0-alpha.3

• #2154 Update generated code for private-preview
  • Add support for new resources v2.billing.CadenceSpendModifier, v2.billing.OneTimeItem, and v2.billing.RateCardCustomPricingUnitOverageRate
  • Add support for create, delete, list, and retrieve methods on resource v2.billing.RateCardCustomPricingUnitOverageRate
  • Add support for create, list, retrieve, and update methods on resource v2.billing.OneTimeItem
  • Add support for retrieve method on resource v2.billing.CadenceSpendModifier
  • Add support for settlementType on ApplicationFee
  • Add support for rateCardCustomPricingUnitOverageRateDetails on InvoiceItem.pricing and InvoiceLineItem.pricing
  • Add support for defaultSettings on InvoiceCreatePreviewParams.schedule_details
  • Change type of QuoteUpdateParams.subscription_data_overrides[].billingSchedules from emptyable(array(billing_schedules_update_specs)) to array(billing_schedules_update_specs)
  • Add support for paymentBehavior on SubscriptionResumeParams
  • Add support for effectiveAt and spendModifierRule on v2.billing.IntentAction.apply, v2.billing.IntentAction.remove, v2.billing.IntentCreateParams.actions[].apply, and v2.billing.IntentCreateParams.actions[].remove
  • Change type of v2.billing.IntentAction.apply.type, v2.billing.IntentAction.remove.type, v2.billing.IntentCreateParams.actions[].apply.type, and v2.billing.IntentCreateParams.actions[].remove.type from literal('invoice_discount_rule') to enum('invoice_discount_rule'|'spend_modifier_rule')
  • Change EventsV2CoreHealthFraudRateIncreasedEvent.impact.realized_fraud_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent.impact.approved_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent.impact.declined_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent.impact.approved_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent.impact.declined_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.impact.approved_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.impact.declined_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.impact.approved_amount.value, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.impact.declined_amount.value, v2.FinancialAddressCreditSimulationCreditParams.amount.value, v2.billing.ServiceActionCreateParams.credit_grant.amount.monetary.value, v2.billing.ServiceActionCreateParams.credit_grant_per_tenant.amount.monetary.value, v2.core.AccountCreateParams.identity.business_details.annual_revenue.amount.value, v2.core.AccountCreateParams.identity.business_details.monthly_estimated_revenue.amount.value, v2.core.AccountTokenCreateParams.identity.business_details.annual_revenue.amount.value, v2.core.AccountTokenCreateParams.identity.business_details.monthly_estimated_revenue.amount.value, v2.core.AccountUpdateParams.identity.business_details.annual_revenue.amount.value, v2.core.AccountUpdateParams.identity.business_details.monthly_estimated_revenue.amount.value, v2.moneymanagement.CurrencyConversionCreateParams.from.amount.value, v2.moneymanagement.CurrencyConversionCreateParams.to.amount.value, v2.moneymanagement.InboundTransferCreateParams.amount.value, v2.moneymanagement.OutboundPaymentCreateParams.amount.value, v2.moneymanagement.OutboundPaymentQuoteCreateParams.amount.value, v2.moneymanagement.OutboundTransferCreateParams.amount.value, v2.payments.OffSessionPaymentCreateParams.amount.value, v2.payments.SettlementAllocationIntentCreateParams.amount.value, v2.payments.SettlementAllocationIntentSplitCreateParams.amount.value, and v2.payments.SettlementAllocationIntentUpdateParams.amount.value to be required
  • Change EventsV2CoreHealthFraudRateIncreasedEvent.impact.realized_fraud_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent.impact.approved_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent.impact.declined_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent.impact.approved_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent.impact.declined_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.impact.approved_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.impact.declined_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.impact.approved_amount.currency, EventsV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.impact.declined_amount.currency, v2.FinancialAddressCreditSimulationCreditParams.amount.currency, v2.billing.ServiceActionCreateParams.credit_grant.amount.monetary.currency, v2.billing.ServiceActionCreateParams.credit_grant_per_tenant.amount.monetary.currency, v2.core.AccountCreateParams.identity.business_details.annual_revenue.amount.currency, v2.core.AccountCreateParams.identity.business_details.monthly_estimated_revenue.amount.currency, v2.core.AccountTokenCreateParams.identity.business_details.annual_revenue.amount.currency, v2.core.AccountTokenCreateParams.identity.business_details.monthly_estimated_revenue.amount.currency, v2.core.AccountUpdateParams.identity.business_details.annual_revenue.amount.currency, v2.core.AccountUpdateParams.identity.business_details.monthly_estimated_revenue.amount.currency, v2.moneymanagement.CurrencyConversionCreateParams.from.amount.currency, v2.moneymanagement.CurrencyConversionCreateParams.to.amount.currency, v2.moneymanagement.InboundTransferCreateParams.amount.currency, v2.moneymanagement.OutboundPaymentCreateParams.amount.currency, v2.moneymanagement.OutboundPaymentQuoteCreateParams.amount.currency, v2.moneymanagement.OutboundTransferCreateParams.amount.currency, v2.payments.OffSessionPaymentCreateParams.amount.currency, v2.payments.SettlementAllocationIntentCreateParams.amount.currency, v2.payments.SettlementAllocationIntentSplitCreateParams.amount.currency, and v2.payments.SettlementAllocationIntentUpdateParams.amount.currency to be required

See the changelog for more details.

v31.4.0-alpha.2

• #2151 Update generated code for private-preview
  • Add support for new resource v2.core.ConnectionSession
  • Add support for create and retrieve methods on resource v2.core.ConnectionSession
  • Add support for list method on resources v2.payments.SettlementAllocationIntentSplit and v2.payments.SettlementAllocationIntent
  • Add support for agenticCommerceSettings on AccountSessionCreateParams.components
  • Add support for terminalHardwareOrders and terminalHardwareShop on AccountSession.components and AccountSessionCreateParams.components
  • Add support for networkCostPassthroughReport on AccountSession.components
  • Add support for cadenceData on v2.billing.IntentCreateParams and v2.billing.Intent
  • Add support for cancellationDetails on v2.billing.IntentAction.deactivate, v2.billing.IntentCreateParams.actions[].deactivate, and v2.billing.PricingPlanSubscription
  • Add support for contactPhone on v2.core.AccountCreateParams, v2.core.AccountTokenCreateParams, v2.core.AccountUpdateParams, and v2.core.Account
  • Add support for registrationDate on v2.core.Account.identity.business_details, v2.core.AccountCreateParams.identity.business_details, v2.core.AccountTokenCreateParams.identity.business_details, and v2.core.AccountUpdateParams.identity.business_details
  • Add support for reference on v2.moneymanagement.Adjustment
  • Add support for accruedFees on v2.moneymanagement.FinancialAccount
  • Add support for startingBalance on v2.moneymanagement.FinancialAccount.payments
  • Add support for accountHolderAddress and accountHolderName on v2.moneymanagement.FinancialAddress.credentials.us_bank_account
  • Add support for fingerprint on v2.moneymanagement.PayoutMethod.card
  • Add support for cardSpend on v2.moneymanagement.ReceivedCredit and v2.moneymanagement.ReceivedDebit
  • Add support for applicationFeeRefund, applicationFee, charge, dispute, payout, refund, reserveHold, reserveRelease, topup, transferReversal, and transfer on v2.moneymanagement.Transaction.flow and v2.moneymanagement.TransactionEntry.transaction_details.flow
  • Add support for new value accrued_fees on enum v2.moneymanagement.FinancialAccountListParams.types
  • Add support for new value gb_vat on enums v2.core.AccountCreateParams.identity.business_details.id_numbers[].type, v2.core.AccountTokenCreateParams.identity.business_details.id_numbers[].type, and v2.core.AccountUpdateParams.identity.business_details.id_numbers[].type
  • Change v2.billing.RateCardRateCreateParams.meteredItem to be required

See the changelog for more details.

v31.4.0-beta.1

This release changes the pinned API version to 2026-01-28.preview.

• #2145 Update generated code for beta
  • Add support for new resource financialconnections.Authorization
  • Add support for retrieve method on resource financialconnections.Authorization
  • Add support for detach_payment method on resource Invoice
  • Remove support for cancel, list_line_items, and reopen methods on resource Order
  • Remove support for attach_cadence method on resource Subscription
  • Add support for additionalFiles and site on Account.settings.paypay_payments, AccountCreateParams.settings.paypay_payments, and AccountUpdateParams.settings.paypay_payments
  • Remove support for capital on Account.settings
  • Add support for authorization and statusDetails on financialconnections.Account
  • Add support for relinkOptions on financialconnections.SessionCreateParams and financialconnections.Session
  • Change financialconnections.SessionCreateParams.accountHolder to be optional
  • Add support for relinkResult on financialconnections.Session
  • Remove support for billingCadence on InvoiceCreatePreviewParams, SubscriptionCreateParams, SubscriptionUpdateParams, and Subscription
  • Remove support for billingCadenceDetails on Invoice.parent and QuotePreviewInvoice.parent
  • Add support for new value pl_nip on enums OrderCreateParams.tax_details.tax_ids[].type and OrderUpdateParams.tax_details.tax_ids[].type
  • Add support for carRentalData, flightData, and lodgingData on PaymentIntent.payment_details
  • Add support for new value capital.financing_summary.line_of_credit_update on enums WebhookEndpointCreateParams.enabledEvents and WebhookEndpointUpdateParams.enabledEvents
  • Add support for alternativeReference on v2.core.vault.GbBankAccount, v2.core.vault.UsBankAccount, and v2.moneymanagement.PayoutMethod
  • Add support for accountHolderAddress and accountHolderName on v2.moneymanagement.FinancialAddress.credentials.us_bank_account
  • Add support for fingerprint on v2.moneymanagement.PayoutMethod.card
  • Add support for snapshot event invoice_payment.detached with resource InvoicePayment
• #2129 Add EventNotificationHandler example

See the changelog for more details.

v31.4.0-alpha.1

This release changes the pinned API version to 2026-01-28.preview.

• #2148 Update generated code for private-preview
  • Add support for new resources FrMealVouchersOnboarding, reserve.Hold, reserve.Plan, and reserve.Release
  • Add support for create, list, retrieve, and update methods on resource FrMealVouchersOnboarding
  • Add support for list and retrieve methods on resources reserve.Hold and reserve.Release
  • Add support for retrieve method on resource reserve.Plan
  • Add support for pause method on resource Subscription
  • Add support for servicePeriodDetails on Discount
  • Add support for agenticCommerceSettings on AccountSession.components
  • Add support for new value service_period on enums CouponCreateParams.duration, checkout.SessionCreateParams.discounts[].coupon_data.duration, and checkout.SessionUpdateParams.discounts[].coupon_data.duration
  • Add support for servicePeriod on CouponCreateParams and Coupon
  • Change type of InvoiceItem.pricing.price_details.price and InvoiceLineItem.pricing.price_details.price from string to expandable($Price)
  • Add support for settings on InvoiceCreatePreviewParams.discounts[], InvoiceCreatePreviewParams.schedule_details.amendments[].discount_actions[].add, InvoiceCreatePreviewParams.schedule_details.amendments[].discount_actions[].set, InvoiceCreatePreviewParams.schedule_details.amendments[].item_actions[].add.discounts[], InvoiceCreatePreviewParams.schedule_details.amendments[].item_actions[].set.discounts[], InvoiceCreatePreviewParams.schedule_details.phases[].discounts[], InvoiceCreatePreviewParams.schedule_details.phases[].items[].discounts[], InvoiceCreatePreviewParams.subscription_details.items[].discounts[], QuoteCreateParams.lines[].actions[].add_discount, QuoteCreateParams.lines[].actions[].add_item.discounts[], QuoteCreateParams.lines[].actions[].set_discounts[], QuoteCreateParams.lines[].actions[].set_items[].discounts[], QuoteUpdateParams.lines[].actions[].add_discount, QuoteUpdateParams.lines[].actions[].add_item.discounts[], QuoteUpdateParams.lines[].actions[].set_discounts[], QuoteUpdateParams.lines[].actions[].set_items[].discounts[], SubscriptionCreateParams.discounts[], SubscriptionCreateParams.items[].discounts[], SubscriptionItemCreateParams.discounts[], SubscriptionItemUpdateParams.discounts[], SubscriptionScheduleAmendParams.amendments[].discount_actions[].add, SubscriptionScheduleAmendParams.amendments[].discount_actions[].set, SubscriptionScheduleAmendParams.amendments[].item_actions[].add.discounts[], SubscriptionScheduleAmendParams.amendments[].item_actions[].set.discounts[], SubscriptionScheduleCreateParams.phases[].discounts[], SubscriptionScheduleCreateParams.phases[].items[].discounts[], SubscriptionScheduleUpdateParams.phases[].discounts[], SubscriptionScheduleUpdateParams.phases[].items[].discounts[], SubscriptionUpdateParams.discounts[], and SubscriptionUpdateParams.items[].discounts[]
  • Add support for subtotal on InvoiceLineItem
  • Add support for billingCadence on SubscriptionListParams

See the changelog for more details.

v31.3.0

This release changes the pinned API version to 2026-01-28.clover.

• #2147 Update generated code
  • Add support for new resource radar.PaymentEvaluation
  • Add support for create method on resource radar.PaymentEvaluation
  • Add support for adjustableQuantity on LineItem
  • Add support for new value adyen on enums ConfirmationTokenCreateParams.payment_method_data.ideal.bank, PaymentIntentConfirmParams.payment_method_data.ideal.bank, PaymentIntentCreateParams.payment_method_data.ideal.bank, PaymentIntentUpdateParams.payment_method_data.ideal.bank, PaymentMethodCreateParams.ideal.bank, SetupIntentConfirmParams.payment_method_data.ideal.bank, SetupIntentCreateParams.payment_method_data.ideal.bank, and SetupIntentUpdateParams.payment_method_data.ideal.bank
  • Add support for new value pl_nip on enums CustomerCreateParams.tax_id_data[].type, InvoiceCreatePreviewParams.customer_details.tax_ids[].type, TaxIdCreateParams.type, and tax.CalculationCreateParams.customer_details.tax_ids[].type
  • Add support for enforceArithmeticValidation on PaymentIntentCaptureParams.amount_details, PaymentIntentConfirmParams.amount_details, PaymentIntentCreateParams.amount_details, PaymentIntentIncrementAuthorizationParams.amount_details, and PaymentIntentUpdateParams.amount_details
  • Add support for new values 2.3.0 and 2.3.1 on enums PaymentIntentConfirmParams.payment_method_options.card.three_d_secure.version, PaymentIntentCreateParams.payment_method_options.card.three_d_secure.version, PaymentIntentUpdateParams.payment_method_options.card.three_d_secure.version, SetupIntentConfirmParams.payment_method_options.card.three_d_secure.version, SetupIntentCreateParams.payment_method_options.card.three_d_secure.version, and SetupIntentUpdateParams.payment_method_options.card.three_d_secure.version
  • Add support for error on PaymentIntent.amount_details
  • Remove support for bgn on terminal.Configuration.tipping, terminal.ConfigurationCreateParams.tipping, and terminal.ConfigurationUpdateParams.tipping
  • Add support for topup on treasury.ReceivedDebit.linked_flows
  • Add support for contactPhone on v2.core.AccountCreateParams, v2.core.AccountTokenCreateParams, v2.core.AccountUpdateParams, and v2.core.Account
  • Add support for registrationDate on v2.core.Account.identity.business_details, v2.core.AccountCreateParams.identity.business_details, v2.core.AccountTokenCreateParams.identity.business_details, and v2.core.AccountUpdateParams.identity.business_details
  • Add support for new value gb_vat on enums v2.core.AccountCreateParams.identity.business_details.id_numbers[].type, v2.core.AccountTokenCreateParams.identity.business_details.id_numbers[].type, and v2.core.AccountUpdateParams.identity.business_details.id_numbers[].type

See the changelog for more details.

v31.3.0-alpha.1

• #2146 Update generated code for private-preview
  • Remove support for pause method on resource Subscription

See the changelog for more details.

v31.2.0

• #2144 Update generated code
  • Add support for event notifications V2CoreAccountClosedEvent, V2CoreAccountCreatedEvent, V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationCustomerUpdatedEvent, V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationMerchantUpdatedEvent, V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationRecipientUpdatedEvent, V2CoreAccountIncludingDefaultsUpdatedEvent, V2CoreAccountIncludingFutureRequirementsUpdatedEvent, V2CoreAccountIncludingIdentityUpdatedEvent, V2CoreAccountIncludingRequirementsUpdatedEvent, and V2CoreAccountUpdatedEvent with related object v2.core.Account
  • Add support for event notification V2CoreAccountLinkReturnedEvent
  • Add support for event notifications V2CoreAccountPersonCreatedEvent, V2CoreAccountPersonDeletedEvent, and V2CoreAccountPersonUpdatedEvent with related object v2.core.AccountPerson

See the changelog for more details.

v31.2.0-alpha.3

• #2143 Update generated code for private-preview
  • Add support for riskDetails on delegatedcheckout.RequestedSession
  • Remove support for description, images, and name on delegatedcheckout.RequestedSession.line_item_details[]
  • Add support for name on productcatalog.TrialOfferCreateParams and productcatalog.TrialOffer
  • Add support for loginFailed and registrationFailed on radar.AccountEvaluation.events[] and radar.AccountEvaluationUpdateParams
  • Change type of radar.AccountEvaluationUpdateParams.type from literal('registration_succeeded') to enum('login_failed'|'login_succeeded'|'registration_failed'|'registration_succeeded')

See the changelog for more details.

v31.2.0-alpha.2

• #2135 Update generated code for private-preview
  • Add support for trackingDetails on v2.moneymanagement.OutboundPayment
  • Add support for paperCheck on v2.moneymanagement.OutboundPayment.delivery_options and v2.moneymanagement.OutboundPaymentCreateParams.delivery_options
  • Add support for event notification V2CoreAccountIncludingFutureRequirementsUpdatedEvent with related object v2.core.Account
• #2127 Update generated code for private-preview
  • Add support for new resource tax.Location
  • Add support for create, list, and retrieve methods on resource tax.Location
  • Add support for pause method on resource Subscription
  • Add support for performanceLocation on InvoiceAddLinesParams.lines[].price_data.product_data.tax_details, InvoiceLineItemUpdateParams.price_data.product_data.tax_details, InvoiceUpdateLinesParams.lines[].price_data.product_data.tax_details, PaymentLinkCreateParams.line_items[].price_data.product_data.tax_details, ProductCreateParams.tax_details, ProductUpdateParams.tax_details, checkout.SessionCreateParams.line_items[].price_data.product_data.tax_details, checkout.SessionUpdateParams.line_items[].price_data.product_data.tax_details, tax.CalculationCreateParams.line_items[], and tax.CalculationLineItem
  • Change type of delegatedcheckout.RequestedSessionUpdateParams.metadata from map(string: string) to emptyable(map(string: string))
  • Change type of delegatedcheckout.RequestedSessionUpdateParams.paymentMethodData from payment_method_data to emptyable(payment_method_data)
  • Change type of delegatedcheckout.RequestedSessionUpdateParams.sharedMetadata from map(string: string) to emptyable(map(string: string))
  • Add support for subscription on Invoice.parent.schedule_details and QuotePreviewInvoice.parent.schedule_details
  • Change type of PaymentIntentConfirmParams.payment_details.benefit.frMealVoucher, PaymentIntentCreateParams.payment_details.benefit.frMealVoucher, PaymentIntentUpdateParams.payment_details.benefit.frMealVoucher, SetupIntentConfirmParams.setup_details.benefit.frMealVoucher, SetupIntentCreateParams.setup_details.benefit.frMealVoucher, and SetupIntentUpdateParams.setup_details.benefit.frMealVoucher from payment_details_benefit_fr_meal_voucher to emptyable(payment_details_benefit_fr_meal_voucher)
  • Add support for taxDetails on PlanCreateParams.product[0] and PriceCreateParams.product_data
  • Add support for externalReference on Plan and Price
  • Add support for new value phase_start on enums QuoteCreateParams.subscription_data.phaseEffectiveAt, QuoteCreateParams.subscription_data_overrides[].phaseEffectiveAt, QuoteUpdateParams.subscription_data.phaseEffectiveAt, and QuoteUpdateParams.subscription_data_overrides[].phaseEffectiveAt
  • Remove support for value line_start from enums QuoteCreateParams.subscription_data.phaseEffectiveAt, QuoteCreateParams.subscription_data_overrides[].phaseEffectiveAt, QuoteUpdateParams.subscription_data.phaseEffectiveAt, and QuoteUpdateParams.subscription_data_overrides[].phaseEffectiveAt
  • Add support for new values admissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, luxury_tax, resort_tax, and tourism_tax on enum tax.RegistrationCreateParams.country_options.us.type
  • Add support for admissionsTax, attendanceTax, entertainmentTax, grossReceiptsTax, hospitalityTax, luxuryTax, resortTax, and tourismTax on tax.Registration.country_options.us
  • Add support for requirements on TaxCode

See the changelog for more details.