POST
/
commissions
curl --request POST \
  --url https://v2.firstpromoter.com/api/v2/company/commissions \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "commission_type": "sale",
  "referral_id": 123,
  "plan_id": 123,
  "promoter_campaign_id": 123,
  "sale_amount": 123,
  "amount": 123,
  "event_id": "<string>",
  "event_date": "2023-12-25",
  "internal_note": "<string>",
  "unit": "cash",
  "notify_promoter": true,
  "billing_period": "monthly"
}'
[
  {
    "id": 123,
    "status": "pending",
    "metadata": {},
    "is_self_referral": true,
    "commission_type": "sale",
    "created_by_user_email": "<string>",
    "created_by_user_at": "2023-11-07T05:31:56Z",
    "sale_amount": 123,
    "original_sale_amount": 123,
    "original_sale_currency": "<string>",
    "event_id": "<string>",
    "plan_id": "<string>",
    "tier": 123,
    "internal_note": "<string>",
    "external_note": "<string>",
    "unit": "cash",
    "fraud_check": "no_suspicion",
    "amount": 123,
    "is_paid": true,
    "is_split": true,
    "created_at": "2023-11-07T05:31:56Z",
    "status_updated_at": "2023-11-07T05:31:56Z",
    "promoter_campaign": {
      "id": 123,
      "campaign_id": 123,
      "promoter_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "promoter": {
        "id": 123,
        "email": "<string>",
        "name": "<string>"
      },
      "campaign": {
        "id": 123,
        "name": "<string>",
        "color": "<string>"
      }
    },
    "referral": {
      "id": 123,
      "email": "<string>",
      "uid": "<string>"
    },
    "reward": {
      "id": 123,
      "name": "<string>"
    }
  }
]

Authorizations

Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Body

application/json

Response

200
application/json
Successfully retrieved commissions

The response is of type object[].