Skip to content
Peritus
API reference · Account

Set billing alert

PUT/v1/account/billing/alert

Sets the balance, in whole dollars, below which the tenant's signup address is emailed once per top-up, or null for no email. Needs the account scope as an owner or admin.

scope
account
auth
Bearer key
operationId
SetBillingAlert

Request body

application/json · BillingAlert · no other fields

Request body fields
FieldTypeRequiredLimits
low_balance_usdinteger · nullableyes1 to 100000

Response

200 · BillingAlert. The threshold now.

Response fields
FieldType
low_balance_usdinteger · nullable

Problems

RFC 9457 application/problem+json. An abstention is not one of these: it is a 200.

Problems
HTTPCodeWhen
400INVALID_REQUESTMalformed JSON, unknown fields, bad filter, limit exceeded
401UNAUTHENTICATEDMissing, malformed, or revoked key
403FORBIDDEN_SCOPEThe key lacks the required scope
404NOT_FOUNDUnknown response, job, document, or reserved route
429RATE_LIMITEDRate limit or per-tenant model cap
500INTERNAL, POLICY_ASSERT_FAILED, RESPONSE_UNREPLAYABLEServer fault. The last two also alert
503STORE_UNAVAILABLE, LLM_UNAVAILABLE, LOG_UNAVAILABLEA dependency is down or a budget tripped