v17.4.0-beta.1

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

• #1864 Update generated code for beta

  Breaking changes

  • Remove support for deprecated previews
    • Remove support for resources Billing.MeterErrorReport, GiftCards.Card, GiftCards.Transaction, and Privacy.RedactionJobRootObjects
    • Remove support for all, create, retrieve, update, and validate methods on resource GiftCards.Card
    • Remove support for all, cancel, confirm, create, retrieve, and update methods on resource GiftCards.Transaction
    • Remove support for provisioning on Product
    • Remove support for snapshot event BILLING_METER_ERROR_REPORT_TRIGGERED 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
  • Remove support for amount_remaining and credits on Order
  • Change type of PaymentAttemptRecord.metadata and PaymentRecord.metadata from nullable(map(string: string)) to map(string: string)
  • Remove support for async_workflows on PaymentIntent
  • Change type of Privacy.RedactionJob.objects from $Privacy.RedactionJobRootObjects to RedactionResourceRootObjects
  • 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 values credits_attributed_to_debits and legacy_prorations from enums Quote.subscription_data.billing_mode, QuotePreviewSubscriptionSchedule.billing_mode, Subscription.billing_mode, and SubscriptionSchedule.billing_mode
  • Remove support for status_details and status on Tax.Association

  Other changes

  • Add support for migrate method on resource Subscription
  • Add support for institution on FinancialConnections.Account
  • Add support for countries on FinancialConnections.Institution
  • Add support for hooks on PaymentIntent
  • Add support for livemode on Privacy.RedactionJob
  • Add support for new values classic and flexible on enums Quote.subscription_data.billing_mode, QuotePreviewSubscriptionSchedule.billing_mode, Subscription.billing_mode, and SubscriptionSchedule.billing_mode
  • Add support for billing_mode_details on Subscription
  • Add support for tax_transaction_attempts on Tax.Association
  • Add support for error code forwarding_api_upstream_error on QuotePreviewInvoice.last_finalization_error

See the changelog for more details.

v17.3.0

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

• #1871 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 refund_and_dispute_prefunding on Balance
  • Add support for balance_type on BalanceTransaction
  • 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 kakao_pay, kr_card, naver_pay, payco, and samsung_pay on PaymentMethodConfiguration
  • Add support for billing_thresholds on SubscriptionItem and Subscription
  • Add support for metadata on Tax.CalculationLineItem
  • Add support for new value collect_inputs on enum Terminal.Reader.action.type
  • Add support for new value simulated_stripe_s700 on enum Terminal.Reader.device_type
  • Add support for snapshot event INVOICE_PAYMENT_PAID 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.

v17.2.1

• #1869 Fixed type of map parameters(eg. metadata, currency_options) from StripeObject to array<KType, VType> in all methods.
• #1866 Adds CONTRIBUTING.md

See the changelog for more details.

v17.3.0-beta.1

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

  • 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 enum QuotePreviewInvoice.customer_tax_ids[].type
  • Add support for billing_mode on QuotePreviewSubscriptionSchedule, SubscriptionSchedule, and Subscription

See the changelog for more details.

v17.2.0

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

• #1839 Update generated 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 wallet_options on Checkout.Session
  • Add support for context on Event
  • 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 Invoice.customer_tax_ids[].type and TaxId.type
  • Add support for new value affirm on enums Invoice.payment_settings.payment_method_types and Subscription.payment_settings.payment_method_types
  • Add support for pix on PaymentMethodConfiguration
  • Add support for klarna on PaymentMethodDomain
  • Add support for us_cfpb_data on Person
  • Add support for pending_reason on Refund
  • Change type of Tax.CalculationLineItem.reference from nullable(string) to string
• #1857 Include new PHP 8.3 and 8.4 in CI
• #1856 Faster parallel runner for PHP formatter

See the changelog for more details.

v17.2.0-beta.4

• #1855 Update generated code for beta
  • Add support for new resources FxQuote and PaymentIntentAmountDetailsLineItem
  • Add support for all, create, and retrieve methods on resource FxQuote
  • Remove support for attach_payment_intent method on resource Invoice
  • Add support for script and 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, QuotePreviewInvoice.payment_settings.payment_method_types, and Subscription.payment_settings.payment_method_types
  • Add support for fx_quote on PaymentIntent and Transfer
  • Add support for pix on PaymentMethodConfiguration
  • Add support for us_cfpb_data on Person
  • Add support for pending_reason on Refund
  • Add support for snapshot event FX_QUOTE_EXPIRED with resource FxQuote

See the changelog for more details.

v17.2.0-beta.3

• #1849 Update generated code for beta

  Breaking changes

  • Change type of V2.MoneyManagement.ReceivedDebit.status_transitions from an object to nullable(an object)
  • 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 all, cancel, create, retrieve, run, update, and validate methods on resource RedactionJob
  • Add support for all and retrieve methods on resource RedactionJobValidationError
  • 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.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 nullable(string) to string

• #1851 Handle external_account field

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

See the changelog for more details.

v17.2.0-beta.2

• #1847 Remove stdClass from object shapes
  • Remove intersection with stdClass in resource properties and fixed instanceof checks.

See the changelog for more details.

v17.1.1

• #1847 Remove stdClass from object shapes
  • Remove intersection with stdClass in resource properties and fixed instanceof checks.

See the changelog for more details.

v17.2.0-beta.1

• #1830 Update logic for Stripe::addBetaVersion

  • Stripe::addBetaVersion will use the highest version number used for a beta feature instead of throwing an Exception on a conflict as it had done previously.

