See how many email and text requests your locations have sent against their plan allowances, and any overage.
See how many email and text requests your locations have sent against their plan allowances, and any overage.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | Email request usage | Get a paginated per store plan summary of email solicitation volume (count of solicitation emails sent per store_plan_id), used for the account-side email overage display. |
GET | Text request usage | Get a paginated per store plan summary of SMS solicitation volume (count of solicitation SMS sent per store_plan_id), used for the account-side SMS overage display. |