Hanzo
OpenapiBilling

Lists the caller's invoices, newest first, with the count beside them.

Lists the caller's invoices, newest first, with the count beside them.

GET /v1/billing/invoices

Addresshttps://api.hanzo.ai/v1/billing/invoices
MethodGET
Operationget_billing_invoices
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the caller's invoices, newest first, with the count beside them.

It is scoped to the caller's own billing subject — the wallet this request bills from, resolved server-side — so a query cannot widen it to another customer of the same org. An org with no invoices is an empty list, not a refusal.

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

Request

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

Response

StatusBodyMeaning
200Invoicesok

200 body — 39 fields.

FieldInTypeAlwaysDescription
countbodyinteger
invoicesbodyBillingInvoice[]
invoices[].amountDuebodyinteger
invoices[].amountPaidbodyinteger
invoices[].attemptCountbodyinteger
invoices[].createdAtbodystring
invoices[].creditAppliedbodyinteger
invoices[].currencybodystring
invoices[].customerEmailbodystring
invoices[].discountbodyinteger
invoices[].dueDatebodystring
invoices[].idbodystring
invoices[].lineItemsbodyInvoiceLineItem[]LineItems carries no omitempty and is never allocated empty, because the wire it reproduces sends null for an invoice with no lines.
invoices[].lineItems[].amountbodyinteger
invoices[].lineItems[].currencybodystring
invoices[].lineItems[].descriptionbodystring
invoices[].lineItems[].idbodystring
invoices[].lineItems[].meterIdbodystring
invoices[].lineItems[].periodEndbodystring
invoices[].lineItems[].periodStartbodystringThe billed period. Both carry omitempty and neither is ever empty, which looks contradictory and is not: the shape they reproduce is a time value, and…
invoices[].lineItems[].planIdbodystring
invoices[].lineItems[].planNamebodystring
invoices[].lineItems[].quantitybodyinteger
invoices[].lineItems[].typebodystring
invoices[].lineItems[].unitPricebodyinteger
invoices[].numberbodyinteger
invoices[].numberStrbodystring
invoices[].paidAtbodystring
invoices[].paymentMethodbodystring
invoices[].paymentRefbodystring
invoices[].periodEndbodystring
invoices[].periodStartbodystring
invoices[].statusbodystring
invoices[].subscriptionIdbodystring
invoices[].subtotalbodyinteger
invoices[].taxbodyinteger
invoices[].updatedAtbodystring
invoices[].userIdbodystring
invoices[].voidedAtbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo billing invoices list

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page