API Changelog

Breaking changes to Payments and Invoicing APIs:

Payments: Makes automatic sync the default capture method for PaymentIntents when not specified.

Invoicing: Renames rendering_options attribute for invoices to rendering. Renames features attribute of the Product object.

Updates to Accounts API: Adds new account requirement error codes and auto-populates the statement descriptor and prefix.

Enhancements across Payments, Checkout, and Connect:

Payments: Enables automatic payment methods by default for PaymentIntents and SetupIntents. Adds specific error codes for failed Klarna payments.

Checkout: One-time payments support no-cost orders.

Connect: Platform-scope rendering for select PaymentMethod fingerprints. Adds new director verification error codes to the Accounts API.

Breaking changes:

• The Charges object no longer auto-expands refunds by default
• Removes the charges attribute from the PaymentIntent object
• Adds new decline codes to the PaymentIntent and PaymentMethod APIs
• Adds new decline codes to the SetupIntent API
• Adds a new structure error code to the Accounts API

Breaking changes:

• Removes the include_and_require value when creating invoices
• Default customer creation in Checkout Session payment mode changed to if_required
• Deferred PaymentIntent creation in Checkout Session payment mode
• Removes the setup_intent property from Checkout Sessions in subscription mode
• Replaces line item parameters from the Create Checkout Session endpoint
• Removes the subscription data parameter from the Create Checkout Session endpoint
• Removes the shipping rate parameter from Create Checkout Session endpoint
• Updates Checkout Session shipping properties
• Adds 3D Secure exemption status to card charges
• New error code for invalid terms of service acceptance in Accounts API
• New endpoints for managing a physical card's shipping status in test mode
• Adds design_rejected as a possible cancellation reason for issued cards
• Removes the default_currency attribute from the Customer object

Breaking changes:

• Removes the tax_percent attribute
• Renames phases attributes in subscription schedules
• Renames event type that triggers on automatic updates
• Removes the display_items property from Checkout Sessions
• Formats requirements for key persons associated with accounts
• Adds new error codes to the Accounts, Persons, and Capabilities APIs
• Updates to 3D Secure details in Charge object
• Customer subscriptions are no longer auto-expanded by default
• Plan tiers are no longer auto-expanded by default
• Customer sources are no longer auto-expanded by default
• Tax IDs are no longer auto-expanded on the Customer object
• Deprecates subscription prorate and subscription_prorate parameters

Breaking changes:

• Invoices can now be numbered sequentially across your account

Breaking changes:

• Standardizes invoice line item IDs
• New requirement for out_of_band_amount when creating post-payment credit notes
• Customer balances are now returned when voiding invoices
• Removes deprecated tax information fields from the Customer object

Breaking changes:

• Adds requirement for requested_capabilities on custom account creation
• Nested subscription schedule settings under default_settings

Breaking changes:

• Renames and updates subscription schedule renewal properties
• Replaces the subscription start field with start_date
• Renames billing to collection_method on invoices, subscriptions, and subscription schedules
• The due_date property is always null on auto-billed invoices
• Renames account_balance to balance on Customer object

Breaking changes:

• Renames a Person object relationship attribute

Breaking changes:

• Accounts in many countries now require specifying capabilities at creation time
• Adds new details_code values to person document verification

Breaking changes:

• Renames the platform_payments capability for accounts to card_payments, requiring the manual specification of the added transfers capability
• Configuring a person as an account opener no longer automatically sets them as an executive

Breaking changes:

• Bank pull payments no longer expose internal system refunds on failure

Breaking changes:

• Renames application_fee on invoices to application_fee_amount
• Subscriptions are now successfully created even if the first payment fails
• Invoices now provide timestamps for each state transition
• Renames the date field for invoices to created
• Invoices now specify when they're finalized alongside other status transitions

Breaking changes:

• Changes statement descriptor behaviors for card payments created with Charges
• Several account fields have been refactored to better describe legal entity, verification status and requirements, and configurable settings
• Several fields describing an account's business details have moved to the business_profile subhash
• Verification of accounts or persons now supports uploading both front and back sides
• Accounts no longer provide a keys field. Platforms should use their own API key to authenticate as their connected accounts
• Accounts in the US now require specifying capabilities at creation time
• Renames the business_id_number for an account's legal entity to business_registration_number

Breaking changes:

• Renames several statuses for PaymentIntents
• Renames the save_source_to_customer field for sources to save_payment_method
• Renames the allowed_source_types field for sources to payment_method_types
• Renames the next_source_action field for Payment Intents to next_action
• Renames the authorize_with_url field for Payment Intents to redirect_to_url

Breaking changes:

• Invoices now specify their automatic collection behavior using the auto_advance field
• One-off invoices no longer automatically collect payment by default
• Replaces the forgiven field with a new uncollectible status for invoices
• Renames an invoice error code to invoice_already_finalized
• Includes several changes for users of the Payment Intents API private beta

Breaking changes:

• Descriptions for customers now have a character limit
• Product names now have a character limit
• Descriptions for invoice line items now have a character limit
• The billing_reason of the first invoice of a subscription is now subscription_create

Breaking changes:

• Renames the FileUpload object to Files, which now require secret keys to download files