TextKitDocs

Get account usage by month, today's counters, and plan limits

Counts for the whole account, so test and live keys read the same numbers.

GET/v1/usage

Query Parameters

  • monthsinteger

    How many months to return, counting back from the current one Default 3. Maximum 6. Minimum 1.

Details

Months and days are UTC; the current month comes first and is month-to-date. Scope: billing.

Responses

  • 200Usage

    Usage

  • 400Error

    Invalid months

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectusage
  • monthsarray of UsageCounters

    Newest first; a month with no traffic is listed with zeros

  • todayUsageCounters

    The current UTC day so far

  • limitsobject

    Caps applied to live traffic on your plan; null means no cap

  • limits.messages_per_dayinteger

    Example: 10000.

  • limits.messages_per_monthinteger

    Nullable.

  • limits.lookups_per_dayinteger

    0 when live lookups are not available on your plan Example: 5000.

  • limits.verifications_per_dayinteger

    Example: 2000.

  • limits.verifications_per_monthinteger

    Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 400

    Invalid months

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded