Hanzo
OpenapiBilling

Answers what the caller can spend right now, one entry per currency.

Answers what the caller can spend right now, one entry per currency.

GET /v1/billing/credit-balance

Addresshttps://api.hanzo.ai/v1/billing/credit-balance
MethodGET
Operationget_billing_credit-balance
AuthAuthorization: Bearer $HANZO_API_KEY

Answers what the caller can spend right now, one entry per currency.

Only ACTIVE grants count: a voided, exhausted or lapsed grant contributes nothing, which is why this number can be smaller than the grant list suggests and why the two reads exist separately. It is credit, not prepaid balance — /v1/billing/balance is the wallet, and the two are added by the gate, never by a reader.

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

Request

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

Response

StatusBodyMeaning
200CreditBalanceok

200 body — 4 fields.

FieldInTypeAlwaysDescription
balancesbodyCreditEntry[]
balances[].availablebodyinteger
balances[].currencybodystring
userIdbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo billing credit-balance get

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page