---
title: "Retrieve the company usage statement"
method: GET
path: "/v1/usage/statement"
tags: ["History", "Founder login"]
---

# Retrieve the company usage statement

`GET /v1/usage/statement`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/usage/statement`
- Auth: HTTP bearer

Returns the company's priced usage for one month: the total, what was collected, and what is still owed, broken down by meter and by day.

## Query parameters

- `period` string: UTC calendar month in YYYY-MM form

## Headers

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

## Response `200`

Success

- UsageStatementOutput
  - `tenantId` string, required: Organization tenant ID
  - `period` string, required: UTC calendar month in YYYY-MM form
  - `currency` 'SAR', required
  - `totalAmount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `collectedAmount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `outstandingAmount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `previewTotalAmount` string: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `meters` object[], required
    - `meter` 'account.active_month' | 'account.created.count' | 'transfer.internal.count' | 'transfer.internal.volume_sar' | 'instrument.event.count' | 'operation.executed.count' | 'billing.plan.recurring_month', required
    - `productId` string: Hyperscale product ID
    - `quantity` string, required
    - `rate` union, required
      - object
        - `kind` 'per_event', required
        - `value` string, required: Halalas (minor units) per event
      - object
        - `kind` 'volume_bps', required
        - `value` string, required: Basis points of the moved amount; a ratio, not money
      - object
        - `kind` 'recurring', required
        - `value` string, required: Halalas (minor units): the Product's full monthly platform fee
    - `amount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `collectedAmount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `currency` 'SAR', required
    - `previewAmount` string: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `daily` object[], required
    - `day` string, date, required
    - `meter` 'account.active_month' | 'account.created.count' | 'transfer.internal.count' | 'transfer.internal.volume_sar' | 'instrument.event.count' | 'operation.executed.count' | 'billing.plan.recurring_month', required
    - `quantity` string, required
  - `architect` object[], required
    - `day` string, date, required
    - `turns` integer, required
  - `issuer` string, required

## 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)