v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Usage

SMS usage (volumes)

Aggregated SMS/MMS volumes across your numbers: sent, received, and total message counts, with an optional breakdown by UTC day or by number. Defaults to the last 30 days.

Volumes only, deliberately: SMS cost is carrier-rated asynchronously and billed to your invoice, so per-message cost is not available here. Calling usage (GET /v1/usage/calls) does include billable cost.

get/v1/usage/sms

Query parameters

sincestring date-time

Start of the window (inclusive). Default 30 days before until.

untilstring date-time

End of the window (exclusive). Default now.

numberstring

Scope to one of YOUR SMS-enabled numbers (E.164, leading + optional).

groupBy'day' | 'number'

Response

Volume totals (+ breakdown when groupBy is set).

sincestring date-time
untilstring date-time
groupBy'day' | 'number' | 'null' nullable