• #1814, #1840 Update generated code for beta

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

  Breaking Changes

  • Remove support for values repeating and variable from enum Coupon.duration
  • 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 application_fee_amount, discount, paid_out_of_band, paid, payment_intent, quote, subscription_details, subscription_proration_date, tax, total_tax_amounts, and transfer_data on QuotePreviewInvoice
  • 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 nullable(string)
  • Change type of PaymentRecord.latest_payment_attempt_record from string to nullable(string)

  Additions

  • Add support for new value repeating on enum Coupon.duration
  • Add support for new resources BalanceSettings
  • Add support for retrieve and update methods on resource BalanceSettings
  • Add support for all, create, delete, 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 new values stripe_balance_payment_debit_reversal and stripe_balance_payment_debit on enum BalanceTransaction.type
  • Add support for customer_account on Billing.CreditBalanceSummary, Billing.CreditGrant, BillingPortal.Session, CashBalance, Checkout.Session, CreditNote, CustomerBalanceTransaction, CustomerCashBalanceTransaction, CustomerSession, Customer, Discount, InvoiceItem, Invoice, PaymentIntent, PaymentMethod, PromotionCode, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, Quote, SetupAttempt, SetupIntent, SubscriptionSchedule, Subscription, and TaxId
  • Add support for tax_calculation_reference on CreditNoteLineItem, InvoiceLineItem, and LineItem
  • Add support for context on Event
  • Add support for related_customer_account on Identity.VerificationSession
  • 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 stripe_balance on PaymentMethod
  • Add support for payout_method on 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

  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 all 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 all, create, and retrieve methods on resources V2.MoneyManagement.FinancialAddress and V2.MoneyManagement.InboundTransfer
  • Add support for all, cancel, create, and retrieve methods on resources V2.MoneyManagement.OutboundPayment and V2.MoneyManagement.OutboundTransfer
  • Add support for all, archive, retrieve, and unarchive methods on resource V2.MoneyManagement.PayoutMethod
  • Add support for all, cancel, create, 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 V2MoneyManagementFinancialAddressActivatedEvent and V2MoneyManagementFinancialAddressFailedEvent with related object V2.MoneyManagement.FinancialAddress
  • Add support for new thin events V2MoneyManagementInboundTransferAvailableEvent, V2MoneyManagementInboundTransferBankDebitFailedEvent, V2MoneyManagementInboundTransferBankDebitProcessingEvent, V2MoneyManagementInboundTransferBankDebitQueuedEvent, V2MoneyManagementInboundTransferBankDebitReturnedEvent, and V2MoneyManagementInboundTransferBankDebitSucceededEvent with related object V2.MoneyManagement.InboundTransfer
  • Add support for new thin events V2MoneyManagementOutboundPaymentCanceledEvent, V2MoneyManagementOutboundPaymentCreatedEvent, V2MoneyManagementOutboundPaymentFailedEvent, V2MoneyManagementOutboundPaymentPostedEvent, and V2MoneyManagementOutboundPaymentReturnedEvent with related object V2.MoneyManagement.OutboundPayment
  • Add support for new thin events V2MoneyManagementOutboundTransferCanceledEvent, V2MoneyManagementOutboundTransferCreatedEvent, V2MoneyManagementOutboundTransferFailedEvent, V2MoneyManagementOutboundTransferPostedEvent, and V2MoneyManagementOutboundTransferReturnedEvent with related object V2.MoneyManagement.OutboundTransfer
  • Add support for new thin events V2MoneyManagementReceivedCreditAvailableEvent, V2MoneyManagementReceivedCreditFailedEvent, V2MoneyManagementReceivedCreditReturnedEvent, and V2MoneyManagementReceivedCreditSucceededEvent with related object V2.MoneyManagement.ReceivedCredit
  • Add support for new thin events V2MoneyManagementReceivedDebitCanceledEvent, V2MoneyManagementReceivedDebitFailedEvent, V2MoneyManagementReceivedDebitPendingEvent, V2MoneyManagementReceivedDebitSucceededEvent, and V2MoneyManagementReceivedDebitUpdatedEvent with related object V2.MoneyManagement.ReceivedDebit
  • Add support for new error types AlreadyCanceledException, BlockedByStripeException, ControlledByDashboardException, FeatureNotEnabledException, FinancialAccountNotOpenException, InsufficientFundsException, InvalidPayoutMethodException, NotCancelableException, and RecipientNotNotifiableException

  New APIs for Accounts v2 in private preview

  See SaaS platform payments with subscription billing using Accounts v2

  • Add support for new resources V2.Core.AccountLink, V2.Core.Account, V2.Core.Person, V2.Core.Vault.GbBankAccount, V2.Core.Vault.UsBankAccount
  • Add support for all, close, create, retrieve, and update methods on resource V2.Core.Account
  • Add support for create method on resource V2.Core.AccountLink
  • Add support for acknowledge_confirmation_of_payee, archive, create, initiate_confirmation_of_payee, and retrieve methods on resource V2.Core.Vault.GbBankAccount
  • Add support for archive, create, retrieve, and update methods on resource V2.Core.Vault.UsBankAccount
  • Add support for new thin events V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationCustomerUpdatedEvent, V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationMerchantUpdatedEvent, V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent, V2CoreAccountIncludingConfigurationRecipientUpdatedEvent, V2CoreAccountIncludingIdentityUpdatedEvent, and V2CoreAccountIncludingRequirementsUpdatedEvent
  • Add support for new thin event V2CoreAccountLinkCompletedEvent with related object V2.Core.AccountLink
  • Add support for new thin events V2CoreAccountPersonCreatedEvent, V2CoreAccountPersonDeletedEvent, and V2CoreAccountPersonUpdatedEvent with related object V2.Core.Person

  Changes

  • Change type of InvoicePayment.is_default from nullable(boolean) to boolean
  • Change type of PaymentAttemptRecord.payment_method_details.custom and `PaymentRecord.payment_method_...