GET
/
commissions
Python
from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.commissions.list(request={
        "page_size": 50,
    })

    assert res is not None

    # Handle response
    print(res)
[
  {
    "id": "cm_1JVR7XRCSR0EDBAF39FZ4PMYE",
    "type": "click",
    "amount": 123,
    "earnings": 123,
    "currency": "<string>",
    "status": "pending",
    "invoiceId": "<string>",
    "description": "<string>",
    "quantity": 123,
    "userId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "partner": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "image": "<string>",
      "payoutsEnabledAt": "<string>",
      "country": "<string>"
    },
    "customer": {
      "id": "<string>",
      "externalId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatar": "<string>",
      "country": "<string>",
      "sales": 123,
      "saleAmount": 123,
      "createdAt": "<string>"
    }
  }
]
Commissions endpoints require an Business plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
type
enum<string>
Available options:
click,
lead,
sale,
custom
​
customerId
string

Filter the list of commissions by the associated customer.

​
payoutId
string

Filter the list of commissions by the associated payout.

​
partnerId
string

Filter the list of commissions by the associated partner.

​
invoiceId
string

Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice.

​
status
enum<string>

Filter the list of commissions by their corresponding status.

Available options:
pending,
processed,
paid,
refunded,
duplicate,
fraud,
canceled
​
sortBy
enum<string>
default:createdAt

The field to sort the list of commissions by.

Available options:
createdAt,
amount
​
sortOrder
enum<string>
default:desc

The sort order for the list of commissions.

Available options:
asc,
desc
​
interval
enum<string>
default:all

The interval to retrieve commissions for.

Available options:
24h,
7d,
30d,
90d,
1y,
mtd,
qtd,
ytd,
all
​
start
string

The start date of the date range to filter the commissions by.

​
end
string

The end date of the date range to filter the commissions by.

​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

200
application/json

The list of commissions.

The response is of type object[].