Returns a per-account rollup of billed spend, refunds, and message volume for a period, plus portfolio totals. Called on a parent key, it covers the parent and all its children by default; scope to one child with childAccountId.
Query Parameters
string
default:"current month"
The billing month as YYYY-MM.
integer
Restrict the summary to one owned child. Omit to include the caller plus all children.
Response Fields
string
The YYYY-MM period reported.
string
When the summary was computed (ISO-8601, UTC).
array
One entry per account in scope.
Show account entry
integer
The account ID.
string
Account name.
object
External IDs (e.g. location_id).
string
Currency (e.g. usd).
number
Sum of succeeded + refunded charge amounts, excluding any card processing fee. A programmable_voice charge’s amount includes it.
number
Sum of refunded amounts, excluding the card processing fee’s share of each refund. A programmable_voice refund includes it.
number
billed_total − refunds_total.
number
Amount that would have been billed but was comped/bypassed.
integer
Billed segment count.
integer
Billed message count.
object
Portfolio totals across all accounts in scope (same fields plus currency).