Get organization usage
curl --request GET \
--url https://api.allium.so/api/v1/account/organization/usage \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.allium.so/api/v1/account/organization/usage"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.allium.so/api/v1/account/organization/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.allium.so/api/v1/account/organization/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.allium.so/api/v1/account/organization/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.allium.so/api/v1/account/organization/usage")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/account/organization/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}Account API
Get organization usage
Fetch your organization’s current usage against its plan allocation.
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>'import requests
url = "https://api.allium.so/api/v1/account/organization/usage"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.allium.so/api/v1/account/organization/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.allium.so/api/v1/account/organization/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.allium.so/api/v1/account/organization/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.allium.so/api/v1/account/organization/usage")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/account/organization/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}Only available to organizations on an Allium Subscription or [Free
Trial] Allium Subscription plan.
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_amountsis 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 usescredits instead of explorer_units and developer_units:
{
"allocation_amounts": { "credits": 10000 },
"consumed_amounts": { "credits": 4321.5 }
}
Authorizations
Response
200 - application/json
Successful Response
Available options:
monthly, annual Shape depends on plan type: explorer/developer unit plans return explorer_units and developer_units; legacy plans return credits.
- ExplorerDeveloperUnitAmounts
- CreditsAmounts
Show child attributes
Show child attributes
Shape mirrors allocation_amounts.
- ExplorerDeveloperUnitUsageAmounts
- CreditsUsageAmounts
Show child attributes
Show child attributes
Was this page helpful?