Docs
Account, keys and webhooks ›

Get tier

GET/v1/tier

Get tier.

Requestcurl
  1. curl https://agental.io/v1/tier \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY"
Answer200 OK · Tier
  1. {
  2. "enforced": boolean,
  3. "tier": integer,
  4. "from": "plan" | "money" | "hand",
  5. "plan": string | null,
  6. "perQuarterMb": integer,
  7. "perHourMb": integer,
  8. "startedQuarterMb": integer,
  9. "startedHourMb": integer,
  10. "leftQuarterMb": integer,
  11. … 8 more
  12. }

Replaced by GET /v1/burst.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 Replaced by GET /v1/burst. The old shape, worked out from the account's burst: the free burst stands for the tier's amounts, and the meter for what was started.

Tier17 fields
enforced
boolean
tier
integer
The place among the plans of the plan whose limits the account has.
from
planmoneyhand
plan or hand.
More Money no longer raises anything.
plan
stringnull
perQuarterMb
integer
The free burst, in megabytes.
perHourMb
integer
The same.
startedQuarterMb
integer
What the burst meter reads.
startedHourMb
integer
The same.
leftQuarterMb
integer
What may be started now for nothing.
leftHourMb
integer
The same.
leftMb
integer
The same.
overQuarterMb
integer
By how much the meter is over the free burst.
overHourMb
integer
The same.
mayStart
boolean
receivedUsd
number
Always 0: money no longer raises anything.
firstPaidAt
stringnull
Always null.
next
null
Always null: nothing raises an account but a change of plan.

Errors and other answers

400 invalid_request. The key belongs to no account.
404 The account behind the key is gone.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.