Skip to main content
PATCH
Update a billing alert

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Body

application/json

Any subset of the mutable alert fields; at least one must be provided.

name
string
Maximum string length: 120
threshold_type
enum<string>
Available options:
spend_percent,
spend_amount,
balance_remaining,
daily_spend
threshold_value
number
currency
string
notify_emails
string<email>[]
notify_sms_numbers
string[]
action_on_hit
enum<string>
Available options:
notify,
pause_outbound,
block_outbound
cooldown_hours
integer
enabled
boolean

Response

200 - application/json

The updated billing alert.

data
object
meta
object