v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Commissions

Get all commissions

With this endpoint you can list all rewards and commissions assigned to a promotion, promoter, campaign or entire account using the API. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/commissions</Tip>

get/commissions

Query parameters

qstring

Search params. Searches by event_id, referral.email, referral.uid

ids[]integer[]

Array of commission ids to get

status'pending' | 'approved' | 'denied'

paid'yes' | 'no'

Paid filter for monetary commissions

fulfilled'yes' | 'no'

Fulfilled filter for non-monetary commissions

due_period'next' | 'overdue' | 'custom'

Due period filter

promoter_idinteger

Promoter id

first_commissionboolean

First commission

refundedboolean

Refunded reward

fraud_check'no_suspicion' | 'same_ip_suspicion' | 'same_promoter_email' | 'ad_source'

Referral fraud check (suspicion). Array accepted

sale_amount'asc' | 'desc'

The sort by sale direction

amount'asc' | 'desc'

The sort by amount direction

created_at'asc' | 'desc'

The sort by created_at direction

referral'asc' | 'desc'

The sort by referral direction

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Response

Successfully retrieved commissions

idinteger

Commission ID

status'pending' | 'approved' | 'denied'

Current status of the commission

metadataobject

Additional metadata about the commission

is_self_referralboolean nullable

Whether this is a self-referral

commission_type'sale' | 'custom'

Type of commission

created_by_user_emailstring nullable

Email of the user who created the commission

created_by_user_atstring date-time nullable

Timestamp when the user created the commission

sale_amountinteger

Amount of the sale

original_sale_amountinteger

Original amount of the sale

original_sale_currencystring nullable

Currency of the original sale

event_idstring nullable

ID of the event that generated the commission

plan_idstring nullable

Plan ID associated with the commission

tierinteger

Reward tier

internal_notestring nullable

Internal note visible only to the team

external_notestring nullable

External note visible to the promoter

Unit type for the reward

fraud_check'no_suspicion' | 'same_ip_suspicion' | 'same_promoter_email' | 'ad_source' nullable

Result of fraud check

amountinteger

Commission amount

is_paidboolean

Whether the commission has been paid

is_splitboolean

Whether the commission is split among multiple promoters

created_atstring date-time

Creation timestamp

status_updated_atstring date-time nullable

Last status update timestamp

split_detailsobject nullable

Commission split details from the associated referral, when the referral is shared between promoters