Hanzo
OpenapiBilling

Answers which tier the caller is on, what it allows, and what is left to spend.

Answers which tier the caller is on, what it allows, and what is left to spend. `effectiveAvailable` is the ONLY figure to compare against zero.

GET /v1/billing/tier

Addresshttps://api.hanzo.ai/v1/billing/tier
MethodGET
Operationget_billing_tier
AuthAuthorization: Bearer $HANZO_API_KEY

Answers which tier the caller is on, what it allows, and what is left to spend.

effectiveAvailable is the ONLY figure to compare against zero. The others are its parts — prepaid money, granted credits and the daily term are three sources of one spend, not three balances to add up a second time.

A tier that cannot be READ is an error, never Free. The router in front of the models maps any non-2xx to Free, so answering Free from a question nobody could answer would pin every paying customer to the most restrictive row with nothing anywhere to find.

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

Request

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

Response

StatusBodyMeaning
200Tierok

200 body — 20 fields.

FieldInTypeAlwaysDescription
balancebodyTierBalance
balance.creditsRemainingbodyinteger
balance.currencybodystring
balance.dailyRemainingbodyinteger
balance.effectiveAvailablebodyinteger
balance.prepaidAvailablebodyinteger
tierbodyTierLimits
tier.allowedModelsbodystring[]
tier.dailyCreditsCentsbodyinteger
tier.displayNamebodystring
tier.maxAgentsbodyinteger
tier.namebodystring
tier.unlimitedAgentsbodybooleanUnlimitedAgents reports that MaxAgents 0 means "no ceiling" rather than "no agents" — the reading a bare zero cannot carry.
userbodystring
windowsbodyWindow[]
windows[].limitbodyinteger
windows[].remainingbodyinteger
windows[].resetsbodystring
windows[].spanbodystring
windows[].usedbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo billing tier

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page