Skip to main content
GET
Node.js

Headers

X-Api-Key
string
required

Path Parameters

handle
string
required

Handle of the sub-account to query usage stats for.

Response

Successfully returned the usage stats.

monthly_limit
integer
required

The effective monthly limit for the current billing period. A limit of zero means the account cannot send any messages. For sub-accounts with no explicit limit set (i.e., -1), the monthly limit for the parent account is returned.

Example:

10000

total_usage
integer<int64>
required

The total usage for the current billing period.

Example:

5000

period_end_date
string<date>

The end date of the current billing period (ISO 8601 format).

Example:

"2025-04-11"

period_start_date
string<date>

The start date of the current billing period (ISO 8601 format).

Example:

"2025-03-12"