API Reference

Admin

Organization

Spend Alerts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create organization spend alert

$ openai admin:organization:spend-alerts create

POST/organization/spend_alerts

Creates an organization spend alert.

ParametersExpand Collapse

--currency: "USD"

The currency for the threshold amount.

--interval: "month"

The time interval for evaluating spend against the threshold.

--notification-channel: object { recipients, type, subject_prefix }

Email notification settings for a spend alert.

--threshold-amount: number

The alert threshold amount, in cents.

ReturnsExpand Collapse

organization_spend_alert: object { 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.

"USD"

interval: "month"

The time interval for evaluating spend against the threshold.

"month"

notification_channel: object { recipients, type, subject_prefix }

Email notification settings for a spend alert.

recipients: array of string

Email addresses that receive the spend alert notification.

type: "email"

The notification channel type. Currently only email is supported.

subject_prefix: optional string

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.

Create organization spend alert

CLI Tool

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

openai admin:organization:spend-alerts create \
  --admin-api-key 'My Admin API Key' \
  --currency USD \
  --interval month \
  --notification-channel '{recipients: [string], type: email}' \
  --threshold-amount 0

{
    "id": "alert_abc123",
    "object": "organization.spend_alert",
    "threshold_amount": 100000,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
        "type": "email",
        "recipients": ["finance@example.com"],
        "subject_prefix": "OpenAI spend alert"
    }
}

Returns Examples

{
    "id": "alert_abc123",
    "object": "organization.spend_alert",
    "threshold_amount": 100000,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
        "type": "email",
        "recipients": ["finance@example.com"],
        "subject_prefix": "OpenAI spend alert"
    }
}