---
title: "Settle product earnings"
method: POST
path: "/v1/products/{productId}/earnings/settlements"
tags: ["Products"]
---

# Settle product earnings

`POST /v1/products/{productId}/earnings/settlements`

## Request

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

Moves accumulated earnings from the product revenue account to the tenant settlement account. The ledger rejects settling more than the revenue account holds.

## Path parameters

- `productId` string, required: Hyperscale product ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'
- `Idempotency-Key` string, required

## Request body

- object
  - `transferId` string: Hyperscale transfer ID
  - `amount` string, required: Positive minor-unit integer amount serialized as a string (at most 18 digits)
  - `currency` 'SAR', required

## Response `201`

Success

- ProductEarningsSettleOutput
  - `transferId` string, required: Hyperscale transfer ID
  - `tenantId` string, required: Organization tenant ID
  - `productId` string, required: Hyperscale product ID
  - `sourceAccountId` string, required: Hyperscale account ID
  - `destinationAccountId` string, required: Hyperscale account ID
  - `amount` string, required: Positive minor-unit integer amount serialized as a string (at most 18 digits)
  - `currency` 'SAR', required
  - `transferStatus` 'posted', 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)