Retrieve Usage Stats

curl --request GET \
  --url https://api.mailchannels.net/tx/v1/usage \
  --header 'X-Api-Key: <x-api-key>'

{
  "total_usage": 5000,
  "period_end_date": "2025-04-11",
  "period_start_date": "2025-03-12"
}

GET

usage

curl --request GET \
  --url https://api.mailchannels.net/tx/v1/usage \
  --header 'X-Api-Key: <x-api-key>'

{
  "total_usage": 5000,
  "period_end_date": "2025-04-11",
  "period_start_date": "2025-03-12"
}

X-Api-Key

string

required

Successfully returned the usage stats.

total_usage

integer<int64>

required

The total usage for the current billing period.

Example:

5000

period_end_date

string<date>

The end date of the current billing period (ISO 8601 format).

Example:

"2025-04-11"

period_start_date

string<date>

The start date of the current billing period (ISO 8601 format).

Example:

"2025-03-12"

⌘I