Usage

Retrieve current usage and limits

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.

get/api/v1/usage

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/usage
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: usage:read)

Response

Current usage

plan'free' | 'pro' | 'custom' required

custom when an operator set per-category limits, pro on an active subscription or store entitlement, else free.

Changes

No recorded changes to this operation across all 1 revision of this API.