Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-173284041.1 MB

8b0328d323ca

Reach: Profiles

Get remaining plan limits

Get how much of the plan is left for the current period.

Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.

get/api/reach/v1/profiles/{profileUuid}/limits

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Response

Success response

period_startstring date-time

Start of the current period. Periods are calendar months rather than billing anniversaries, so the counters reset at midnight UTC on the 1st no matter when the subscription started.

period_endstring date-time

End of the current period, that is the last moment of the calendar month.

Example response

{
  "emails": {
    "limit": 10000,
    "used": 2500,
    "remaining": 7500
  },
  "recipients": {
    "limit": 10000,
    "used": 2500,
    "remaining": 7500
  },
  "ai_credits": {
    "limit": 10000,
    "used": 2500,
    "remaining": 7500
  },
  "period_start": "2025-03-01T00:00:00Z",
  "period_end": "2025-03-31T23:59:59Z"
}