Hanzo
OpenapiAllowance

Answers what the CALLER has left of their plan's free-call allowance this…

Answers what the CALLER has left of their plan's free-call allowance this period, and the instant the count starts again.

GET /v1/allowance

Addresshttps://api.hanzo.ai/v1/allowance
MethodGET
Operationget_allowance
AuthAuthorization: Bearer $HANZO_API_KEY

Answers what the CALLER has left of their plan's free-call allowance this period, and the instant the count starts again.

This is the number a product shows beside the composer — "17 of 20 left today" — and the moment to offer a plan is when it reaches zero. It READS: asking does not spend, so a page that polls it costs the caller nothing.

The subject is the caller's own, resolved from the verified credential, and can never be named in the request — so this is a mirror, not a lookup of someone else. An unauthenticated caller is refused: there is no allowance without someone to hold it.

A named handler, not a closure, so zipdoc can lift this prose into the registry.

Request

GET /v1/allowance takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200Allowanceok

200 body — 5 fields.

FieldInTypeAlwaysDescription
limitbodyintegercalls the plan allows per period; 0 = unbounded
planbodystringthe tier the limit came from
resetsbodyintegerunix seconds; when the count starts again
spentbodybooleanthe subject is at the limit
usedbodyintegerUsed is how many zero-priced calls this subject has been SERVED in the period ending at Resets — the UTC calendar day.

Failure carries the platform error shape — see Errors.

Examples

hanzo allowance get

Allowance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page