Create sub-account

Create a new sub-account (project) with its own API key. All charges are billed to the parent team’s balance. Use creditLimit to set a spending cap. The sub-account’s API key is returned only in the creation response.

POST /v1/sub-accounts

cURL

basic

curl --request POST \
  --url https://api.zavu.dev/v1/sub-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Client ABC"
}
'

201

{
  "subAccount": {
    "id": "<string>",
    "name": "Client ABC",
    "status": "active",
    "totalSpent": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "creditLimit": 123,
    "metadata": {},
    "apiKey": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Name of the sub-account.

Maximum string length: 200

Example:

"Client ABC"

externalId · string

External reference ID for your own tracking.

creditLimit · integer

Spending cap in cents. When reached, messages from this sub-account will be blocked. Omit or set to 0 for no limit.

Required range: x >= 0

metadata · object

Response

201

application/json

Sub-account created.

subAccount · object · required

Show child attributes