Update balance settings | Sample

2 body fields

expandarray<string>optional

Specifies which fields in the response should be expanded.

paymentsobjectoptional

Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).

2 status codes

200Successful response.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:balance_settings

paymentsobjectrequired

defaultError response.

errorobjectrequired

Error handling

Any other status is an error: Error response.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.balanceSettings.create({
  expand: [],
  payments: {},
});

{
  "object": "balance_settings",
  "payments": {
    "debit_negative_balances": true,
    "payouts": {
      "schedule": {
        "interval": "daily",
        "monthly_payout_days": [
          null
        ],
        "weekly_payout_days": [
          null
        ]
      },
      "statement_descriptor": "example_value",
      "status": "disabled"
    },
    "settlement_timing": {
      "delay_days": 1,
      "delay_days_override": 1,
      "start_of_day": {
        "hour": 1,
        "minutes": 1,
        "timezone": "2026-01-15T09:00:00Z"
      }
    }
  }
}

Request

Response

Errors