RYrye-com
Commissions

List commissions

Changed on

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

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/commissions
  • Auth
    API key in header Authorization

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
      }
    }
  ]
}

Changes

  • 0b28c67737d3Revision changes
    • info

      the security scope billing:read was added to the endpoint's security scheme bearerAuth

  • f95077641efeRevision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the new optional query request parameter checkoutIntentId

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status