Read the Organization's spend this month against its spend cap

GET /v1/usage/spend

Answers the Organization's spend counter of the current UTC calendar month, its spend_cap_micros, what remains and the previous month's total (1.23.0, FR-usage-4, FR-dispatch-6). The counter counts live usage only, so every caller reads the same figures whatever the environment of its key. The api reads the counter as admission does and never rates at read time.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the usage:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/usage/spend" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/usage/spend`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/usage/spend",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Responses

Fields of the 200 answer

The shape is SpendSummary.