List all commissions
Retrieve a paginated list of commissions for your partner program.
Authorizations
Default authentication mechanism
Query Parameters
Filter the list of commissions by type. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: sale, sale,lead, -click.
click, lead, sale, referral, custom Filter the list of commissions by the associated customer.
Filter the list of commissions by the associated payout.
Filter the list of commissions by the associated partner. When specified, takes precedence over tenantId. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: partner_abc, partner_abc,partner_xyz, -partner_abc.
Filter the list of commissions by the associated partner's tenantId (their unique ID within your database).
Filter the list of commissions by the associated partner group. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: group_abc, group_abc,group_xyz, -group_abc.
Filter the list of commissions by the associated partner tag. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: ptag_abc, ptag_abc,ptag_xyz, -ptag_abc.
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.
Filter the list of commissions by their corresponding status.
pending, processed, paid, refunded, duplicate, fraud, canceled, hold The field to sort the list of commissions by.
createdAt, amount The sort order for the list of commissions.
asc, desc The interval to retrieve commissions for.
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd, all The start date of the date range to filter the commissions by.
The end date of the date range to filter the commissions by.
If specified, the query only searches for results before this cursor. Mutually exclusive with startingAfter.
"cm_1KAP4CGN2Z5TPYYQ1W4JEYD56"
If specified, the query only searches for results after this cursor. Mutually exclusive with endingBefore.
"cm_1KAP4CGN2Z5TPYYQ1W4JEYD56"
DEPRECATED. Use startingAfter instead.
x <= 90071992547409911
The number of items per page.
x <= 10050
Response
The list of commissions.
The commission's unique ID on Dub.
"cm_1JVR7XRCSR0EDBAF39FZ4PMYE"
The type of commission. Can be click, lead, sale, referral, or custom.
click, lead, sale, referral, custom The associated event amount in cents. For sale commissions, this is the sale amount.
The amount earned by the partner, in cents.
The currency of the commission, as an ISO 4217 currency code.
The current status of the commission.
pending, processed, paid, refunded, duplicate, fraud, canceled, hold The associated invoice ID. Only set for sale commissions.
An optional description of the commission.
The event quantity. Used for click and lead commissions; typically 1 for sale and custom commissions.
User-provided metadata from the associated lead or sale event (lead.metadata / sale.metadata).
The date and time when the commission was created.
The date and time when the commission was last updated.
The date the commission was paid out to the partner. Null if not paid yet.
The user who created the manual commission.