Skip to main content
GET
Get gateway spend summary

Authorizations

Authorization
string
header
required

Management-only Telnyx account credential.

Query Parameters

page[number]
integer
default:1
Required range: x >= 1
page[size]
integer
default:20
Required range: 1 <= x <= 100
page[snapshot]
string

Required after page 1; account/filter-bound 15-minute stable snapshot; expired/mismatch 409.

Required string length: 1 - 256
Pattern: ^[^\u0000-\u001f\u007f]+$
start_date
string<date>
required
end_date
string<date>
required
token_group_id
string<uuid>
token_user_id
string<uuid>
token_key_id
string<uuid>
end_user_id
string
Required string length: 1 - 256
Pattern: ^[^\u0000-\u001f\u007f]+$
metadata
object

Request tag filters as metadata[]=, at most 5, combined with AND. A value matches the tag's text form exactly (booleans as true/false, integers in decimal), so metadata[flag]=true matches both boolean true and the string "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed: bounded by the account, the date range and the report timeout.

group_by
required

A scope, or metadata: to group by one request tag's text-form value; requests without the key form one group with a null dimension_id.

Available options:
token_group,
token_user,
token_key,
end_user

Response

OK

data
object[]
required
meta
object
required