MillionSend Docs

/usage

GET
/usage

Response Body

Effective plan, its send, domain, contact and inbox limits, today's accepted send count (UTC day) and, on a monthly plan, the billing period's usage. On Cloud's Free plan the daily count is shared by every Free team created by the same person, as the cap is. MillionSend extension; plan, limits and period are null on a self-hosted instance and on the instance's own (system) team.

application/json
  1. response
object*"usage"
Value in"usage"
cloud*boolean

True on MillionSend Cloud, where plan limits apply

plan*string

Effective plan; null self-hosted or on the instance's own (system) team

Value in"free""starter""pro""scale"null
limits*
today*
period*

Billing-period usage on monthly plans; null on daily plans and self-hosted

team*
app_url*string

Dashboard origin, for building links; null when unset

Example Request
curl -X GET 'https://api.millionsend.com/usage'
Example Response
{  "object": "usage",  "cloud": true,  "plan": "free",  "limits": {    "emails_per_day": 0,    "emails_per_month": 0,    "domains": 0,    "contacts": 0,    "inboxes": 0  },  "today": {    "emails_sent": 0,    "resets_at": "string"  },  "period": {    "emails_sent": 0,    "included": 0,    "overage_enabled": true,    "overage_usd_per_1k": 0,    "starts_at": "string",    "ends_at": "string"  },  "team": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string"  },  "app_url": "string"}