Commission rules

List commission rules

Ordered by priority then specificity (partner beats group beats program-wide). Each rule carries its ordered branches; the first matching branch wins, falling back to the rule's own rate.

Scope: read

get/v1/rules

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/rules
  • 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[]
status'active' | 'inactive'
group_idstring
partner_idstring

Response

Commission rules

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": "flw_7uSyy9FqVLCFWrdPeZaK",
      "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
      "group_id": "grp_7uSyy9FqVLCFWrdPeZaK",
      "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
      "switch_to_group_id": "grp_7uSyy9FqVLCFWrdPeZaK",
      "branches": [
        {
          "id": "flb_7uSyy9FqVLCFWrdPeZaK",
          "rule_id": "flw_7uSyy9FqVLCFWrdPeZaK",
          "created_at": "2026-08-21T10:15:30.000Z",
          "updated_at": "2026-08-21T10:15:30.000Z"
        }
      ],
      "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.