Get sub-account usage

Usage counts, limits and current wallet balance of a sub-account.

GET https://api.centerfy.ai/webhooks/inbound/agency/sub-accounts/:id/usage

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your agency API key (cfy_…)	Agency (organization-wide) API key, created in the agency workspace under Settings → API Keys (“Agency API Keys”; the tab only appears on White Label or SaaS Mode plans). Or send Authorization: Bearer `<key>`; x-api-key wins if both are present. Keys must start with cfy_. A sub-account key is rejected with 401.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The sub-account id. Must belong to the key’s agency and not be deleted.

Example

curl -X GET "https://api.centerfy.ai/webhooks/inbound/agency/sub-accounts/{id}/usage" \
  -H "x-api-key: $CENTERFY_AGENCY_API_KEY"

import { CenterfyAgencyClient } from "@centerfy/sdk";

const agency = new CenterfyAgencyClient({ apiKey: process.env.CENTERFY_AGENCY_API_KEY! });

const result = await agency.subAccounts.usage("<subAccountId>");
console.log(result);

centerfy --agency subAccounts usage <subAccountId>

MCP tool: centerfy_agency_sub_accounts_usage (see MCP server)

Response

{
  "status": "success",
  "sub_account_id": "5a1f3c2e-8b4d-4e6f-9a7b-1c2d3e4f5a01",
  "usage": {
    "contacts": 412,
    "users": 3,
    "phone_numbers": 2,
    "agents": 4
  },
  "limits": {
    "max_users": 10,
    "max_contacts": 1000
  },
  "wallet_balance": 57.25
}

Errors

404 — when the sub-account id is not a uuid, does not exist, is deleted, or belongs to another agency.
401 — when the key is missing, not cfy_-prefixed or unknown (including sub-account keys); 403 when the agency is not on a White Label or SaaS Mode plan; 429 above 50 requests per minute per agency (Retry-After header set); 500 ‘database error’ on an internal failure.

Notes

wallet_balance is the newest ledger balance (rounded to 2 decimals), falling back to the stored settings value. Counts are the same ones the agency Sub-Accounts page shows.