Create alerts

Opens a spend cap on the caller's own org.

POST /v1/billing/alerts

Billing → · All API references → · Get started →

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

Opens a spend cap on the caller's own org.

At least one limit must mean something: a threshold above zero (a spend cap) or a requests-per-minute above zero (a rate limit). A row that bounds neither is refused rather than stored, because a ceiling nothing measures against is a ceiling a customer believes in and does not have.

The cap is keyed on the caller's own billing subject, resolved server-side — the SAME key the verdict looks it up under, which is what makes enforcement bind rather than merely record.

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

Request

9 fields, body application/json (required).

Field	In	Type	Required
`currency`	body	string	—
`enforce`	body	boolean	—
`project`	body	string	—
`rateLimitRpm`	body	integer (int64)	—
`service`	body	string	—
`softPct`	body	integer (int64)	—
`subject`	body	string	—
`threshold`	body	integer (int64)	—
`title`	body	string	—

Response

Status	Body	Meaning
`201`	billing.Alert	created
`default`	problem-details	refused

201 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 (int64)	—
`project`	body	string	—
`rateLimitRpm`	body	integer (int64)	—
`resetsAt`	body	string	—
`service`	body	string	—
`softPct`	body	integer (int64)	—
`threshold`	body	integer (int64)	—
`title`	body	string	—
`triggeredAt`	body	string	—
`updatedAt`	body	string	—
`userId`	body	string	—
`warn`	body	boolean	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo billing alerts create

.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.postBillingAlerts({ currency: "<currency>", enforce: false });

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).post_billing_alerts(currency="<currency>", enforce=False)

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

resp, _, err := client.BillingAPI.PostBillingAlerts(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::post_billing_alerts(&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).postBillingAlerts();

curl -X POST https://api.hanzo.ai/v1/billing/alerts \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "currency": "<currency>",
       "enforce": false
     }'

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?

PreviousUpdate alerts NextCreate deposit