Skip to main content
GET
/
api
/
v1
/
account
/
organization
/
usage
Get organization usage
curl --request GET \
  --url https://api.allium.so/api/v1/account/organization/usage \
  --header 'X-API-KEY: <api-key>'
{
  "billing_period_start": "2026-04-01T00:00:00Z",
  "billing_period_end": "2026-05-01T00:00:00Z",
  "allocation_period_start": "2026-04-01T00:00:00Z",
  "allocation_period_end": "2026-05-01T00:00:00Z",
  "allocation_cadence": "monthly",
  "allocation_amounts": {
    "explorer_units": 100,
    "developer_units": 2000000
  },
  "consumed_amounts": {
    "explorer_units": 12.5,
    "developer_units": 341523
  }
}
This is a beta endpoint currently under active development. We’re working to stabilize the API and will minimize breaking changes wherever possible, but they may still occur as we refine the interface.For production support or migration assistance, reach out at hello@allium.so.
Only available to organizations on an Allium Subscription or [Free Trial] Allium Subscription plan.
Returns your organization’s included and consumed Explorer and Developer units for the current allocation period. For a visual breakdown by endpoint, user, source, and more, see Usage & Billing in the Allium app.

​
Billing period vs. allocation period

Billing period is always monthly, but your organization’s included allocation may be on a different cadence.
  • Monthly allocation: Allocation and billing periods will be the same.
  • Annual allocation: Allocation period spans a year. consumed_amounts is the cumulative total across that year.

​
Trial organizations

For organizations on trial without a periodic allocation, the allocation fields can be ignored. consumed_amounts reports current billing period usage.

​
Legacy credits plans

For organizations on Allium’s earlier credits-based plan, the response uses credits instead of explorer_units and developer_units: 
{
  "allocation_amounts": { "credits": 10000 },
  "consumed_amounts": { "credits": 4321.5 }
}

Authorizations

​
X-API-KEY
string
header
required

Response

200 - application/json

Successful Response

​
billing_period_start
string<date-time>
required
​
billing_period_end
string<date-time>
required
​
allocation_period_start
string<date-time> | null
required
​
allocation_period_end
string<date-time> | null
required
​
allocation_cadence
enum<string> | null
required
Available options:
monthly,
annual
​
allocation_amounts
ExplorerDeveloperUnitAmounts · object
required

Shape depends on plan type: explorer/developer unit plans return explorer_units and developer_units; legacy plans return credits.

​
consumed_amounts
ExplorerDeveloperUnitUsageAmounts · object
required

Shape mirrors allocation_amounts.