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

We introduced the Invoice Payment object to represent the connection between payments and invoices and removed previous invoice and payment pointers on relevant objects. Make sure that you update your integration to no longer assume that a single invoice must be paid by a single payment, and use the new Invoice Payment object to understand the connection between payments and invoices.

Inspect the invoice.payments array for payment information

You can inspect invoice.payments when interacting with the Invoice object by expanding the payments property:

curl -G https://api.stripe.com/v1/invoices/{INVOICE_ID} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "expand[]"=payments

The invoice.payments array provides a list of all the payments associated with the invoice and their respective allocation and payment status.

Use the new Invoice Payment endpoints for payments and invoice connection

To understand the connection between a Payment Intent and Invoice object, you can use the List Invoice Payment endpoint:

curl -G https://api.stripe.com/v1/invoice_payments \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "payment[type]"=payment_intent \
  -d "payment[payment_intent]"={PAYMENT_INTENT_ID}

Use confirmation_secret for Payment Element integrations

For Payment Element integrations, especially Subscription integrations, that previously relied on expanding invoice.payment_intent.client_secret or latest_invoice.payments.data.payment.payment_intent.client_secret, you can now use the new invoice.confirmation_secret.client_secret field on the Invoice object by expanding confirmation_secret:

curl -G https://api.stripe.com/v1/invoices/{INVOICE_ID} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "expand[]"=confirmation_secret

Identify invoices with out-of-band payments

With the removal of the paid_out_of_band field, you can now identify invoices with out-of-band payments using the invoice.payments property.

To check if an invoice is fully paid out of band, verify the invoice status is paid, the amount_due is greater than 0, and the sum of payments of type PaymentIntent in the invoice.payments array equals 0.

To check if an invoice is partially paid out of band, verify the amount_due is greater than 0, and the sum of payments of type PaymentIntent in the invoice.payments array is less than amount_paid.

Changes

Upgrade