anon_email
API referenceSubscription

Get monthly usage meters

GET
/usage

The caller's usage buckets, newest first: the current month plus up to a year of history. Buckets with no traffic are absent, not zero.

Bandwidth compares bytes_forwarded against the subscription's bandwidth_limit_mb; enforcement hard-stops at 110% of the quota.

Authorization

CognitoUserPool
headerAuthorizationBearer <token>

Cognito user pool ID token. API Gateway validates the token (identity token: no OAuth scopes are configured on the authorizer) and forwards its claims; the sub claim is the tenant key.

Response Body

Monthly meters.

application/json
  1. response
usage*array<>
curl -X GET "https://example.com/usage"
{  "usage": [    {      "period": "string",      "emails_received": 0,      "bytes_forwarded": 0,      "bytes_rejected": 0    }  ]}