Hanzo
OpenapiBilling

Answers the caller's month: what their plan includes, what has been consumed…

Answers the caller's month: what their plan includes, what has been consumed against it, and the wallet beside it.

GET /v1/billing/usage/rollup

Addresshttps://api.hanzo.ai/v1/billing/usage/rollup
MethodGET
Operationget_billing_usage_rollup
AuthAuthorization: Bearer $HANZO_API_KEY

Answers the caller's month: what their plan includes, what has been consumed against it, and the wallet beside it.

The two blocks are SEPARATE monies and are never added. One is usage a plan granted; the other is prepaid credit bought with a card. Their sum is not a number anyone holds, and a reader that formed it would be inventing a balance.

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

Request

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

Response

StatusBodyMeaning
200Rollupok

200 body — 21 fields.

FieldInTypeAlwaysDescription
balancebodyRollupBalance
balance.availableCentsbodyinteger
balance.balanceCentsbodyinteger
balance.holdsCentsbodyinteger
consumedCentsbodyinteger
currencybodystring
includedbodyRollupAllotment
included.consumedCentsbodyinteger
included.grantedCentsbodyinteger
included.monthlyCentsbodyinteger
included.remainingCentsbodyinteger
overageCentsbodyinteger
periodbodystring
planbodystring
userbodystring
windowsbodyWindow[]
windows[].limitbodyinteger
windows[].remainingbodyinteger
windows[].resetsbodystring
windows[].spanbodystring
windows[].usedbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page