Balance

GET /v1/billing/balance

200 — Current balances:
FieldMeaning
freeImmediately spendable
reservedHeld for in-flight operations
totalAccounting total (free + reserved semantics per product)

200 — response fields

free
number
Immediately spendable balance.
reserved
number
Held for in-flight operations (for example message holds).
total
number
Accounting total; semantics match product policy for free + reserved.

Usage and tier

GET /v1/billing/usage

Query:
month
string
YYYY-MM — defaults to current month.
200 — Monthly aggregates and tier progress.

GET /v1/billing/usage/detailed

Query
from
string
Start date (ISO date).
to
string
End date (ISO date).
group_by
string
Optional grouping: message type, channel, etc.

GET /v1/billing/tier

200 — Current tier per channel (email, RCS, SMS are tracked independently), qualification source, and downgrade counter where applicable. Use the optional channel query parameter to filter to a specific channel’s tier.

Top-ups and payment methods

POST /v1/billing/topup

Initiates a payment for prepaid balance. Body includes amount (minimum €10), currency (EUR), and the payment_method_id from your stored payment methods.

GET / POST /v1/billing/payment-methods

List or add card / SEPA methods as supported.

Auto-reload and alerts

GET / PUT /v1/billing/auto-reload

Read or set threshold and reload amount for automatic top-up.

PUT /v1/billing/alerts

Configure cost alerts; fires billing.balance_low webhooks when crossed.

Ledger and invoices

GET /v1/billing/transactions

Querycursor, limit, from (ISO date), to (ISO date). Returns charges, top-ups, releases, credits.

GET /v1/billing/invoices

Monthly invoice rows; PDF download URLs when present.

Relationship to sends

Every POST /v1/messages success includes inline billing. These routes power dashboards, reconciliation, and automation.

Billing units (Learn)

Basic, Single, Conversation, MAU, and tier volume.

Billing (RCS)

RCS Basic/Single, conversation, MAU.

Billing (Email)

Email Basic Message and email-specific tier.

Errors

HTTP 402 and client handling.

Errors

402 on sends and sometimes on resume when balance is insufficient—see Errors.