API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Spend Alerts

List organization spend alerts

SpendAlertListPage admin().organization().spendAlerts().list(SpendAlertListParamsparams = SpendAlertListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/organization/spend_alerts

Create organization spend alert

OrganizationSpendAlert admin().organization().spendAlerts().create(SpendAlertCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/organization/spend_alerts

Update organization spend alert

OrganizationSpendAlert admin().organization().spendAlerts().update(SpendAlertUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/organization/spend_alerts/{alert_id}

Delete organization spend alert

OrganizationSpendAlertDeleted admin().organization().spendAlerts().delete(SpendAlertDeleteParamsparams = SpendAlertDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/organization/spend_alerts/{alert_id}

ModelsExpand Collapse

class OrganizationSpendAlert:

Represents a spend alert configured at the organization level.

String id

The identifier, which can be referenced in API endpoints.

Currency currency

The currency for the threshold amount.

Interval interval

The time interval for evaluating spend against the threshold.

NotificationChannel notificationChannel

Email notification settings for a spend alert.

List<String> recipients

Email addresses that receive the spend alert notification.

JsonValue; type "email"constant"email"constant

The notification channel type. Currently only email is supported.

Optional<String> subjectPrefix

Optional subject prefix for alert emails.

JsonValue; object_ "organization.spend_alert"constant"organization.spend_alert"constant

The object type, which is always organization.spend_alert.

long thresholdAmount

The alert threshold amount, in cents.

class OrganizationSpendAlertDeleted:

Confirmation payload returned after deleting an organization spend alert.

String id

The deleted spend alert ID.

boolean deleted

Whether the spend alert was deleted.

JsonValue; object_ "organization.spend_alert.deleted"constant"organization.spend_alert.deleted"constant

Always organization.spend_alert.deleted.