Commissions
List commissions
List commissions for the authenticated developer
Returns a paginated list of commissions with optional filters using cursor-based pagination. Pass the endCursor from a previous response as after to fetch the next page, or the startCursor as before to fetch the previous page. Specifying both after and before returns 422.
get/api/v1/commissions
Query parameters
limitinteger
Maximum number of results to return (default 100)
afterstring
Cursor from a previous response's pageInfo.endCursor
beforestring
Cursor from a previous response's pageInfo.startCursor
type'surcharge' | 'promo_arbitrage' | 'discount_code' | 'affiliate' | 'out_of_band'
Type of commission earned on an order. Canonical definition used by both the API contract and the internal @rye-com/ci-commissions package.
status'pending' | 'confirmed' | 'updated' | 'finalized' | 'refunded' | 'expired'
Lifecycle status of a commission record.
checkoutIntentIdstring
Response
Paginated commissions response
Example response
{
"data": [
{
"ryeFee": {
"currencyCode": "USD",
"amountSubunits": 1500
},
"developerCommission": {
"currencyCode": "USD",
"amountSubunits": 1500
}
}
]
}