Authorizations
API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys
Headers
Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Body
The commission type
sale
, custom
Sale amount required only for sale commission type
Commission amount required only for custom commission type
Referral id required only for sale commission type
One of the items id from price_ids
PromoterCampaign id required for custom commission type
The ID of the event that generated the sale from billing provider
The date of the event that generated the sale
Internal note visible only by the team
Set the reward unit type
cash
, credits
, points
, free_months
, mon_discount
, discount_per
If true a notification email is sent to promoter if enabled on Emails section
The billing period of the event that generated the sale
monthly
, yearly
, one_time
Response
Successfully retrieved commissions
Commission ID
Current status of the commission
pending
, approved
, denied
Additional metadata about the commission
Whether this is a self-referral
Type of commission
sale
, custom
Email of the user who created the commission
Timestamp when the user created the commission
Amount of the sale
Original amount of the sale
Currency of the original sale
ID of the event that generated the commission
Plan ID associated with the commission
Reward tier
Internal note visible only to the team
External note visible to the promoter
Unit type for the reward
cash
, credits
, points
, free_months
, mon_discount
, discount_per
Result of fraud check
no_suspicion
, same_ip_suspicion
, same_promoter_email
, ad_source
Commission amount
Whether the commission has been paid
Whether the commission is split among multiple promoters
Creation timestamp
Last status update timestamp