# Nests the Balance Settings request object under a new Payments parameter

## What’s new

This change moves the Balance Settings [request object](https://docs.stripe.com/api/balance-settings/update.md?api-version=2025-08-27.preview) and [response shape](https://docs.stripe.com/api/balance-settings/object.md?api-version=2025-08-27.preview) to a new, required top-level [`payments`](https://docs.stripe.com/api/balance-settings/object.md?api-version=2025-08-27.preview#balance_settings_object-payments) parameter. This change makes it clear that the settings apply only to the [Payments Balance](https://docs.stripe.com/api/balance.md?api-version=2025-08-27.preview).

## Why is this a breaking change?

A new, required top-level [payments](https://docs.stripe.com/api/balance-settings/object.md?api-version=2025-08-27.preview#balance_settings_object-payments) parameter has been added to the Balance Settings [request object](https://docs.stripe.com/api/balance-settings/update.md?api-version=2025-08-27.preview) and [response shape](https://docs.stripe.com/api/balance-settings/object.md?api-version=2025-08-27.preview). This parameter is now the parent of all existing parameters in the Balance Settings object.

## Impact

If you participate in the [Accounts v2 API](https://docs.stripe.com/connect/accounts-v2.md) public preview and want to use API version `2025-08-27.preview` or later, you need to update your integration to use the new, top-level parameter.

## Changes

#### REST API

| Parameters                                                | Change  | Resources or endpoints                                                                                                                                                |
| --------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payments`                                                | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings#update](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `debit_negative_balances`, `payouts`, `settlement_timing` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings#update](/api/balance-settings/update?api-version=2025-08-27.preview) |

#### Ruby

| Parameters                                                | Change  | Resources or methods                                                                                                                                                         |
| --------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payments`                                                | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings::UpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `debit_negative_balances`, `payouts`, `settlement_timing` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings::UpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview) |

#### Python

| Parameters                                                | Change  | Resources or methods                                                                                                                                                        |
| --------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payments`                                                | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings.ModifyParams](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `debit_negative_balances`, `payouts`, `settlement_timing` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettings.ModifyParams](/api/balance-settings/update?api-version=2025-08-27.preview) |

#### PHP

| Parameters                                                | Change  | Resources or methods                                                           |
| --------------------------------------------------------- | ------- | ------------------------------------------------------------------------------ |
| `payments`                                                | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview) |
| `debit_negative_balances`, `payouts`, `settlement_timing` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview) |

#### Java

| Parameters                                             | Change  | Resources or methods                                                                                                                                                       |
| ------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payments`                                             | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsUpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `debitNegativeBalances`, `payouts`, `settlementTiming` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsUpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview) |

#### Node.js

| Parameters                                                | Change  | Resources or methods                                                                                                                                                      |
| --------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payments`                                                | Added   | [BalanceSettingUpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview), [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview) |
| `debit_negative_balances`, `payouts`, `settlement_timing` | Removed | [BalanceSettingUpdateParams](/api/balance-settings/update?api-version=2025-08-27.preview), [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview) |

#### Go

| Parameters                                             | Change  | Resources or methods                                                                                                                                                 |
| ------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Payments`                                             | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsParams](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `DebitNegativeBalances`, `Payouts`, `SettlementTiming` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsParams](/api/balance-settings/update?api-version=2025-08-27.preview) |

#### .NET

| Parameters                                             | Change  | Resources or methods                                                                                                                                                        |
| ------------------------------------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Payments`                                             | Added   | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsUpdateOptions](/api/balance-settings/update?api-version=2025-08-27.preview) |
| `DebitNegativeBalances`, `Payouts`, `SettlementTiming` | Removed | [BalanceSettings](/api/balance-settings/object?api-version=2025-08-27.preview), [BalanceSettingsUpdateOptions](/api/balance-settings/update?api-version=2025-08-27.preview) |

## Upgrade

#### REST API

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. 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](https://docs.stripe.com/api/versioning.md) to include `Stripe-Version: 2025-08-27.preview`
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Ruby

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Ruby SDK to [v15.6.0-beta.1](https://github.com/stripe/stripe-ruby/releases/tag/v15.6.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Python

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Python SDK to [v12.6.0b1](https://github.com/stripe/stripe-python/releases/tag/v12.6.0b1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### PHP

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your PHP SDK to [v17.7.0-beta.1](https://github.com/stripe/stripe-php/releases/tag/v17.7.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Java

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Java SDK to [v29.6.0-beta.1](https://github.com/stripe/stripe-java/releases/tag/v29.6.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Node.js

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Node SDK to [v18.6.0-beta.1](https://github.com/stripe/stripe-node/releases/tag/v18.6.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Go

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Go SDK to [v82.6.0-beta.1](https://github.com/stripe/stripe-go/releases/tag/v82.6.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### .NET

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your .NET SDK to [v48.6.0-beta.1](https://github.com/stripe/stripe-dotnet/releases/tag/v48.6.0-beta.1)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

## Related changes

- [Adds support for deactivating configurations in Accounts v2](https://docs.stripe.com/changelog/basil/2025-08-27/v2_accounts_configuration_deactivation.md)
