Company Usage

The company usage resource.

Basehttps://rest.carbon.ms/companyUsage

GET/companyUsage

List company usages

Retrieve a paginated list of company usages. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/companyUsage

curl --request GET \
  --url 'https://rest.carbon.ms/companyUsage?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "users": 0,
    "tasks": 0,
    "aiTokens": 0,
    "nextResetDatetime": "2026-01-01T00:00:00Z",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/companyUsage

Retrieve a company usage

Fetch a single company usage by filtering on `id`.

Query parameters

idstring

Match on the company usage's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/companyUsage

curl --request GET \
  --url 'https://rest.carbon.ms/companyUsage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "users": 0,
  "tasks": 0,
  "aiTokens": 0,
  "nextResetDatetime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/companyUsage

Create a company usage

Create a new company usage.

Body parameters

usersnumberrequired

tasksnumberrequired

aiTokensnumberrequired

nextResetDatetimetimestamprequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/companyUsage

curl --request POST \
  --url https://rest.carbon.ms/companyUsage \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"users":0,"tasks":0,"aiTokens":0,"nextResetDatetime":"2026-01-01T00:00:00Z","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "users": 0,
  "tasks": 0,
  "aiTokens": 0,
  "nextResetDatetime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/companyUsage

Update a company usage

Update an existing company usage, matched on `id`.

Body parameters

usersnumberrequired

tasksnumberrequired

aiTokensnumberrequired

nextResetDatetimetimestamprequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/companyUsage

curl --request PATCH \
  --url 'https://rest.carbon.ms/companyUsage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"users":0}'

Response

{
  "id": "abc123def456",
  "users": 0,
  "tasks": 0,
  "aiTokens": 0,
  "nextResetDatetime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/companyUsage

Delete a company usage

Delete a company usage, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the company usage to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/companyUsage

curl --request DELETE \
  --url 'https://rest.carbon.ms/companyUsage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content