Skip to content

List usage alerts

GET
/v1/usage_alerts/

List usage alerts with optional subscription filter.

skip
Skip
integer
0
limit
Limit
integer
default: 100 >= 1 <= 1000
order_by
Any of:
string
subscription_id
Any of:
string format: uuid

Successful Response

Response List Usage Alerts V1 Usage Alerts Get
Array<object>
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

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