Hanzo AI
OpenapiBilling

List subscriptions

Lists the plans the caller holds, with the count beside them. It is scoped to the caller's own org, so a query cannot widen it to another customer's.

GET /v1/billing/subscriptions

Addresshttps://api.hanzo.ai/v1/billing/subscriptions
MethodGET
Operationget_billing_subscriptions
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the plans the caller holds, with the count beside them.

It is scoped to the caller's own org, so a query cannot widen it to another customer's. An org on nothing is an empty list, not a refusal — being on no plan is an answer.

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

Request

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

Response

StatusBodyMeaning
200Subscriptionsok

200 body — 25 fields.

FieldInTypeAlwaysDescription
countbodyintegerCount is the row count beside the rows, which is the shape this address has always answered with.
subscriptionsbodySubscription[]
subscriptions[].cancelAtPeriodEndbodyboolean
subscriptions[].canceledAtbodystring
subscriptions[].createdAtbodystring
subscriptions[].currentPeriodEndbodystring
subscriptions[].currentPeriodStartbodystring
subscriptions[].defaultPaymentMethodbodystring
subscriptions[].endedAtbodystring
subscriptions[].idbodystring
subscriptions[].mrrCentsbodyintegerMRRCents is what this subscription contributes per month — commerce's own figure, interval-normalized and multiplied by its seats, so no reader re-derives it…
subscriptions[].planbodySubscriptionPlan
subscriptions[].plan.currencybodystring
subscriptions[].plan.idbodystring
subscriptions[].plan.intervalbodystring
subscriptions[].plan.namebodystring
subscriptions[].plan.pricebodyinteger
subscriptions[].planIdbodystring
subscriptions[].providerTypebodystring
subscriptions[].quantitybodyinteger
subscriptions[].statusbodystring
subscriptions[].trialEndbodystring
subscriptions[].trialStartbodystring
subscriptions[].updatedAtbodystring
subscriptions[].userIdbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo billing subscriptions list

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page