curl --get https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries \
-H "Authorization: Bearer $MACROSCOPE_API_KEY" \
--data-urlencode "startTime=2026-09-01T00:00:00Z" \
--data-urlencode "endTime=2026-10-01T00:00:00Z" \
--data-urlencode "pageSize=50"
import os, requests
r = requests.get(
"https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries",
headers={"Authorization": f"Bearer {os.environ['MACROSCOPE_API_KEY']}"},
params={
"startTime": "2026-09-01T00:00:00Z",
"endTime": "2026-10-01T00:00:00Z",
"pageSize": 50,
},
)
print(r.json())
const params = new URLSearchParams({
startTime: "2026-09-01T00:00:00Z",
endTime: "2026-10-01T00:00:00Z",
pageSize: "50",
});
const res = await fetch(
`https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries?${params}`,
{ headers: { Authorization: `Bearer ${process.env.MACROSCOPE_API_KEY}` } }
);
console.log(await res.json());
{
"meters": [
{
"id": "meter_abc123",
"meterCode": "meter_code_1",
"displayName": "Example meter",
"quantity": "2500.00",
"unit": "KB",
"usageAmount": {
"amount": "125.00",
"currency": "USD"
},
"periodStart": "2026-09-01T00:00:00Z",
"periodEnd": "2026-10-01T00:00:00Z",
"amountStatus": "BILLING_AMOUNT_STATUS_PROVISIONAL"
}
],
"nextPageToken": "token_def456",
"readTime": "2026-10-01T00:05:00Z"
}
{ "code": 16, "message": "unauthenticated" }
API
List billing meter summaries
Per-meter usage quantities and provisional priced amounts for a time interval.
curl --get https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries \
-H "Authorization: Bearer $MACROSCOPE_API_KEY" \
--data-urlencode "startTime=2026-09-01T00:00:00Z" \
--data-urlencode "endTime=2026-10-01T00:00:00Z" \
--data-urlencode "pageSize=50"
import os, requests
r = requests.get(
"https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries",
headers={"Authorization": f"Bearer {os.environ['MACROSCOPE_API_KEY']}"},
params={
"startTime": "2026-09-01T00:00:00Z",
"endTime": "2026-10-01T00:00:00Z",
"pageSize": 50,
},
)
print(r.json())
const params = new URLSearchParams({
startTime: "2026-09-01T00:00:00Z",
endTime: "2026-10-01T00:00:00Z",
pageSize: "50",
});
const res = await fetch(
`https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries?${params}`,
{ headers: { Authorization: `Bearer ${process.env.MACROSCOPE_API_KEY}` } }
);
console.log(await res.json());
{
"meters": [
{
"id": "meter_abc123",
"meterCode": "meter_code_1",
"displayName": "Example meter",
"quantity": "2500.00",
"unit": "KB",
"usageAmount": {
"amount": "125.00",
"currency": "USD"
},
"periodStart": "2026-09-01T00:00:00Z",
"periodEnd": "2026-10-01T00:00:00Z",
"amountStatus": "BILLING_AMOUNT_STATUS_PROVISIONAL"
}
],
"nextPageToken": "token_def456",
"readTime": "2026-10-01T00:05:00Z"
}
{ "code": 16, "message": "unauthenticated" }
Returns one row per meter with the complete usage total for the requested interval, sorted by
meterCode. Amounts cover the whole workspace and are provisional. Follow every page to list all meters.
For a daily series instead of one interval total per meter, use daily billing usage. Daily usage keeps independent rate series separate, including multiple rates on one meter.
Requires workspace Read. API keys can read only their bound workspace. Excluded/deleted repositories and unattributed usage remain included. Totals can lag activity; complete here means the requested interval’s total for each returned meter, not a guarantee of processing completeness or a final invoice.
Usage may be cached for up to one minute, and subscription and pricing information for up to five minutes. Even historical totals are provisional: they are not invoice amounts, balances, or net charges. Pages do not form a snapshot, and readTime is not a freshness guarantee.
Authorization
string
required
Bearer <key>. See Authentication.Path parameters
string
required
GITHUB_ORGANIZATION or GITHUB_USER.string
required
Numeric GitHub ID of the organization or user.
Query parameters
string
required
Inclusive start of the interval (RFC 3339). The interval is half-open,
[startTime, endTime), and at most 366 days. Usage is bucketed by UTC day, with minute resolution at partial-day boundaries.string
required
Exclusive end of the interval (RFC 3339). Must be after
startTime.integer
default:"50"
Rows per page, 1 to 200.
string
nextPageToken from the previous response. Keep all other parameters unchanged except pageSize. Tokens expire after 24 hours; on a 400, restart without a token.Response
object[]
Meter totals on this page.
Show properties
Show properties
string
Opaque row identifier.
string
Opaque meter code.
string
Meter display name.
string
Decimal usage quantity in
unit.string
Unit of
quantity. Byte meters priced per KB report KB (1000 bytes), rounded daily to two decimals.Money
Priced usage for the interval. Each UTC day is priced separately and rounded to cents.
string
Start of the summarized interval (RFC 3339).
string
End of the summarized interval (RFC 3339).
string
Always
BILLING_AMOUNT_STATUS_PROVISIONAL. Totals can change and can lag recent activity.string
Token for the next page. Omitted on the last page.
string
When the response was generated (RFC 3339). Not a data freshness timestamp.
Money
An omitted Money object means no value, not zero.string
Decimal amount in major units, e.g.
"12.50".string
ISO 4217 code, e.g.
"USD".curl --get https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries \
-H "Authorization: Bearer $MACROSCOPE_API_KEY" \
--data-urlencode "startTime=2026-09-01T00:00:00Z" \
--data-urlencode "endTime=2026-10-01T00:00:00Z" \
--data-urlencode "pageSize=50"
import os, requests
r = requests.get(
"https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries",
headers={"Authorization": f"Bearer {os.environ['MACROSCOPE_API_KEY']}"},
params={
"startTime": "2026-09-01T00:00:00Z",
"endTime": "2026-10-01T00:00:00Z",
"pageSize": 50,
},
)
print(r.json())
const params = new URLSearchParams({
startTime: "2026-09-01T00:00:00Z",
endTime: "2026-10-01T00:00:00Z",
pageSize: "50",
});
const res = await fetch(
`https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/meterSummaries?${params}`,
{ headers: { Authorization: `Bearer ${process.env.MACROSCOPE_API_KEY}` } }
);
console.log(await res.json());
{
"meters": [
{
"id": "meter_abc123",
"meterCode": "meter_code_1",
"displayName": "Example meter",
"quantity": "2500.00",
"unit": "KB",
"usageAmount": {
"amount": "125.00",
"currency": "USD"
},
"periodStart": "2026-09-01T00:00:00Z",
"periodEnd": "2026-10-01T00:00:00Z",
"amountStatus": "BILLING_AMOUNT_STATUS_PROVISIONAL"
}
],
"nextPageToken": "token_def456",
"readTime": "2026-10-01T00:05:00Z"
}
{ "code": 16, "message": "unauthenticated" }