Skip to main content
POST
Update payout schedule

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Headers

X-Account-Id
string

Set the schedule of a connected account you own instead of your own. Same resolution every other API-key route uses: the account must be yours or one you own, or the request 404s.

Body

application/json

The payout schedule to set, one call at a time.

schedule_by_currency
object | null

Payout schedules to set, keyed by the balance currency each one governs. A currency you leave out keeps the schedule it has, so one call changes NGN without touching USD.

Response

The account's payout schedule after the write.

schedule_by_currency
object

Payout schedules, keyed by the balance currency each one governs. A currency with no schedule is absent rather than present and empty, so you can tell "never configured" from "pays out weekly".