Lists this org's spend caps: the ceiling, its scope, whether it enforces, and…

Lists this org's spend caps: the ceiling, its scope, whether it enforces, and how much of it has been spent this period.

GET /v1/billing/alerts

Billing → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/billing/alerts`
Method	`GET`
Operation	`get_billing_alerts`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists this org's spend caps: the ceiling, its scope, whether it enforces, and how much of it has been spent this period.

periodSpentCents, over and warn are ABSENT rather than zero when the spend could not be read, because "nothing spent" and "spend unknown" are different answers and a customer acting on the first when the second is true would be reading a ceiling that is not there. The policy row is reported either way.

The period is the UTC calendar month and resetsAt is when the count starts again, so a surface can say "resets on" without a second call.

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

Request

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

Response

Status	Body	Meaning
`200`	Alert[]	ok

200 body — 18 fields.

Field	In	Type	Always
`[].createdAt`	body	string	—
`[].currency`	body	string	—
`[].enforce`	body	boolean	—
`[].id`	body	string	—
`[].over`	body	boolean	—
`[].period`	body	string	—
`[].periodSpentCents`	body	integer	—
`[].project`	body	string	—
`[].rateLimitRpm`	body	integer	—
`[].resetsAt`	body	string	—
`[].service`	body	string	—
`[].softPct`	body	integer	—
`[].threshold`	body	integer	—
`[].title`	body	string	—
`[].triggeredAt`	body	string	—
`[].updatedAt`	body	string	—
`[].userId`	body	string	—
`[].warn`	body	boolean	—

Failure carries the platform error shape — see Errors.

Examples

hanzo billing alerts list

import { Configuration, BillingApi } from 'hanzoai';

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

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_alerts()

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

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

use hanzo_cloud::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_alerts(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

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

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

The door reaches billing through the billing tool, which names its 9 operations with its own verbs — this one among them, under a name only the door 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": "get_billing_balance"
         }
       }
     }'

Billing API · All Hanzo APIs · Interactive reference

Lists this org's spend caps: the ceiling, its scope, whether it enforces, and…

Request

Response

Examples

On this page