Hanzo AI
OpenapiBilling

Get transactions

Reads one ledger entry by its id. It is the MEMBER of the collection beside it rather than a second way to ask — the same rows GET…

GET /v1/billing/transactions/{id}

Addresshttps://api.hanzo.ai/v1/billing/transactions/{id}
MethodGET
Operationget_billing_transactions_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Reads one ledger entry by its id.

It is the MEMBER of the collection beside it rather than a second way to ask — the same rows GET /v1/billing/transactions lists, addressed one at a time. A top-up receipt is read here, because a receipt IS a ledger entry: the id this takes is the transactionId a top-up hands back.

The read is narrower than the list: commerce's core loads the row and refuses anything that is not a deposit, so a row that exists but is not a top-up answers 404. That asymmetry is stated rather than closed, because widening a money read to make two shapes match is not a change worth making for symmetry.

The books are the caller's own and cannot be named, so a guessed id misses rather than reaching another tenant's ledger.

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

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

StatusBodyMeaning
200billing.Transactionok
defaultproblem-detailsrefused

200 body — 9 fields.

FieldInTypeAlwaysDescription
amountbodyinteger (int64)
createdAtbodystring
currencybodystring
expiresAtbodystring
idbodystring
metadatabodyany
notesbodystring
tagsbodystring
typebodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo billing transactions get <id>

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page