Settle product earnings
product.earnings.settle
Moves accumulated earnings from the product revenue account to the tenant settlement account. The ledger rejects settling more than the revenue account holds.
POST /v1/products/{productId}/earnings/settlements
Scopes: transfer:write
Input
| Field | Type | Description |
|---|---|---|
productId required | string | Hyperscale product ID |
transferId | string | Hyperscale transfer ID |
amount required | string | Positive minor-unit integer amount serialized as a string (at most 18 digits) |
currency required | string | |
idempotencyKey required | string | New per change; reuse only to retry it. |
confirmation required | product_earnings_settle | product.earnings.settle | This tool's name, once the founder agrees. |
Request sample
curl --request POST 'https://console.hyperscale0.ai/v1/products/{productId}/earnings/settlements' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": "<string>",
"currency": "<string>",
"idempotencyKey": "<string>",
"confirmation": "<product_earnings_settle | product.earnings.settle>"
}'