Skip to main content
GET
/
commissions
List commissions
curl --request GET \
  --url https://api.affonso.io/v1/commissions \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "referral_id": "<string>",
      "affiliate_id": "<string>",
      "program_id": "<string>",
      "sale_amount": 123,
      "sale_amount_currency": "<string>",
      "commission_amount": 123,
      "commission_currency": "<string>",
      "status": "pending",
      "sales_status": "pending",
      "is_subscription": true,
      "payment_intent_id": "<string>",
      "hold_period_days": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_prev_page": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Query Parameters

page
integer
default:1

Page number

limit
integer
default:50

Items per page

Required range: x <= 200
status
enum<string>

Filter by commission status

Available options:
pending,
approved,
ready_for_payment,
paid,
rejected,
refunded
sales_status
enum<string>

Filter by sale status

Available options:
pending,
complete,
refunded,
failed
referral_id
string

Filter by referral ID

affiliate_id
string

Filter by affiliate ID

expand
string

Comma-separated fields to expand

Example:

"affiliate,referral,affiliate_program"

sort
string

Sort field and direction

Example:

"createdAt:desc"

dateFrom
string<date-time>
dateTo
string<date-time>

Response

List of commissions

success
boolean
data
object[]
pagination
object