Adds support for multiple (partial) payments on invoicesBreaking changes

What’s new

We’re introducing support for multiple (partial) payments on invoices and credit notes. Invoices also track over-payments and can track out of band payments now. In addition, we’re adding a confirmation_secret field on the Invoice object to enhance support for using the Payment Element.

Why is this a breaking change?

• Removed the payment_intent, charge, paid, and paid_out_of_band fields from the Invoice object.
• Removed the invoice field from the Payment Intent and Charge objects.
• Deprecated the refund field on the Credit Note object and replaced it with a refunds array.
• The amount_paid field on the Invoice object now reflects out of band payments.

Impact

Update your integration to no longer assume that a single invoice must be paid by a single payment:

• Inspect the invoice.payments array for payment information
• Use the new Invoice Payment endpoints for detailed payment data

Changes

Upgrade