Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization

Spend Alerts

List organization spend alerts
admin.organization.spend_alerts.list(SpendAlertListParams**kwargs) -> SyncConversationCursorPage[OrganizationSpendAlert]
GET/organization/spend_alerts
Create organization spend alert
admin.organization.spend_alerts.create(SpendAlertCreateParams**kwargs) -> OrganizationSpendAlert
POST/organization/spend_alerts
Update organization spend alert
admin.organization.spend_alerts.update(stralert_id, SpendAlertUpdateParams**kwargs) -> OrganizationSpendAlert
POST/organization/spend_alerts/{alert_id}
Delete organization spend alert
admin.organization.spend_alerts.delete(stralert_id) -> OrganizationSpendAlertDeleted
DELETE/organization/spend_alerts/{alert_id}
ModelsExpand Collapse
class OrganizationSpendAlert: …

Represents a spend alert configured at the organization level.

id: str

The identifier, which can be referenced in API endpoints.

currency: Literal["USD"]

The currency for the threshold amount.

interval: Literal["month"]

The time interval for evaluating spend against the threshold.

notification_channel: NotificationChannel

Email notification settings for a spend alert.

recipients: List[str]

Email addresses that receive the spend alert notification.

type: Literal["email"]

The notification channel type. Currently only email is supported.

subject_prefix: Optional[str]

Optional subject prefix for alert emails.

object: Literal["organization.spend_alert"]

The object type, which is always organization.spend_alert.

threshold_amount: int

The alert threshold amount, in cents.

class OrganizationSpendAlertDeleted: …

Confirmation payload returned after deleting an organization spend alert.

id: str

The deleted spend alert ID.

deleted: bool

Whether the spend alert was deleted.

object: Literal["organization.spend_alert.deleted"]

Always organization.spend_alert.deleted.