Create usage alert

POST

/v1/usage_alerts/

Create a new usage alert for a subscription and metric.

Request Body ^required

UsageAlertCreate

object

subscription_id

required

Subscription Id

string format: uuid

billable_metric_id

required

Billable Metric Id

string format: uuid

threshold_value

required

Any of:

number

number

> 0

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

recurring

Recurring

boolean

name

Any of:

string

string

<= 255 characters

null

null

Responses

201

Successful Response

UsageAlertResponse

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

subscription_id

required

Subscription Id

string format: uuid

billable_metric_id

required

Billable Metric Id

string format: uuid

threshold_value

required

Threshold Value

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

recurring

required

Recurring

boolean

name

Any of:

string

string

null

null

times_triggered

required

Times Triggered

integer

triggered_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized – invalid or missing API key

404

Subscription or billable metric not found

422

Validation error