Skip to Content
SendlySendly
API ReferenceUsage

Retrieve current usage and limits

GET
/api/v1/usage

Email usage against the limits that are actually enforced: the current month's counts per source category, the monthly cap applied to their total, and today's sends against the trust-tier daily ceiling.

Every figure is read from an enforcement path, so what this reports and what refuses a send cannot disagree. Correspondingly, nothing else is published — there is no billing period, invoice total or non-email meter here, because the platform meters none of those.

Two caveats worth reading before you alert on these numbers:

  • The windows differ. The monthly counters roll over on the SERVER's calendar month; the daily counter buckets on the UTC date. The two therefore reset at different instants.
  • monthly.limit is null once a subscription makes sending metered rather than capped, and also when an operator has set per-category limits — in that case the caps live in monthly.categories[*].limit.

Requires the usage:read scope — View your usage totals and billing limits.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

Response Body

Current usage

application/json
  1. response

Current email usage against the limits that are actually enforced.

plan*string

custom when an operator set the project's limits (per-category limits, or none at all for Sendly's own internal projects), pro on an active subscription or store entitlement, else free.

Value in"free""pro""custom"
monthly*
daily*
Example Request
curl -X GET 'https://api.sendly.now/api/v1/usage'
Example Response
{  "plan": "free",  "monthly": {    "emails_sent": 0,    "limit": 0,    "categories": {      "transactional": {        "emails_sent": 0,        "limit": 0      },      "campaign": {        "emails_sent": 0,        "limit": 0      },      "workflow": {        "emails_sent": 0,        "limit": 0      },      "inbound": {        "emails_sent": 0,        "limit": 0      }    }  },  "daily": {    "emails_sent": 0,    "limit": 0,    "trust_tier": "NEW"  }}