The Subaccounts API from Zavu — 5 operation(s) for subaccounts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zavu:zavu-subaccounts-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Zavu Unified Messaging Layer Sub Accounts API
version: 0.2.0
description: Unified multi-channel messaging API for Zavu.
servers:
- url: https://api.zavu.dev
security:
- bearerAuth: []
tags:
- name: Subaccounts
paths:
/v1/sub-accounts:
post:
summary: Create sub-account
description: 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. Requires a parent project API key; sub-account API keys receive HTTP 403.
operationId: createSubAccount
tags:
- Subaccounts
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountCreateRequest'
examples:
basic:
summary: Basic sub-account
value:
name: Client ABC
with_limit:
summary: Sub-account with spending cap
value:
name: Client ABC
externalId: client_123
creditLimit: 100000
responses:
'201':
description: Sub-account created.
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
get:
summary: List sub-accounts
description: List sub-accounts for this team. Requires a parent project API key; sub-account API keys receive HTTP 403.
operationId: listSubAccounts
tags:
- Subaccounts
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
maximum: 100
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: List of sub-accounts.
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/SubAccount'
nextCursor:
type:
- string
- 'null'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
/v1/sub-accounts/{id}:
get:
summary: Get sub-account
operationId: getSubAccount
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
responses:
'200':
description: Sub-account details.
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountResponse'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
description: Get sub-account. Requires a parent project API key; sub-account API keys receive HTTP 403.
patch:
summary: Update sub-account
operationId: updateSubAccount
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountUpdateRequest'
responses:
'200':
description: Sub-account updated.
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
description: Update sub-account. Requires a parent project API key; sub-account API keys receive HTTP 403.
delete:
summary: Deactivate sub-account
description: Deactivate a sub-account. Remaining balance is returned to the parent team and all API keys are revoked. Requires a parent project API key; sub-account API keys receive HTTP 403.
operationId: deactivateSubAccount
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
responses:
'200':
description: Sub-account deactivated.
content:
application/json:
schema:
type: object
required:
- message
- keysRevoked
properties:
message:
type: string
example: Sub-account deactivated
keysRevoked:
type: integer
description: Number of API keys revoked.
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
/v1/sub-accounts/{id}/balance:
get:
summary: Get sub-account spending
description: Get spending information for a sub-account. Returns the parent team's balance, the sub-account's total spending, and its credit limit (spending cap). Requires a parent project API key; sub-account API keys receive HTTP 403.
operationId: getSubAccountBalance
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
responses:
'200':
description: Sub-account balance.
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceResponse'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
/v1/sub-accounts/{id}/api-keys:
get:
summary: List sub-account API keys
operationId: listSubAccountApiKeys
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
responses:
'200':
description: List of API keys.
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/SubAccountApiKey'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
description: List sub-account API keys. Requires a parent project API key; sub-account API keys receive HTTP 403.
post:
summary: Create sub-account API key
operationId: createSubAccountApiKey
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubAccountApiKeyCreateRequest'
example:
name: Production Key
environment: live
responses:
'201':
description: API key created. The full key is only returned once.
content:
application/json:
schema:
type: object
required:
- apiKey
properties:
apiKey:
type: object
required:
- id
- key
- name
- environment
properties:
id:
type: string
key:
type: string
name:
type: string
environment:
type: string
enum:
- live
- test
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
description: Create sub-account API key. Requires a parent project API key; sub-account API keys receive HTTP 403.
/v1/sub-accounts/{id}/api-keys/{keyId}:
delete:
summary: Revoke sub-account API key
operationId: revokeSubAccountApiKey
tags:
- Subaccounts
parameters:
- $ref: '#/components/parameters/SubAccountIdParam'
- $ref: '#/components/parameters/SubAccountApiKeyIdParam'
responses:
'204':
description: API key revoked.
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. Sub-account API keys cannot manage sub-accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Sub-account or API key not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
description: Revoke sub-account API key. Requires a parent project API key; sub-account API keys receive HTTP 403.
components:
schemas:
SubAccountCreateRequest:
type: object
required:
- name
properties:
name:
type: string
maxLength: 200
description: Name of the sub-account.
example: Client ABC
externalId:
type: string
description: External reference ID for your own tracking.
creditLimit:
type: integer
minimum: 0
description: Spending cap in cents. When reached, messages from this sub-account will be blocked. Omit or set to 0 for no limit.
metadata:
type: object
additionalProperties: true
SubAccountUpdateRequest:
type: object
properties:
name:
type: string
externalId:
type: string
creditLimit:
type:
- integer
- 'null'
minimum: 0
metadata:
type: object
additionalProperties: true
status:
$ref: '#/components/schemas/SubAccountStatus'
SubAccountStatus:
type: string
enum:
- active
- inactive
SubAccountResponse:
type: object
required:
- subAccount
properties:
subAccount:
$ref: '#/components/schemas/SubAccount'
SubAccountApiKey:
type: object
required:
- id
- name
- keyPrefix
- environment
- createdAt
properties:
id:
type: string
name:
type: string
key:
type: string
description: Full API key. Only returned on creation.
keyPrefix:
type: string
description: First characters of the key for identification.
environment:
type: string
enum:
- live
- test
permissions:
type: array
items:
type: string
lastUsedAt:
type:
- number
- 'null'
revokedAt:
type:
- number
- 'null'
createdAt:
type: number
SubAccount:
type: object
required:
- id
- name
- status
- totalSpent
- createdAt
properties:
id:
type: string
name:
type: string
example: Client ABC
externalId:
type:
- string
- 'null'
description: External reference ID set by the parent account.
status:
$ref: '#/components/schemas/SubAccountStatus'
totalSpent:
type: integer
description: Total amount spent by this sub-account in cents.
creditLimit:
type:
- integer
- 'null'
description: Spending cap in cents. When reached, messages from this sub-account will be blocked.
metadata:
type:
- object
- 'null'
additionalProperties: true
apiKey:
type: string
description: API key for the sub-account. Only returned on creation.
createdAt:
type: string
format: date-time
SubAccountApiKeyCreateRequest:
type: object
required:
- name
properties:
name:
type: string
environment:
type: string
enum:
- live
- test
default: live
permissions:
type: array
items:
type: string
BalanceResponse:
type: object
required:
- balance
- currency
properties:
balance:
type: integer
description: Team balance in cents. All charges are billed to the parent team.
currency:
type: string
example: usd
creditLimit:
type:
- integer
- 'null'
description: Spending cap in cents (only for sub-accounts).
totalSpent:
type:
- integer
- 'null'
description: Total amount spent by this sub-account in cents (only for sub-accounts).
isSubAccount:
type: boolean
description: Whether this API key belongs to a sub-account.
Error:
type: object
required:
- code
- message
properties:
code:
type: string
example: invalid_request
message:
type: string
example: Phone number is invalid
details:
type: object
additionalProperties: true
parameters:
SubAccountApiKeyIdParam:
name: keyId
in: path
required: true
description: API key ID.
schema:
type: string
SubAccountIdParam:
name: id
in: path
required: true
description: Sub-account ID.
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT