Spend Alerts

List organization spend alerts

client.admin.organization.spendAlerts.list(?, ?): ConversationCursorPage<OrganizationSpendAlert { id, currency, interval, 3 more } >

GET/organization/spend_alerts

Create organization spend alert

client.admin.organization.spendAlerts.create(, ?): OrganizationSpendAlert { id, currency, interval, 3 more }

POST/organization/spend_alerts

Retrieve organization spend alert

client.admin.organization.spendAlerts.retrieve(, ?): OrganizationSpendAlert { id, currency, interval, 3 more }

GET/organization/spend_alerts/{alert_id}

Update organization spend alert

client.admin.organization.spendAlerts.update(, , ?): OrganizationSpendAlert { id, currency, interval, 3 more }

POST/organization/spend_alerts/{alert_id}

Delete organization spend alert

client.admin.organization.spendAlerts.delete(, ?): OrganizationSpendAlertDeleted { id, deleted, object }

DELETE/organization/spend_alerts/{alert_id}

ModelsExpand Collapse

OrganizationSpendAlert { id, currency, interval, 3 more }

Represents a spend alert configured at the organization level.

id: string

The identifier, which can be referenced in API endpoints.

currency: "USD"

The currency for the threshold amount.

interval: "month"

The time interval for evaluating spend against the threshold.

notification_channel: NotificationChannel { recipients, type, subject_prefix }

Email notification settings for a spend alert.

recipients: Array<string>

Email addresses that receive the spend alert notification.

type: "email"

The notification channel type. Currently only email is supported.

subject_prefix?: string | null

Optional subject prefix for alert emails.

object: "organization.spend_alert"

The object type, which is always organization.spend_alert.

threshold_amount: number

The alert threshold amount, in cents.

OrganizationSpendAlertDeleted { id, deleted, object }

Confirmation payload returned after deleting an organization spend alert.

id: string

The deleted spend alert ID.

deleted: boolean

Whether the spend alert was deleted.

object: "organization.spend_alert.deleted"

Always organization.spend_alert.deleted.

Suggested