Skip to content

Get usage alert

GET
/v1/usage_alerts/{alert_id}

Get a usage alert by ID.

alert_id
required
Alert Id
string format: uuid

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
times_triggered
required
Times Triggered
integer
triggered_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized – invalid or missing API key

Usage alert not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object