Get the organization spend limit | Sample

1 status code

200Returns an organization spend limit object with the `organization.spend_limit` object type, threshold amount in cents, currency, evaluation interval, and enforcement status.

objectstringrequired

The object type, which is always `organization.spend_limit`.

Allowed:organization.spend_limitDefault:organization.spend_limit

threshold_amountintegerrequired

The hard spend limit amount, in cents.

currencystringrequired

The currency for the threshold amount. Currently, only `USD` is supported.

intervalstringrequired

The time interval for evaluating spend against the threshold. Currently, only `month` is supported.

enforcementobjectrequired

The current enforcement state of the hard spend limit.

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.spendLimit.list();

{
  "object": "organization.spend_limit",
  "threshold_amount": 1,
  "currency": "example_value",
  "interval": "example_value",
  "enforcement": {
    "status": "active"
  }
}