Breaking changes
Customer balances are now returned when voiding invoices Breaking 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 _ applied _ balance to false when voiding invoices in /v1/invoices/:id/void .
- Set invoice _ customer _ balance _ settings[consume _ applied _ balance _ on _ void] to false in /v1/subscriptions create or update to force this behavior for invoices voided by a subscription.
- Set subscription _ data[invoice _ customer _ balance _ settings][consume _ applied _ balance _ on _ void] to false in /the relevant part of the product 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.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| balance | Changed | Invoice |
Upgrade
- View your current API version in Workbench.
- If you use an SDK, upgrade to the corresponding SDK version for this API version.
- If you don’t use an SDK, update your API requests to include Stripe-Version: 2019-12-03
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.