Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
integer<int32>

Maximum number of results to return (default 100)

Required range: 1 <= x <= 100
after
string

Cursor from a previous response's pageInfo.endCursor

before
string

Cursor from a previous response's pageInfo.startCursor

type
enum<string>

Type of commission earned on an order. Canonical definition used by both the API contract and the internal @rye-com/ci-commissions package.

Available options:
surcharge,
promo_arbitrage,
discount_code,
affiliate,
out_of_band
status
enum<string>

Lifecycle status of a commission record.

Available options:
pending,
confirmed,
updated,
finalized,
refunded,
expired
checkoutIntentId
string

Response

Paginated commissions response

Paginated commissions response. Use pageInfo.endCursor as the next page's after query parameter to walk forward; use pageInfo.startCursor as the next page's before query parameter to walk backward.

pageInfo
object
required
data
object[]
required