Overage

Email + SMS solicitation overage summaries (post-launch usage billing surface).

Email + SMS solicitation overage summaries (post-launch usage billing surface).

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETEmail solicitation overage summaryGet 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.
GETSMS solicitation overage summaryGet 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.