Skip to main content
GET
Get Organization Usage
Only available to organizations on an Allium Subscription or [Free Trial] Allium Subscription plan, or a Dedicated Warehouse plan.
Returns your organization’s included and consumed Explorer and Developer units for the current allocation period, plus its Explorer query count for the current monthly billing 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.
billing_period_explorer_query_count always covers the monthly billing period, including for organizations with annual allocations. A value of null means query usage is unavailable. A value of 0 means no query events were recorded in that period.

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:

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_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.

allocation_period_start
string<date-time> | null
allocation_period_end
string<date-time> | null
allocation_cadence
string | null
billing_period_explorer_query_count
integer | null

Explorer query count for the current monthly billing period. Null if unavailable.