TextKitDocs

A customer's usage

UTC days, inclusive, up to 366.

GET/v1/customers/{id}/usage

Path Parameters

  • idstringrequired

Query Parameters

  • startstring (date)

    Default: first day of this month

  • endstring (date)

    Default: today

Details

Follows the key: test keys report sandbox traffic, live keys live traffic.

Responses

  • 200CustomerUsage

    Usage

  • 400Error

    Invalid range

  • 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

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectcustomer_usage
  • customer_idstring
  • modetest, live
  • startstring (date)
  • endstring (date)
  • messages_sentinteger
  • messages_failedinteger
  • messages_receivedinteger
  • verifications_sentinteger
  • verifications_approvedinteger
  • numbersinteger

    Numbers assigned now

  • phone_numbersarray of string
  • dailyarray of object
  • daily[].datestring (date)
  • daily[].messages_sentinteger
  • daily[].messages_failedinteger
  • daily[].messages_receivedinteger
  • daily[].verifications_sentinteger
  • daily[].verifications_approvedinteger

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 range

  • 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

  • 404

    Not found

  • 429

    Rate limit or quota exceeded