Retrieve a Product's books
product.books.retrieve
One read for a Product's money: cash and claims now, revenue to date, and earnings, payouts, Hyperscale fees and gross revenue by business month. The months use the same posted figures as the company finance report narrowed to this Product; sandbox months use the Product's business time.
GET /v1/products/{productId}/books
Scopes: account:read
Input
| Field | Type | Description |
|---|---|---|
productId required | string | Hyperscale product ID |
fromPeriod | string | First business month. With neither month, the books run from the first posting to the Product clock's month, at most 24 months. |
toPeriod | string | Last business month. |
Request sample
curl --request GET 'https://console.hyperscale0.ai/v1/products/{productId}/books' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox'