Get usage alert status with current usage

GET

/v1/usage_alerts/{alert_id}/status

Get current usage status for a usage alert.

Parameters

Path Parameters

alert_id

required

Alert Id

string format: uuid

Responses

200

Successful Response

UsageAlertStatusResponse

object

alert_id

required

Alert Id

string format: uuid

current_usage

required

Current Usage

string

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

threshold_value

required

Threshold Value

string

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

usage_percentage

required

Usage Percentage

string

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

billing_period_start

required

Billing Period Start

string format: date-time

billing_period_end

required

Billing Period End

string format: date-time

401

Unauthorized – invalid or missing API key

404

Usage alert, subscription, plan, or customer not found

422

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