Skip to main content
POST
Create a Custom Payout

Headers

x-api-key
string
required

The secret API key.

Path Parameters

affiliate_id
string
required

The id of the affiliate to pay.

Body

application/json
amount
integer
required

The amount to pay the affiliate, in USD cents — from 1000 ($10) to 1000000 ($10,000)

Required range: 1000 <= x <= 1000000
Example:

25000

description
string
required

What the payout is for, from 10 to 200 characters. Shown to the affiliate

Required string length: 10 - 200
Example:

"Launch campaign video"

period_start
string<date>
required

The first day the payout covers, YYYY-MM-DD — from the first day of last month

Example:

"2026-09-01"

period_end
string<date>
required

The last day the payout covers, YYYY-MM-DD — on or after period_start, and no later than the last day of next month. The same day as period_start for a single day

Example:

"2026-09-15"

operation_id
string | null

An optional operation id that ensures the same payout won't be created again

Example:

"821fae4b5-0123-4567-9152-5297086a161c"

Response

The payout has been created.

data
object
required