Sign in
Affiliates

Cancel a Custom Payout

Cancels one of the affiliate's custom payouts while it is still pending, so it is never sent. The payout is kept, as cancelled. Monthly performance payouts can't be cancelled. Note 1: custom payouts must be enabled for the project. Note 2: this endpoint is only accessible with a secret API key.

delete/affiliates/{affiliate_id}/payouts/{payout_id}

Path parameters

affiliate_idstring required

The id of the affiliate the payout is to.

payout_idstring required

The id of the payout to cancel.

Headers

x-api-keystring required

The secret API key.

Response

The payout has been cancelled.

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