Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
    Overview
    Basil
    Acacia
    Previous versions
      2024-06-20
      2024-04-10
      2023-10-16
      2023-08-16
      2022-11-15
      2022-08-01
      2020-08-27
      2020-03-02
      2019-12-03
      2019-11-05
      2019-10-17
      2019-10-08
      2019-09-09
      2019-08-14
      2019-05-16
      2019-03-14
      2019-02-19
      2019-02-11
      2018-11-08
      2018-10-31
      2018-09-24
      2018-09-06
      2018-08-23
      2018-07-27
      2018-05-21
      2018-02-28
      2018-02-06
      2018-02-05
      2018-01-23
      2017-12-14
      2017-08-15
      2017-06-05
      2017-05-25
      2017-04-06
      2017-02-14
      2017-01-27
      2016-10-19
      2016-07-06
      2016-06-15
      2016-03-07
      2016-02-29
      2016-02-23
      2016-02-22
      2016-02-19
      2016-02-03
      2015-10-16
      2015-10-12
      2015-10-01
      2015-09-23
      2015-09-08
      2015-09-03
      2015-08-19
      2015-08-07
      2015-07-28
      2015-07-13
      2015-07-07
      2015-06-15
      2015-04-07
      2015-03-24
      2015-02-18
      2015-02-16
      2015-02-10
      2015-01-26
      2015-01-11
      2014-12-22
      2014-12-17
      2014-12-08
      2014-11-20
      2014-11-05
      2014-10-07
      2014-09-08
      2014-08-20
      2014-08-04
      2014-07-26
      2014-07-22
      2014-06-17
      2014-06-13
      2014-05-19
      2014-03-28
      2014-03-13
      2014-01-31
      2013-12-03
      2013-10-29
      2013-08-13
      2013-08-12
      2013-07-05
      2013-02-13
      2013-02-11
      2012-11-07
      2012-10-26
      2012-09-24
      2012-07-09
      2012-06-18
      2012-03-25
      2012-02-23
      2011-09-15
      2011-08-01
      2011-06-28
      2011-06-21
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Build with LLMsStripe for Visual Studio CodeStripe health alertsFile uploads
Security and privacy
Security
Privacy
Extend Stripe
Stripe Apps
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsChangelogPrevious versions2019-12-03

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_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 /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.

Upgrade

  1. View your current API version in Workbench.
  2. 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
  3. Upgrade the API version used for webhook endpoints.
  4. Test your integration against the new version.
  5. If you use Connect, test your Connect integration.
  6. In Workbench, perform the upgrade. You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.

Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc