---
title: "Retrieve the product margin view"
method: GET
path: "/v1/products/{productId}/margin"
tags: ["Products"]
---

# Retrieve the product margin view

`GET /v1/products/{productId}/margin`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/products/{productId}/margin`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Joins the product's frozen plan rate card (the buy side: what the tenant pays Hyperscale per earnable operation) with its configured earn rates (the sell side: what the tenant charges on the same operations) into one per-operation margin line, so the tenant sees what each business event nets before setting prices.

## Path parameters

- `productId` string, required: Hyperscale product ID

## Headers

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

## Response `200`

Success

- ProductMarginRetrieveOutput
  - `asOf` string, date-time, required
  - `items` object[], required
    - `operationName` string, required
    - `sell` object, required: The tenant's configured earn rate on this operation.
      - `bps` string: Basis points of the moved amount; a ratio, not money
      - `flatAmount` string: Halalas (minor units) per operation
    - `buy` object, required: What the product's frozen plan rate card charges for this operation's meters.
      - `volumeBps` string: Basis points of the moved amount; a ratio, not money
      - `perEvent` string: Halalas (minor units) per operation
    - `net` object, required: Sell minus buy on each axis; negative when the earn rate does not cover the plan rate.
      - `bps` string, required: Basis points of the moved amount; a ratio, not money
      - `perEvent` string, required: Halalas (minor units) per operation, sell minus buy

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