Customer balances are now returned when voiding invoicesBreaking changes
What’s new
Customer balances applied to all invoices are now debited or credited back to the customer when voided. Earlier, applied customer balances weren’t returned back to the customer and were consumed. To achieve this behavior in earlier API versions:
- Set
consume_
toapplied_ balance false
when voiding invoices in /v1/invoices/:id/void. - Set
invoice_
tocustomer_ balance_ settings[consume_ applied_ balance_ on_ void] false
in/v1/subscriptions
create or update to force this behavior for invoices voided by a subscription. - Set
subscription_
todata[invoice_ customer_ balance_ settings][consume_ applied_ balance_ on_ void] false
in/v1/checkout/sessions
create to force this behavior for invoices voided by subscriptions created with Checkout.
Impact
Lets you have customer balances properly credited back to the customer when invoices are voided. Previously, any customer balances applied to the voided invoices would be consumed and not returned to the customer, which led to unexpected balance depletion.