This release changes the pinned API version to 2026-04-22.private.
- #1795 Update generated code for private-preview
- Add support for new resources
v2.commerce.ProductCatalogImport,v2.core.ApprovalRequest,v2.extend.WorkflowRun,v2.extend.Workflow,v2.iam.ActivityLog,v2.network.BusinessProfile, andv2.orchestrated_commerce.Agreement - ⚠️ Remove support for resources
v2.core.WorkflowRunandv2.core.Workflow - Add support for
confirm,create,list,retrieve, andterminatemethods on resourcev2.orchestrated_commerce.Agreement - Add support for
meandretrievemethods on resourcev2.network.BusinessProfile - Add support for
listmethod on resourcev2.iam.ActivityLog - Add support for
listandretrievemethods on resourcev2.extend.WorkflowRun - Add support for
invoke,list, andretrievemethods on resourcev2.extend.Workflow - Add support for
cancel,execute,list,retrieve, andsubmitmethods on resourcev2.core.ApprovalRequest - Add support for
createandretrievemethods on resourcev2.commerce.ProductCatalogImport - ⚠️ Remove support for
listandretrievemethods on resourcev2.core.WorkflowRun - ⚠️ Remove support for
invoke,list, andretrievemethods on resourcev2.core.Workflow - Add support for
renew_onboarding_linkmethod on resourcev2.core.ClaimableSandbox - ⚠️ Remove support for
customeronSharedPayment.IssuedToken - Change type of
SharedPayment.IssuedToken.payment_methodfromnullable(string)tostring - Add support for
bill_managementandsend_moneyonAccountSession.Component.Bill.Feature - Add support for
gift_cardonCharge.PaymentMethodDetail,PaymentAttemptRecord.PaymentMethodDetail, andPaymentRecord.PaymentMethodDetail - Add support for
custom_payment_method_typesonCheckout.Sessionandcheckout.SessionCreateParams - Add support for
payment_recordonCheckout.Session - ⚠️ Remove support for
shared_payment_granted_tokenonConfirmationTokenCreateParamsPaymentMethodDatum,PaymentIntentConfirmParamsPaymentMethodDatum,PaymentIntentCreateParamsPaymentMethodDatum,PaymentIntentModifyParamsPaymentMethodDatum,PaymentIntent,PaymentMethod,SetupIntentConfirmParamsPaymentMethodDatum,SetupIntentCreateParamsPaymentMethodDatum, andSetupIntentModifyParamsPaymentMethodDatum - Add support for
payment_methodonConfirmationToken.PaymentMethodPreview.SepaDebit.GeneratedFrom,PaymentMethod.SepaDebit.GeneratedFrom, andSharedPayment.GrantedToken.PaymentMethodDetail.SepaDebit.GeneratedFrom - ⚠️ Change type of
DelegatedCheckout.RequestedSession.FulfillmentDetail.FulfillmentOption.type,DelegatedCheckout.RequestedSession.FulfillmentDetail.SelectedFulfillmentOption.type,DelegatedCheckout.RequestedSession.FulfillmentDetail.SelectedFulfillmentOptionOverride.type,delegated_checkout.RequestedSessionModifyParamsFulfillmentDetailSelectedFulfillmentOption.type, anddelegated_checkout.RequestedSessionModifyParamsFulfillmentDetailSelectedFulfillmentOptionOverride.typefromstringtoenum('digital'|'shipping') - Add support for
return_urlondelegated_checkout.RequestedSessionConfirmParams - Add support for
buyer_consentsonDelegatedCheckout.RequestedSession - Add support for
crypto_transactionsonIssuing.Authorization,Issuing.Dispute, andIssuing.Transaction - Add support for
payment_facilitator_idandsub_merchant_idonIssuing.Authorization.MerchantDatumandIssuing.Transaction.MerchantDatum - Add support for
identifiersonOrderCreateParamsLineItemProductDatum,OrderModifyParamsLineItemProductDatum,ProductCreateParams,ProductModifyParams, andProduct - Add support for
agent_detailsonPaymentIntent - Add support for
external_referenceonPriceCreateParamsandPriceModifyParams - Add support for
login_succeededandregistration_succeededonRadar.AccountEvaluation.Eventandradar.AccountEvaluationModifyParams - Add support for
print_contentonTerminal.Reader.Action - ⚠️ Add support for new value
print_contenton enumTerminal.Reader.Action.type - ⚠️ Add support for new values
cn_bank_accountandjp_bank_accounton enumV2.Core.Account.Configuration.Recipient.DefaultOutboundDestination.type - ⚠️ Add support for new values
bm_crn,bo_tin,bt_tpn,co_nit,ec_ruc,eg_tin,gh_tin,gy_tin,hn_rtn,jm_trn,jo_crn,ke_pin,ky_crn,lk_tin,mo_tin,mv_tin,ng_tin,pa_ruc,ph_tin,py_ruc,sl_tin,sv_nit,uy_ruc,vg_cn, andza_tinon enumV2.Core.Account.Identity.BusinessDetail.IdNumber.type - ⚠️ Add support for new values
bm_pp,bo_ci,bt_cid,eg_tin,gh_pin,gy_tin,hn_rtn,jm_trn,jo_pin,ky_pp,lk_nic,mo_bir,mt_nic,mv_tin,pa_ruc,ph_tin,py_ruc,si_pin,sv_nit, andvg_ppon enumsV2.Core.Account.Identity.Individual.IdNumber.typeandV2.Core.AccountPerson.IdNumber.type - Add support for
app_channelonV2.Core.ClaimableSandboxandv2.core.ClaimableSandboxCreateParams - Add support for
onboarding_link_detailsandowner_detailsonV2.Core.ClaimableSandbox - ⚠️ Remove support for
claim_urlonV2.Core.ClaimableSandbox - ⚠️ Remove support for
owner_accountonV2.Core.ClaimableSandbox.SandboxDetail - ⚠️ Add support for new value
liveon enumV2.Core.ClaimableSandbox.status - Add support for
snapshot_eventonV2.Core.Event - ⚠️ Add support for new values
futsuandtozaon enumsV2.Core.Vault.GbBankAccount.bank_account_typeandV2.MoneyManagement.PayoutMethod.BankAccount.bank_account_type - ⚠️ Change
V2.MoneyManagement.CurrencyConversion.financial_accountto be optional - Add support for
multiprocessor_settlementonV2.MoneyManagement.FinancialAccount - ⚠️ Add support for new value
multiprocessor_settlementon enumV2.MoneyManagement.FinancialAccount.type - Add support for
ca_bank_accountonV2.MoneyManagement.FinancialAddress.CredentialandV2.MoneyManagement.ReceivedCredit.BankTransfer - ⚠️ Add support for new value
ca_bank_accounton enumV2.MoneyManagement.FinancialAddress.Credential.type - ⚠️ Add support for new value
tempoon enumV2.MoneyManagement.PayoutMethod.CryptoWallet.network - ⚠️ Add support for new value
ca_bank_accounton enumV2.MoneyManagement.ReceivedCredit.BankTransfer.origin_type - ⚠️ Remove support for value
returnfrom enumsV2.MoneyManagement.Transaction.categoryandV2.MoneyManagement.TransactionEntry.TransactionDetail.category - Add support for
amount_detailsandpayment_detailsonV2.Payments.OffSessionPayment,v2.payments.OffSessionPaymentCaptureParams, andv2.payments.OffSessionPaymentCreateParams - Add support for
descriptiononV2.Payments.OffSessionPaymentandv2.payments.OffSessionPaymentCreateParams - Add support for new value
acsson enumv2.FinancialAddressCreditSimulationCreditParams.network - Add support for
mcconv2.payments.OffSessionPaymentCreateParamsPaymentMethodOptionCard - Change
v2.payments.OffSessionPaymentCreateParamsPaymentMethodOptionCard.network_transaction_idto be optional - Add support for new values
futsuandtozaon enumsv2.core.vault.GbBankAccountCreateParams.bank_account_type,v2.money_management.OutboundSetupIntentCreateParamsPayoutMethodDatumBankAccount.bank_account_type, andv2.money_management.OutboundSetupIntentModifyParamsPayoutMethodDatumBankAccount.bank_account_type - Add support for new value
tempoon enumv2.money_management.OutboundSetupIntentCreateParamsPayoutMethodDatumCryptoWallet.network - Add support for new value
credentials.ca_bank_account.account_numberon enumsv2.money_management.FinancialAddressListParams.includeandv2.money_management.FinancialAddressRetrieveParams.include - Add support for new value
ca_bank_accounton enumv2.money_management.FinancialAddressCreateParams.type - Add support for new value
multiprocessor_settlementon enumv2.money_management.FinancialAccountListParams.types - Add support for
storageonv2.money_management.FinancialAccountModifyParams - Add support for
fx_quoteonv2.money_management.CurrencyConversionCreateParams - Change
v2.money_management.CurrencyConversionCreateParams.financial_accountto be optional - ⚠️ Add support for
onboarding_link_detailsonv2.core.ClaimableSandboxCreateParams - Change type of
v2.core.BatchJobCreateParamsEndpoint.http_methodfromliteral('post')toenum('delete'|'post') - Add support for new values
bm_crn,bo_tin,bt_tpn,co_nit,ec_ruc,eg_tin,gh_tin,gy_tin,hn_rtn,jm_trn,jo_crn,ke_pin,ky_crn,lk_tin,mo_tin,mv_tin,ng_tin,pa_ruc,ph_tin,py_ruc,sl_tin,sv_nit,uy_ruc,vg_cn, andza_tinon enumsv2.core.AccountCreateParamsIdentityBusinessDetailIdNumber.type,v2.core.AccountModifyParamsIdentityBusinessDetailIdNumber.type, andv2.core.AccountTokenCreateParamsIdentityBusinessDetailIdNumber.type - Add support for new values
bm_pp,bo_ci,bt_cid,eg_tin,gh_pin,gy_tin,hn_rtn,jm_trn,jo_pin,ky_pp,lk_nic,mo_bir,mt_nic,mv_tin,pa_ruc,ph_tin,py_ruc,si_pin,sv_nit, andvg_ppon enumsv2.core.AccountCreateParamsIdentityIndividualIdNumber.type,v2.core.AccountModifyParamsIdentityIndividualIdNumber.type,v2.core.AccountPersonCreateParamsIdNumber.type,v2.core.AccountPersonModifyParamsIdNumber.type,v2.core.AccountPersonTokenCreateParamsIdNumber.type, andv2.core.AccountTokenCreateParamsIdentityIndividualIdNumber.type - ⚠️ Add support for new value
meter_event_value_too_many_digitson enumsEventsV1BillingMeterErrorReportTriggeredEvent.Reason.ErrorType.codeandEventsV1BillingMeterNoMeterFoundEvent.Reason.ErrorType.code - Add support for
treasury_transactiononEventsV2MoneyManagementTransactionCreatedEvent - Add support for event notifications
V1AccountApplicationAuthorizedEvent,V1AccountApplicationDeauthorizedEvent,V1AccountExternalAccountCreatedEvent,V1AccountExternalAccountDeletedEvent,V1AccountExternalAccountUpdatedEvent,V1BillingPortalSessionCreatedEvent,V1EntitlementsActiveEntitlementSummaryUpdatedEvent,V2CoreHealthMeterEventSummariesDelayedFiringEvent, andV2CoreHealthMeterEventSummariesDelayedResolvedEvent - Add support for event notification
V1AccountUpdatedEventwith related objectAccount - Add support for event notifications
V1ApplicationFeeCreatedEventandV1ApplicationFeeRefundedEventwith related objectApplicationFee - Add support for event notification
V1ApplicationFeeRefundUpdatedEventwith related objectApplicationFeeRefund - Add support for event notification
V1BalanceAvailableEventwith related objectBalance - Add support for event notification
V1BillingAlertTriggeredEventwith related objectbilling.Alert - Add support for event notifications
V1BillingPortalConfigurationCreatedEventandV1BillingPortalConfigurationUpdatedEventwith related objectbilling_portal.Configuration - Add support for event notification
V1CapabilityUpdatedEventwith related objectCapability - Add support for event notification
V1CashBalanceFundsAvailableEventwith related objectCashBalance - Add support for event notifications
V1ChargeCapturedEvent,V1ChargeExpiredEvent,V1ChargeFailedEvent,V1ChargePendingEvent,V1ChargeRefundedEvent,V1ChargeSucceededEvent, andV1ChargeUpdatedEventwith related objectCharge - Add support for event notifications
V1ChargeDisputeClosedEvent,V1ChargeDisputeCreatedEvent,V1ChargeDisputeFundsReinstatedEvent,V1ChargeDisputeFundsWithdrawnEvent, andV1ChargeDisputeUpdatedEventwith related objectDispute - Add support for event notifications
V1ChargeRefundUpdatedEvent,V1RefundCreatedEvent,V1RefundFailedEvent, andV1RefundUpdatedEventwith related objectRefund - Add support for event notifications
V1CheckoutSessionAsyncPaymentFailedEvent,V1CheckoutSessionAsyncPaymentSucceededEvent,V1CheckoutSessionCompletedEvent, andV1CheckoutSessionExpiredEventwith related objectcheckout.Session - Add support for event notifications
V1ClimateOrderCanceledEvent,V1ClimateOrderCreatedEvent,V1ClimateOrderDelayedEvent,V1ClimateOrderDeliveredEvent, andV1ClimateOrderProductSubstitutedEventwith related objectclimate.Order - Add support for event notifications
V1ClimateProductCreatedEventandV1ClimateProductPricingUpdatedEventwith related objectclimate.Product - Add support for event notifications
V1CouponCreatedEvent,V1CouponDeletedEvent, andV1CouponUpdatedEventwith related objectCoupon - Add support for event notifications
V1CreditNoteCreatedEvent,V1CreditNoteUpdatedEvent, andV1CreditNoteVoidedEventwith related objectCreditNote - Add support for event notifications
V1CustomerCreatedEvent,V1CustomerDeletedEvent, andV1CustomerUpdatedEventwith related objectCustomer - Add support for event notifications
V1CustomerSubscriptionCreatedEvent,V1CustomerSubscriptionDeletedEvent,V1CustomerSubscriptionPausedEvent,V1CustomerSubscriptionPendingUpdateAppliedEvent,V1CustomerSubscriptionPendingUpdateExpiredEvent,V1CustomerSubscriptionResumedEvent,V1CustomerSubscriptionTrialWillEndEvent, andV1CustomerSubscriptionUpdatedEventwith related objectSubscription - Add support for event notifications
V1CustomerTaxIdCreatedEvent,V1CustomerTaxIdDeletedEvent, andV1CustomerTaxIdUpdatedEventwith related objectTaxId - Add support for event notification
V1CustomerCashBalanceTransactionCreatedEventwith related objectCustomerCashBalanceTransaction - Add support for event notification
V1FileCreatedEventwith related objectFile - Add support for event notifications
V1FinancialConnectionsAccountCreatedEvent,V1FinancialConnectionsAccountDeactivatedEvent,V1FinancialConnectionsAccountDisconnectedEvent,V1FinancialConnectionsAccountReactivatedEvent,V1FinancialConnectionsAccountRefreshedBalanceEvent,V1FinancialConnectionsAccountRefreshedOwnershipEvent, andV1FinancialConnectionsAccountRefreshedTransactionsEventwith related objectfinancial_connections.Account - Add support for event notifications
V1IdentityVerificationSessionCanceledEvent,V1IdentityVerificationSessionCreatedEvent,V1IdentityVerificationSessionProcessingEvent,V1IdentityVerificationSessionRedactedEvent,V1IdentityVerificationSessionRequiresInputEvent, andV1IdentityVerificationSessionVerifiedEventwith related objectidentity.VerificationSession - Add support for event notifications
V1InvoiceCreatedEvent,V1InvoiceDeletedEvent,V1InvoiceFinalizationFailedEvent,V1InvoiceFinalizedEvent,V1InvoiceMarkedUncollectibleEvent,V1InvoiceOverdueEvent,V1InvoiceOverpaidEvent,V1InvoicePaidEvent,V1InvoicePaymentActionRequiredEvent,V1InvoicePaymentFailedEvent,V1InvoicePaymentSucceededEvent,V1InvoiceSentEvent,V1InvoiceUpcomingEvent,V1InvoiceUpdatedEvent,V1InvoiceVoidedEvent, andV1InvoiceWillBeDueEventwith related objectInvoice - Add support for event notification
V1InvoicePaymentPaidEventwith related objectInvoicePayment - Add support for event notifications
V1InvoiceitemCreatedEventandV1InvoiceitemDeletedEventwith related objectInvoiceItem - Add support for event notifications
V1IssuingAuthorizationCreatedEvent,V1IssuingAuthorizationRequestEvent, andV1IssuingAuthorizationUpdatedEventwith related objectissuing.Authorization - Add support for event notifications
V1IssuingCardCreatedEventandV1IssuingCardUpdatedEventwith related objectissuing.Card - Add support for event notifications
V1IssuingCardholderCreatedEventandV1IssuingCardholderUpdatedEventwith related objectissuing.Cardholder - Add support for event notifications
V1IssuingDisputeClosedEvent,V1IssuingDisputeCreatedEvent,V1IssuingDisputeFundsReinstatedEvent,V1IssuingDisputeFundsRescindedEvent,V1IssuingDisputeSubmittedEvent, andV1IssuingDisputeUpdatedEventwith related objectissuing.Dispute - Add support for event notifications
V1IssuingPersonalizationDesignActivatedEvent,V1IssuingPersonalizationDesignDeactivatedEvent,V1IssuingPersonalizationDesignRejectedEvent, andV1IssuingPersonalizationDesignUpdatedEventwith related objectissuing.PersonalizationDesign - Add support for event notifications
V1IssuingTokenCreatedEventandV1IssuingTokenUpdatedEventwith related objectissuing.Token - Add support for event notifications
V1IssuingTransactionCreatedEvent,V1IssuingTransactionPurchaseDetailsReceiptUpdatedEvent, andV1IssuingTransactionUpdatedEventwith related objectissuing.Transaction - Add support for event notification
V1MandateUpdatedEventwith related objectMandate - Add support for event notifications
V1PaymentIntentAmountCapturableUpdatedEvent,V1PaymentIntentCanceledEvent,V1PaymentIntentCreatedEvent,V1PaymentIntentPartiallyFundedEvent,V1PaymentIntentPaymentFailedEvent,V1PaymentIntentProcessingEvent,V1PaymentIntentRequiresActionEvent, andV1PaymentIntentSucceededEventwith related objectPaymentIntent - Add support for event notifications
V1PaymentLinkCreatedEventandV1PaymentLinkUpdatedEventwith related objectPaymentLink - Add support for event notifications
V1PaymentMethodAttachedEvent,V1PaymentMethodAutomaticallyUpdatedEvent,V1PaymentMethodDetachedEvent, andV1PaymentMethodUpdatedEventwith related objectPaymentMethod - Add support for event notifications
V1PayoutCanceledEvent,V1PayoutCreatedEvent,V1PayoutFailedEvent,V1PayoutPaidEvent,V1PayoutReconciliationCompletedEvent, andV1PayoutUpdatedEventwith related objectPayout - Add support for event notifications
V1PersonCreatedEvent,V1PersonDeletedEvent, andV1PersonUpdatedEventwith related objectPerson - Add support for event notifications
V1PlanCreatedEvent,V1PlanDeletedEvent, andV1PlanUpdatedEventwith related objectPlan - Add support for event notifications
V1PriceCreatedEvent,V1PriceDeletedEvent, andV1PriceUpdatedEventwith related objectPrice - Add support for event notifications
V1ProductCreatedEvent,V1ProductDeletedEvent, andV1ProductUpdatedEventwith related objectProduct - Add support for event notifications
V1PromotionCodeCreatedEventandV1PromotionCodeUpdatedEventwith related objectPromotionCode - Add support for event notifications
V1QuoteAcceptedEvent,V1QuoteCanceledEvent,V1QuoteCreatedEvent, andV1QuoteFinalizedEventwith related objectQuote - Add support for event notifications
V1RadarEarlyFraudWarningCreatedEventandV1RadarEarlyFraudWarningUpdatedEventwith related objectradar.EarlyFraudWarning - Add support for event notifications
V1ReviewClosedEventandV1ReviewOpenedEventwith related objectReview - Add support for event notifications
V1SetupIntentCanceledEvent,V1SetupIntentCreatedEvent,V1SetupIntentRequiresActionEvent,V1SetupIntentSetupFailedEvent, andV1SetupIntentSucceededEventwith related objectSetupIntent - Add support for event notification
V1SigmaScheduledQueryRunCreatedEventwith related objectsigma.ScheduledQueryRun - Add support for event notifications
V1SourceCanceledEvent,V1SourceChargeableEvent,V1SourceFailedEvent, andV1SourceRefundAttributesRequiredEventwith related objectSource - Add support for event notifications
V1SubscriptionScheduleAbortedEvent,V1SubscriptionScheduleCanceledEvent,V1SubscriptionScheduleCompletedEvent,V1SubscriptionScheduleCreatedEvent,V1SubscriptionScheduleExpiringEvent,V1SubscriptionScheduleReleasedEvent, andV1SubscriptionScheduleUpdatedEventwith related objectSubscriptionSchedule - Add support for event notification
V1TaxSettingsUpdatedEventwith related objecttax.Settings - Add support for event notifications
V1TaxRateCreatedEventandV1TaxRateUpdatedEventwith related objectTaxRate - Add support for event notifications
V1TerminalReaderActionFailedEvent,V1TerminalReaderActionSucceededEvent, andV1TerminalReaderActionUpdatedEventwith related objectterminal.Reader - Add support for event notifications
V1TestHelpersTestClockAdvancingEvent,V1TestHelpersTestClockCreatedEvent,V1TestHelpersTestClockDeletedEvent,V1TestHelpersTestClockInternalFailureEvent, andV1TestHelpersTestClockReadyEventwith related objecttest_helpers.TestClock - Add support for event notifications
V1TopupCanceledEvent,V1TopupCreatedEvent,V1TopupFailedEvent,V1TopupReversedEvent, andV1TopupSucceededEventwith related objectTopup - Add support for event notifications
V1TransferCreatedEvent,V1TransferReversedEvent, andV1TransferUpdatedEventwith related objectTransfer - Add support for event notifications
V2CommerceProductCatalogImportsFailedEvent,V2CommerceProductCatalogImportsProcessingEvent,V2CommerceProductCatalogImportsSucceededEvent, andV2CommerceProductCatalogImportsSucceededWithErrorsEventwith related objectv2.commerce.ProductCatalogImport - Add support for event notifications
V2CoreApprovalRequestApprovedEvent,V2CoreApprovalRequestCanceledEvent,V2CoreApprovalRequestFailedEvent,V2CoreApprovalRequestRejectedEvent, andV2CoreApprovalRequestSucceededEventwith related objectv2.core.ApprovalRequest - Add support for event notification
V2CoreClaimableSandboxUpdatedEventwith related objectv2.core.ClaimableSandbox - Add support for event notifications
V2ExtendWorkflowRunFailedEvent,V2ExtendWorkflowRunStartedEvent, andV2ExtendWorkflowRunSucceededEventwith related objectv2.extend.WorkflowRun - Add support for event notifications
V2OrchestratedCommerceAgreementConfirmedEvent,V2OrchestratedCommerceAgreementCreatedEvent,V2OrchestratedCommerceAgreementPartiallyConfirmedEvent, andV2OrchestratedCommerceAgreementTerminatedEventwith related objectv2.orchestrated_commerce.Agreement - ⚠️ Remove support for event notification
V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEventwith related objectv2.core.ClaimableSandbox - Add support for error type
FxQuoteExpiredError - Add support for error codes
invalid_workflow_input_parametersandworkflow_not_invokableonCannotProceedError
- Add support for new resources