A customer's usage

GET /v1/customers/{id}/usage

UTC days, inclusive, up to 366. Follows the key: test keys report sandbox traffic, live keys live traffic.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Query parameters

Name	Type	Required	Description
`start`	string (date)	No	Default: first day of this month
`end`	string (date)	No	Default: today

Responses

Status	Meaning	Body
200	Usage	`CustomerUsage`
400	Invalid range	`Error`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: `CustomerUsage` fields

Field	Type	Description
`object`	`customer_usage`
`customer_id`	string
`mode`	`test`, `live`
`start`	string (date)
`end`	string (date)
`messages_sent`	integer
`messages_failed`	integer
`messages_received`	integer
`verifications_sent`	integer
`verifications_approved`	integer
`numbers`	integer	Numbers assigned now
`phone_numbers`	array of string
`daily`	array of object
`daily[].date`	string (date)
`daily[].messages_sent`	integer
`daily[].messages_failed`	integer
`daily[].messages_received`	integer
`daily[].verifications_sent`	integer
`daily[].verifications_approved`	integer

Errors

Status	When
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

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.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/customers/cus_a1B2c3D4e5F6g7/usage" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const usage = await sms.customers.usage('cus_a1B2c3D4e5F6g7');

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

usage = client.customers.usage("cus_a1B2c3D4e5F6g7")