Adds account balance and payout settings with the Balance Settings API
What’s new
You can now customize how a connected account’s balance and payout are managed by your platform with the Balance Settings API. These options are included:
- payments.debit_negative_balances : determines whether Stripe should try to reclaim negative balances from an attached bank account.
- payments.payouts.minimum_balance_by_currency : defines the minimum balance amount to retain per currency after automatic payouts—only funds in excess of that currency are paid out.
- payments.payouts.schedule : specifies the precise schedule for payouts, including the frequency interval and days of the month or week.
- payments.payouts.statement_descriptor : specifies the text that appears on the bank account statement for payouts.
- payments.settlement_timing : defines settlement timing for pending funds to become available.
If you used the Balance Settings API on preview API versions earlier than 2025-09-30.clover, you’ll notice the following changes:
- The ability to set the Balance Settings delay_days to default by posting an empty
delay_days_overridevalue. The default value is the lowest available for your account. - The delay_days_override field added to the Balance Settings object, which you can set when you update Balance Settings.
| Field | Change | From → to |
|---|---|---|
| BalanceSettings#update. payments. settlement_timing. delay_days_override | Changed | longInteger → emptyable(longInteger) |
| Parameter | Change | Resources or endpoints |
| delay_days_override | Added | BalanceSettings. payments. settlement_timing |
Impact
All Stripe platforms can now use the Balance Settings API to customize account balances, configure minimum balances for automatic payouts, and manage payout settings.
We recommend using the Balance Settings API for both Accounts v1 and Accounts v2 over the legacy settings.payouts hash in the Accounts v1 API However, if you are a platform on Accounts v1 and currently using settings.payouts, you do not need to migrate. If you are a platform on Accounts v2, see Build a SaaS platform to learn more.
Changes
| Change | Resource | |
|---|---|---|
| Added | BalanceSettings | |
| Endpoints | Change | Resource |
| retrieve update | Added | BalanceSettings |
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: 2025-09-30. clover
- 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.