Set account capabilities

Required action: account.write

BETA: This endpoint is subject to change without notice.

Enables or disables self-serve capabilities on an account you manage. Set the *_enabled field for each capability you want to change; omitted fields are left unchanged. The manageable capabilities are:

  • billing_enabled
  • subscriptions_enabled
  • payouts_enabled — must be enabled before the account can register an external bank account or receive payouts
  • members_enabled
  • developer_enabled
  • billing_invoice_servicing_accounts — the accounts you grant access to invoice this account's INTERNAL (account-backed) customers; each must belong to the same account tree as the target
  • billing_invoice_all_descendants_service_external_customers — when true, all descendants of this account may invoice its EXTERNAL (end-user) customers (internal customers stay gated by billing_invoice_servicing_accounts)

The balance and onboard_accounts capabilities are managed by Synapto and cannot be changed through this endpoint. Returns the updated Account.

Path Params
string
required
Body Params
boolean

Balance: when true, sets balance.state to ACTIVE; when false, sets to INACTIVE.
When not set, balance state is left unchanged.

boolean

Onboard accounts: when true, sets onboard_accounts.enabled to true (and ensures verification
policies are set); when false, sets to false. When not set, left unchanged.

boolean

Generic capability toggles. Each one sets the corresponding Capability.enabled flag
when present, and is left unchanged when absent.

boolean
boolean
boolean
boolean
billing_invoice_servicing_accounts
object

Wrapper used to distinguish "leave unchanged" (field absent) from "clear to empty"
(field present with an empty accounts list).

boolean

When set, updates capabilities.billing.invoice.all_descendants_service_external_customers.
When absent, the flag is left unchanged. When true, every descendant of the target account
may invoice its EXTERNAL customers; INTERNAL customers stay gated by servicing_accounts.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json