Skip to main content
GET
Get payout breakdown

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Path Parameters

id
string
required

The id.

Query Parameters

periodStartMs
integer

Epoch-ms start of a historical cycle to look up. Omit to compute the current breakdown.

Response

The payment-breakdown details for the contract's payout.

data
object
required

Payment-breakdown details for a historical (or in-progress) payout of a contract. When no payment structure is found, breakdown is null and an error field is present. The exact field set varies by code path (live compute vs stored-ledger vs deleted-contract fallback); only the stable top-level fields are documented.