Tracking sales and commissions
Assign sales and commissions to your promoters. To track sales and generate commissions correctly, you need to use this API call each time a non-zero amount sale is processed in your system, even if it comes from a recurring charge or one-time charge.
To maintain the same standards with the API, we recommend making the sale API call (this call) only when you receive confirmation of the sale from your billing provider, such as from a webhook, an IPN, or a success response from an API charge call.
You just need to pass the sale amount (before taxes) and we’ll take care of the rest. The commissions/rewards will be calculated based on that amount and the plan ID, in case you use the plan-level rewards feature.
The lead is added to our system either by the client signup tracking script when the user signs up or by calling the signup API endpoint. There is also the option to bypass the signup tracking by using TID or ref_id parameters, which will create the lead and assign the sale in one go.
If we don’t find the lead in our system, it means that the sale is not a referral sale and you’ll get a 204 response. You don’t have to identify which sale is from referrals and which is not; we’ll take care of that.
Authorizations
Query Parameters
required if uid is null
Email of the lead/sign-up
required if email is null
uid of the lead added on signup tracking
Transaction or sale event ID. It's required to avoid generating duplicate sales in case you mistakenly send the same API call multiple times.
The sale amount in cents. It's used to calculate commissions/rewards.
For zero-decimal currencies like JPY, amount and mrr parameters should be sent as whole values.
For other currencies, amount and mrr parameter values should be in cents, i.e., you will need to multiply the value by 100 before sending the request.
Number of subscriptions/items refunded. If it's only one you can skip this parameter.
Customer plan ID from the billing provider. It's used to calculate rewards in case you use plan-level rewards feature.
This field is only required if the currency of the sale is not the same as the one set on FirstPromoter settings. We'll automatically convert the amount from this currency to the default one set on your FirstPromoter account.
Sets the Monthly Recurring Revenue generated by the customer. It's used only for calculating the MRR generated by the program, not for calculating the commissions.
For promo code/coupon code tracking. If you gave a unique coupon to a promoter and you added it on his promotion, you can pass it here and it will CREATE a new lead and a sale for that promoter (if it doesn't exist already).
You can avoid a signup tracking call by providing the _fprom_tid cookie value (visitor tracking id) read on your system
You can avoid signup tracking call by providing the ref_id(referral id) of the promoter
Set this to true to skip email notifications. Default is false.
ISO 8601 date string of when the sale occurred. Defaults to now.
Subscription ID from your billing provider. Stored in the lead metadata.
Number of days to delay the first commission. The sale will be scheduled and tracked at now + start_recurring_reward_in days.
Interval in days between recurring commission events. Used together with start_recurring_reward_in.
Maximum number of recurring commission events to generate. Requires recurring_reward_frequency to be set.
Set to true for e-commerce one-time sales (non-subscription).