Hanzo
OpenapiBilling

Lists the caller's credit grants — every one of them, spent and lapsed and…

Lists the caller's credit grants — every one of them, spent and lapsed and voided included.

GET /v1/billing/credits

Addresshttps://api.hanzo.ai/v1/billing/credits
MethodGET
Operationget_billing_credits
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the caller's credit grants — every one of them, spent and lapsed and voided included.

That is deliberate and it is what makes the list useful: a grant list is a LEDGER, and one that hid its spent rows could not be reconciled against a burn-down. What is spendable right now is the sibling read, /v1/billing/ credit-balance, and the two are different questions.

Scoped to the caller's own wallet, resolved server-side.

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

Request

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

Response

StatusBodyMeaning
200CreditGrantsok

200 body — 15 fields.

FieldInTypeAlwaysDescription
countbodyinteger
grantsbodyCreditGrant[]
grants[].activebodyboolean
grants[].amountCentsbodyinteger
grants[].createdAtbodystring
grants[].currencybodystring
grants[].effectiveAtbodystring
grants[].expiresAtbodystring
grants[].idbodystring
grants[].namebodystring
grants[].prioritybodyinteger
grants[].remainingCentsbodyinteger
grants[].tagsbodystring
grants[].userIdbodystring
grants[].voidedbodyboolean

Failure carries the platform error shape — see Errors.

Examples

hanzo billing credits

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page