Skip to main content
GET
Retrieve usage

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Response

200 - application/json

Usage for the current period

plan
object
required
period
object
required
emails
object
required
sms
object
required
wallet
object
required

The rand wallet. Pays sends beyond the allowance, and every send on pay as you go.

overage
object | null
required

Postpaid overage accepted this period and the spend cap it stops at; null on plans without overage.

domains
object
required
warmup
object | null

Set while the organisation is warming up on the shared pool; null once complete.