Adds support for partial payments on invoices

What’s new

We added support for attaching multiple Payment Intents to an Invoice. Allowing partial payments and multiple payments on invoices provides greater flexibility for businesses and customers in managing payments and cash flow. We also introduced the invoice_payment.paid webhook to track when an attached payment transitions to the paid status. To support issuing credit notes for partially paid invoices, we added a mixed type, pre_payment_amount field, and post_payment_amount field to credit note objects.

Impact

Attach multiple payments to an invoice

You can now use the Attach Payment API to attach multiple payments to an invoice:

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

Issue credit notes for partially paid invoices

You can continue to use the Create Credit Note method to issue credit notes for partially paid invoices. A credit note first reduces the invoice’s amount_remaining (and amount_due), but not below zero. The pre_payment_amount field on the credit note object tracks this portion. The remaining amount after reducing the invoice’s amount_remaining to zero applies to the post_payment_amount field on the credit note object. A credit note has a mixed type if both the pre_payment_amount and the post_payment_amount are non-zero.

For more information about issuing credit notes, see the Create Credit Notes API.

Changes

Upgrade