v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB
Affiliates

List affiliate commissions

Retrieve a paginated list of an affiliate’s commissions. Filter by settlement status (pending, approved, paid).

get/v1/affiliates/{id}/commissions

Path parameters

idstring required

The unique identifier of the affiliate

Query parameters

status'pending' | 'approved' | 'paid'

The settlement status of the commission. pending while on hold, approved once cleared and available, paid once settled by a payout.

The settlement status of the commission. pending while on hold, approved once cleared and available, paid once settled by a payout.

page_numbernumber
Example:1

The page number for pagination.

page_sizenumber
Example:10

The number of items per page.

Response

Successfully retrieved affiliate commissions

Example response

{
  "items": [
    {
      "object": "commission",
      "affiliate": "aff_1234567890",
      "amount": 600,
      "currency": "USD",
      "sale": "tran_1234567890"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2
  }
}