List credits

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

GET /v1/billing/credits

Billing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/billing/credits`
Method	`GET`
Operation	`get_billing_credits`
Auth	`Authorization: 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

Status	Body	Meaning
`200`	billing.CreditGrants	ok
`default`	problem-details	refused

200 body — 15 fields.

Field	In	Type	Always
`count`	body	integer (int64)	—
`grants`	body	billing.CreditGrant[]	—
`grants[].active`	body	boolean	—
`grants[].amountCents`	body	integer (int64)	—
`grants[].createdAt`	body	string	—
`grants[].currency`	body	string	—
`grants[].effectiveAt`	body	string	—
`grants[].expiresAt`	body	string	—
`grants[].id`	body	string	—
`grants[].name`	body	string	—
`grants[].priority`	body	integer (int64)	—
`grants[].remainingCents`	body	integer (int64)	—
`grants[].tags`	body	string	—
`grants[].userId`	body	string	—
`grants[].voided`	body	boolean	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo billing credits

.ts

.py

.go

.rs

.java

import { Configuration, BillingApi } from 'hanzoai';

const api = new BillingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBillingCredits();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BillingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BillingApi(client).get_billing_credits()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.BillingAPI.GetBillingCredits(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, billing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = billing_api::get_billing_credits(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BillingApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new BillingApi(client).getBillingCredits();

curl https://api.hanzo.ai/v1/billing/credits \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches billing through the billing tool, which names its 39 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_billing_accounts"
         }
       }
     }'

Billing API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList credit balance NextGet deposit