Skip to main content
GET
/
api
/
v1
/
billing
/
usage
Get the usage summary
curl --request GET \
  --url https://api.railmail.app/api/v1/billing/usage \
  --header 'X-API-Key: <api-key>'
{
  "subscribersCurrent": 123,
  "subscribersLimit": 123,
  "subscribersPercent": 123,
  "campaignsCurrentMonth": 123,
  "campaignsLimit": 123,
  "campaignsPercent": 123,
  "projectsCurrent": 123,
  "projectsLimit": 123,
  "aiCreditsCurrentMonth": 123,
  "aiCreditsLimit": 123,
  "aiCreditsPercent": 123,
  "emailsCurrentMonth": 123,
  "emailsLimit": 123,
  "emailsPercent": 123
}

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Response

Usage summary

subscribersCurrent
integer
subscribersLimit
integer
subscribersPercent
number<double>
campaignsCurrentMonth
integer
campaignsLimit
integer
campaignsPercent
number<double>
projectsCurrent
integer
projectsLimit
integer
aiCreditsCurrentMonth
number
aiCreditsLimit
integer
aiCreditsPercent
number<double>
emailsCurrentMonth
integer
emailsLimit
integer
emailsPercent
number<double>