Commissions

List commissions

Every commission says which rule and which branch produced it.

Scope: read

get/v1/commissions

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/commissions
  • Auth: HTTP bearer

Query parameters

program_idstring required

Required on every list

Example:prg_7uSyy9FqVLCFWrdPeZaK
limitstring

1 to 100, default 25

Example:25
starting_afterstring

Object id; returns the page after it (older)

ending_beforestring

Object id; returns the page before it (newer)

string
OR
string[]
string
OR
string[]
partner_idstring
status'pending' | 'approved' | 'due' | 'paid' | 'rejected' | 'voided'
sale_idstring
payout_idstring
kind'referral' | 'reward' | 'clawback'

Response

Commissions

has_moreboolean required

Pass the last object's id as starting_after to fetch the next page

total_countinteger required

Count of every object matching the filters, ignoring the cursor

Example response

{
  "data": [
    {
      "id": "com_7uSyy9FqVLCFWrdPeZaK",
      "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
      "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
      "sale_id": "sale_7uSyy9FqVLCFWrdPeZaK",
      "customer_id": "cus_7uSyy9FqVLCFWrdPeZaK",
      "rule_id": "flw_7uSyy9FqVLCFWrdPeZaK",
      "rule_branch_id": "flb_7uSyy9FqVLCFWrdPeZaK",
      "amount_minor": 2500,
      "revenue_minor": 2500,
      "currency": "USD",
      "mature_at": "2026-08-21T10:15:30.000Z",
      "approved_at": "2026-08-21T10:15:30.000Z",
      "voided_at": "2026-08-21T10:15:30.000Z",
      "payout_id": "pyt_7uSyy9FqVLCFWrdPeZaK",
      "created_at": "2026-08-21T10:15:30.000Z",
      "updated_at": "2026-08-21T10:15:30.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.