Skip to main content
GET
Get Customers Usage

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Query Parameters

from
string<date>

First UTC day, YYYY-MM-DD. Needs to. Default: the 1st of this month.

to
string<date>

Last UTC day, YYYY-MM-DD. Needs from. Default: today.

Response

Spend per customer.

timezone
enum<string>
required

Days are UTC, as Settings → Developer counts the month.

Available options:
UTC
from
string<date>
required

First day counted.

to
string<date>
required

Last day counted (cut to today).

currency
enum<string>
required

Your workspace's currency (INR when unset).

Available options:
INR,
USD
totalMicro
integer
required

Spend across all customers in the range. Integer micro-units of currency: 1000000 is one rupee or one dollar.

items
object[]
required

One per customer with charges in the range, biggest spend first.