Skip to content
Primary navigation

Delete organization spend alert

client.admin.organization.spendAlerts.delete(stringalertID, RequestOptionsoptions?): OrganizationSpendAlertDeleted { id, deleted, object }
DELETE/organization/spend_alerts/{alert_id}

Deletes an organization spend alert.

ParametersExpand Collapse
alertID: string
ReturnsExpand Collapse
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.

Delete organization spend alert

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const organizationSpendAlertDeleted = await client.admin.organization.spendAlerts.delete(
  'alert_id',
);

console.log(organizationSpendAlertDeleted.id);
{
    "id": "alert_abc123",
    "object": "organization.spend_alert.deleted",
    "deleted": true
}
Returns Examples
{
    "id": "alert_abc123",
    "object": "organization.spend_alert.deleted",
    "deleted": true
}