History
Founder login

Retrieve the company usage statement

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.

get/v1/usage/statement

Request

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

Query parameters

periodstring

UTC calendar month in YYYY-MM form

Headers

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

Response

Success

tenantIdstring required

Organization tenant ID

periodstring required

UTC calendar month in YYYY-MM form

currency'SAR' required
totalAmountstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

collectedAmountstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

outstandingAmountstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

previewTotalAmountstring

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

issuerstring required

Changes

No recorded changes to this operation across all 1 revision of this API.