Get remaining plan limits

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

Get remaining plan limits

get

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.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

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

Responses

200

Success response

application/json

What the plan allows and what is left of it for the current period.

emails counts every email sent. recipients counts the distinct contacts emailed - it is not the size of the contact list, a contact emailed three times counts once and a contact never emailed does not count at all. ai_credits counts the AI generations used, and its limit includes any extra credits bought on top of the plan.

period_startstring · date-timeOptional

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.

Example: 2025-03-01T00:00:00Z

period_endstring · date-timeOptional

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

Example: 2025-03-31T23:59:59Z

401

Unauthenticated response

application/json

500

Error response

application/json

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

GET /api/reach/v1/profiles/{profileUuid}/limits HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
}