RYrye-com
Commissions

Retrieve commission

Changed on

Retrieve a commission by id

Returns commission details for the authenticated developer.

get/api/v1/commissions/{id}

Request

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

Path parameters

idstring required

The id of the commission to look up

Response

Commission details

finalizedAtstring date-time

Time the commission moved to a terminal status. Unset until finalized.

updatedAtstring date-time required

Time the commission last changed (e.g. status transition).

createdAtstring date-time required

Time the commission was first recorded.

settlementDirection'rye_owes_developer' | 'developer_owes_rye' required

Direction of settlement: who owes whom once the commission is finalized.

status'pending' | 'confirmed' | 'updated' | 'finalized' | 'refunded' | 'expired' required

Lifecycle status of a commission record.

type'surcharge' | 'promo_arbitrage' | 'discount_code' | 'affiliate' | 'out_of_band' required

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

checkoutIntentIdstring required

The checkout intent this commission was generated from.

idstring required

Unique identifier for this commission.

Example response

{
  "ryeFee": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "developerCommission": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  }
}

Changes