Skip to main content
GET
/
api
/
v1
/
commissions
JavaScript
import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const commission of client.commissions.list()) {
  console.log(commission.id);
}
{
  "pageInfo": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  },
  "data": [
    {
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "ryeFee": {
        "currencyCode": "USD",
        "amountSubunits": 1500
      },
      "developerCommission": {
        "currencyCode": "USD",
        "amountSubunits": 1500
      },
      "checkoutIntentId": "<string>",
      "id": "<string>",
      "finalizedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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