Skip to main content
POST
Create a billing alert

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required
Maximum string length: 120
threshold_type
enum<string>
required
Available options:
spend_percent,
spend_amount,
balance_remaining,
daily_spend
threshold_value
number
required

Percent (0-100) for spend_percent, otherwise an integer number of cents.

currency
string
default:USD

ISO-4217 currency code.

notify_emails
string<email>[]

Up to 20 email recipients.

notify_sms_numbers
string[]

Up to 20 E.164 SMS recipients. At least one email or SMS recipient is required.

action_on_hit
enum<string>
default:notify
Available options:
notify,
pause_outbound,
block_outbound
cooldown_hours
integer
default:24

Minimum hours between re-triggers of the same alert.

enabled
boolean
default:true

Response

201 - application/json

The created billing alert.

data
object
meta
object