Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

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. <Note>To avoid fraudulent sales, we don't use JS conversion pixels to track sales, which are very unreliable and can be easily faked. Instead, we use server-side tracking for all sales to ensure that a sale is tracked only when you actually receive money in your billing account. <br/><br/>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.<br/><br/>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.</Note> Using email or UID parameters, we identify the lead/customer who generated the sale, which also helps us determine the promoter who owns the reward/commission. <br/><br/>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.<br/><br/>If we don't find the lead in our system, then it means that the sale is not a referral sale, you'll get a 404 response. Also, if the promoter is banned, you'll get a 404 response. You don't have to identify which sale is from referrals and which is not; we'll take care of that. <Tip>For zero-decimal currencies like JPY, amount and mrr parameters should be sent as whole values. <br/><br/>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.</Tip><Tip>HTTP Request <br/>POST https://api.firstpromoter.com/api/v2/track/sale</Tip>

post/sale

Headers

Account-IDstring required

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

Request body

OR

Response

Sale tracked successfully

idinteger
etypestring
sale_amountinteger
original_sale_amountinteger
original_sale_currencystring nullable
event_idstring nullable
plan_idstring nullable
billing_periodstring nullable
created_atstring date-time

Example response

{
  "id": 45831949,
  "etype": "sale",
  "sale_amount": 2000,
  "original_sale_amount": 2000,
  "created_at": "2025-04-25T09:39:42.289Z",
  "referral": {
    "id": 29203686,
    "email": "testme@test1.com"
  },
  "commissions": [
    {
      "id": 13533003,
      "status": "approved",
      "metadata": {},
      "commission_type": "sale",
      "sale_amount": 2000,
      "original_sale_amount": 2000,
      "tier": 1,
      "unit": "cash",
      "fraud_check": "no_suspicion",
      "amount": 400,
      "created_at": "2025-04-25T09:39:42Z",
      "promoter_campaign": {
        "id": 14850130,
        "campaign_id": 28004,
        "promoter_id": 8262622,
        "created_at": "2025-01-16T18:16:41Z",
        "promoter": {
          "id": 8262622,
          "email": "test@promoter.com",
          "name": "Test Promoter"
        },
        "campaign": {
          "id": 28004,
          "name": "Quinn Ramirez",
          "color": "#EC4899"
        }
      },
      "referral": {
        "id": 29203686,
        "email": "testme@test1.com"
      },
      "reward": {
        "id": 157427,
        "name": "20% recurring commission"
      }
    }
  ]
}