Usage Summary

curl -G https://api.tracklysms.com/api/v2/usage/summary \
  -H "X-Api-Key: trk_your_parent_key" \
  --data-urlencode "period=2026-07"

{
  "period": "2026-07",
  "generated_at": "2026-07-26T16:00:00Z",
  "accounts": [
    {
      "account_id": 1042,
      "name": "Acme West",
      "external_ids": { "location_id": "loc_west" },
      "currency": "usd",
      "billed_total": 812.44,
      "refunds_total": 0.0,
      "net_total": 812.44,
      "bypassed_total": 0.0,
      "segments": 180542,
      "messages": 175003
    }
  ],
  "totals": {
    "billed_total": 812.44,
    "refunds_total": 0.0,
    "net_total": 812.44,
    "bypassed_total": 0.0,
    "segments": 180542,
    "messages": 175003,
    "currency": "usd"
  }
}

GET

usage

summary

curl -G https://api.tracklysms.com/api/v2/usage/summary \
  -H "X-Api-Key: trk_your_parent_key" \
  --data-urlencode "period=2026-07"

{
  "period": "2026-07",
  "generated_at": "2026-07-26T16:00:00Z",
  "accounts": [
    {
      "account_id": 1042,
      "name": "Acme West",
      "external_ids": { "location_id": "loc_west" },
      "currency": "usd",
      "billed_total": 812.44,
      "refunds_total": 0.0,
      "net_total": 812.44,
      "bypassed_total": 0.0,
      "segments": 180542,
      "messages": 175003
    }
  ],
  "totals": {
    "billed_total": 812.44,
    "refunds_total": 0.0,
    "net_total": 812.44,
    "bypassed_total": 0.0,
    "segments": 180542,
    "messages": 175003,
    "currency": "usd"
  }
}

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.

number

Sum of refunded amounts.

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).

Examples

curl -G https://api.tracklysms.com/api/v2/usage/summary \
  -H "X-Api-Key: trk_your_parent_key" \
  --data-urlencode "period=2026-07"

{
  "period": "2026-07",
  "generated_at": "2026-07-26T16:00:00Z",
  "accounts": [
    {
      "account_id": 1042,
      "name": "Acme West",
      "external_ids": { "location_id": "loc_west" },
      "currency": "usd",
      "billed_total": 812.44,
      "refunds_total": 0.0,
      "net_total": 812.44,
      "bypassed_total": 0.0,
      "segments": 180542,
      "messages": 175003
    }
  ],
  "totals": {
    "billed_total": 812.44,
    "refunds_total": 0.0,
    "net_total": 812.44,
    "bypassed_total": 0.0,
    "segments": 180542,
    "messages": 175003,
    "currency": "usd"
  }
}

Error Codes

HTTP Status	Error Code	Description
400	`invalid_period`	`period` is not a valid `YYYY-MM`.
400	`invalid_child`	`childAccountId` is malformed.
404	`child_not_found`	The `childAccountId` is not an owned child.

API Reference

V2 API Reference

Partner Accounts (v2)

Messages (v2)

Contacts (v2)

Lists (v2)

Number Requests (v2)

Business Profiles (v2)

Creatives (v2)

Audiences (v2)

Offers (v2)

Schedules (v2)

Revenue (v2)

Usage & Billing (v2)

Data Import (v2)

Links (v2)

Clicks (v2)

Webhooks (v2)

Phone Validation (v1)

API Reference (v1 - Deprecated)

Query Parameters

Response Fields

Examples

Error Codes

Next Steps

Billing records

Statements

​Query Parameters

​Response Fields

​Examples

​Error Codes

​Next Steps

Billing records

Statements

Query Parameters

Response Fields

Examples

Error Codes

Next Steps