Sign in
Affiliates

Create a Custom Payout

Creates a custom payout for the affiliate — an amount of the project's own for the days it covers, outside the monthly payouts. It is pending right away and is never sent automatically: it must be sent from the dashboard. Note 1: custom payouts must be enabled for the project. Note 2: this endpoint is only accessible with a secret API key.

post/affiliates/{affiliate_id}/payouts

Path parameters

affiliate_idstring required

The id of the affiliate to pay.

Headers

x-api-keystring required

The secret API key.

Request body

amountinteger required

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

descriptionstring required

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

period_startstring date required

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

period_endstring 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

operation_idstring nullable

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

Example request

{
  "amount": 25000,
  "description": "Launch campaign video",
  "period_start": "2026-09-01",
  "period_end": "2026-09-15",
  "operation_id": "821fae4b5-0123-4567-9152-5297086a161c"
}

Response

The payout has been created.

Example response

{
  "data": {
    "payout": {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "affiliate_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "custom",
      "status": "pending",
      "amount": 25000,
      "description": "Launch campaign video",
      "period_start": "2026-09-01",
      "period_end": "2026-09-15",
      "created_at": "2026-09-29T10:15:00.000Z"
    }
  }
}

Changes

Changed in 1 of the 7 revisions of this API.1