Skip to main content
The Scrums.com API is planned and not yet publicly available. Endpoints and behaviour are subject to change before release.
Usage records are immutable, timestamped measurements of platform consumption — compute hours, storage, API calls, talent hours, agent executions, and more. They are generated automatically and feed directly into invoice generation. Usage records are read-only. They cannot be created or modified via the API.

Base path

/v1/usage-records

Endpoints

MethodPathDescription
GET/v1/organizations/{org_id}/usage-recordsList usage records for an organization
GET/v1/usage-records/{id}Get a usage record

Filtering

Usage records support filtering by resource_id, metric, from, to, and subscription_id query parameters.

Attributes

FieldTypeDescription
idstringUnique identifier
organization_idstringParent organization reference
resource_idstringResource that generated this record
subscription_idstringAssociated subscription reference
metricstringMetric name (e.g. compute.hours, talent.hours, agent.executions)
quantitynumberMeasured quantity
unitstringUnit of measure
recorded_atdatetimeWhen the usage was recorded

Relationships

Usage records are generated by Resources and Subscriptions, and are aggregated into Invoices.
Last modified on April 15, 2026