SMAO API Documentation
Distributor API v1Usage

Get aggregated usage across all organizations

GET
/usage

Returns aggregated usage across all customer organizations under this distributor. Optionally filter by partnerId to scope results to a single MSP's customers. Totals are all-or-nothing: if any organization's usage cannot be calculated, the request fails with 500 INTERNAL_ERROR instead of returning a partial total.

Authorization

DistributorApiKey
AuthorizationBearer <token>

Long-lived distributor API key, scoped to your distributor account.

In: header

Query Parameters

from*string

Start date in YYYY-MM-DD format, inclusive. Must not be after today (UTC).

Formatdate
to*string

End date in YYYY-MM-DD format, inclusive. Must not be after today (UTC), so a window for the current month ends today, not on the last day of the month. Usage windows may cover at most 365 days, billing-summary windows at most 31 days.

Formatdate
partnerId?string

Filter results to a specific partner (MSP). Omit to include all organizations.

Match^[a-fA-F0-9]{24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/usage?from=2019-08-24&to=2019-08-24"
{  "status": "success",  "period": {    "from": "2019-08-24",    "to": "2019-08-24"  },  "totals": {    "calls": {      "count": 0,      "minutes": 0    },    "forwards": {      "count": 0,      "minutes": 0    },    "assistants": 0,    "sms": {      "count": 0,      "segments": 0    },    "whatsapp": 0  },  "organizationCount": 0,  "organizations": [    {      "id": "69c175970f3e28310926a1aa",      "name": "string",      "externalCustomerId": "string",      "usage": {        "calls": {          "count": 0,          "minutes": 0        },        "forwards": {          "count": 0,          "minutes": 0        },        "assistants": 0,        "sms": {          "count": 0,          "segments": 0        },        "whatsapp": 0      }    }  ]}

Get aggregated usage for a single partner's organizations GET

Returns aggregated usage across all customer organizations that belong to the specified partner (MSP), plus a per-organization breakdown. Totals are all-or-nothing: if any organization's usage cannot be calculated, the request fails with `500 INTERNAL_ERROR` instead of returning a partial total.

List assignable plans GET

Returns all SMAO plans available for assignment to customer organizations. Trial and enterprise plans are excluded. Each plan includes its `slug`, `commitment` (monthly/yearly), `baseFee` in the smallest currency unit, and a `usage` array showing included units and overage cost per service.