Skip to main content
POST
/
commissions
Create commission
curl --request POST \
  --url https://api.affonso.io/v1/commissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referral_id": "<string>",
  "sale_amount": 1,
  "sale_amount_currency": "<string>",
  "commission_amount": 1,
  "commission_currency": "<string>",
  "status": "pending",
  "sales_status": "pending",
  "is_subscription": false,
  "payment_intent_id": "<string>",
  "hold_period_days": 1,
  "created_at": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "referral_id": "<string>",
    "affiliate_id": "<string>",
    "program_id": "<string>",
    "sale_amount": 123,
    "sale_amount_currency": "<string>",
    "commission_amount": 123,
    "commission_currency": "<string>",
    "status": "pending",
    "sales_status": "pending",
    "is_subscription": true,
    "payment_intent_id": "<string>",
    "hold_period_days": 123,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Body

application/json
​
referral_id
string
required
​
sale_amount
number
required
Required range: x >= 0
​
sale_amount_currency
string
required
Required string length: 3
​
commission_amount
number
required
Required range: x >= 0
​
commission_currency
string
required
Required string length: 3
​
status
enum<string>
default:pending
Available options:
pending,
approved,
ready_for_payment,
paid,
rejected,
refunded
​
sales_status
enum<string>
default:pending
Available options:
pending,
complete,
refunded,
failed
​
is_subscription
boolean
default:false
​
payment_intent_id
string
​
hold_period_days
integer
Required range: x >= 0
​
created_at
string<date-time>

Custom creation timestamp. If not provided, defaults to current time.

Response

Commission created

​
success
boolean
​
data
object