---
title: "Retrieve a Usage record"
method: GET
path: "/v1/usage-records/{usageRecordId}"
tags: ["History"]
---

# Retrieve a Usage record

`GET /v1/usage-records/{usageRecordId}`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/usage-records/{usageRecordId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Retrieve a single Usage record by its usageRecordId. One metered event with its quantity, settlement point, operation, and priced amount. Usage records roll up into the period statement.

## Path parameters

- `usageRecordId` string, required

## Query parameters

- `productId` string: Hyperscale product ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'

## Response `200`

Success

- UsageRecordRetrieveOutput
  - `usageRecordId` string, required: Hyperscale usage record ID
  - `tenantId` string, required: Organization tenant ID
  - `meter` string, required
  - `quantity` string
  - `unitPrice` string: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `amount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `currency` string, required
  - `previewAmount` string: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `operationName` string
  - `operationId` string: Hyperscale operation ID
  - `sourceEventId` string
  - `sourceOperationId` string
  - `productId` string: Hyperscale product ID
  - `settledAt` 'execution' | 'invoice', required
  - `createdAt` string, date-time

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)