Skip to main content
POST
Bulk sub-account action

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
workspace_ids
integer[]
required

Client sub-account workspace ids.

Maximum array length: 200
action
enum<string>
required
Available options:
pause,
resume,
disable_saas
cancel_subscription
boolean
default:false

For disable_saas only: also cancel each client's Stripe subscription.

confirm
enum<string>

Required ("BULK") when action is disable_saas.

Available options:
BULK

Response

Bulk action applied; body reports applied/failed and per-workspace results

success
enum<boolean>
Available options:
true
data
object
meta
object