> ## Documentation Index
> Fetch the complete documentation index at: https://www.scrums.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage Records

> Metered usage events for billing and observability. Usage records are immutable and generated automatically by the platform.

<Warning>
  The Scrums.com API is **planned and not yet publicly available**. Endpoints and behaviour are subject to change before release.
</Warning>

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

| Method | Path                                       | Description                            |
| ------ | ------------------------------------------ | -------------------------------------- |
| `GET`  | `/v1/organizations/{org_id}/usage-records` | List 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

| Field             | Type     | Description                                                            |
| ----------------- | -------- | ---------------------------------------------------------------------- |
| `id`              | string   | Unique identifier                                                      |
| `organization_id` | string   | Parent organization reference                                          |
| `resource_id`     | string   | Resource that generated this record                                    |
| `subscription_id` | string   | Associated subscription reference                                      |
| `metric`          | string   | Metric name (e.g. `compute.hours`, `talent.hours`, `agent.executions`) |
| `quantity`        | number   | Measured quantity                                                      |
| `unit`            | string   | Unit of measure                                                        |
| `recorded_at`     | datetime | When the usage was recorded                                            |

## Relationships

<Note>
  Usage records are generated by [Resources](/docs/api-reference/core/resources) and [Subscriptions](/docs/api-reference/core/subscriptions), and are aggregated into [Invoices](/docs/api-reference/core/invoices).
</Note>