Retrieve a project spend alert | Sample

2 parameters

project_idstringrequired

The unique identifier of the project containing the spend alert.

alert_idstringrequired

The unique identifier of the project spend alert to retrieve.

1 status code

200Returns the project spend alert with its identifier, object type, threshold amount, currency, interval, and notification channel.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always `project.spend_alert`.

Allowed:project.spend_alert

threshold_amountintegerrequired

The alert threshold amount, in cents.

currencystringrequired

The currency for the threshold amount.

Allowed:USD

intervalstringrequired

The time interval for evaluating spend against the threshold.

Allowed:month

notification_channelobjectrequired

Email notification settings for a spend alert.

Error handling

project_id must identify the project containing the alert, and alert_id must identify the project spend alert to retrieve. The returned alert uses USD and a monthly evaluation interval.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.spendAlerts.get({
  projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  alertId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "project.spend_alert",
  "threshold_amount": 1,
  "currency": "USD",
  "interval": "month",
  "notification_channel": {
    "type": "email",
    "recipients": [
      "example_value"
    ],
    "subject_prefix": "example_value"
  }
}

Request

Response

Errors