Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a billing alert

Retrieves a billing alert given an ID

get/v1/billing/alerts/{id}

Path parameters

idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

alert_type'usage_threshold' required

Defines the type of the alert.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'billing.alert' required

String representing the object's type. Objects of the same type share the same value.

status'active' | 'archived' | 'inactive' nullable

Status of the alert. This can be active, inactive or archived.

titlestring required

Title of the alert.