Get the subscription
The caller's plan, the quota limits that apply to it, and the billing lifecycle state (status, period end, provider).
An account with no subscription item reads as the free plan's
defaults. Usage for the current month is under GET /usage; the
bandwidth quota reads against bytes_forwarded.
CognitoUserPoolAuthorizationBearer <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.
The subscription.
application/json- response
plan*stringPlan identifier (free, lite, pro).
alias_limit*integerMaximum aliases the plan allows. -1 means unlimited.
recipient_limit*integerMaximum recipients the plan allows.
bandwidth_limit_mb*integerMonthly forwarded-bytes quota in MiB. Mail is accepted until usage exceeds 110% of this value (10% grace buffer); pro carries this as a fair-use backstop rather than a marketed cap.
status*stringBilling lifecycle state. past_due is a failed renewal inside the
grace window; canceled still entitles until the period ends.
"active""past_due""canceled""expired"current_period_end*|Unix ms when current entitlement ends. Null on free.
provider*stringBilling provider managing the subscription (polar, nowpayments) or empty.
last_paid_plan*stringPrevious paid tier after a downgrade, or empty.
curl -X GET "https://example.com/subscription"{ "plan": "string", "alias_limit": 0, "recipient_limit": 0, "bandwidth_limit_mb": 0, "status": "active", "current_period_end": 0, "provider": "string", "last_paid_plan": "string"}