Jump to Content

List affiliate payouts

List affiliate payouts

Returns the affiliate's payout ledger, newest first. Query parameters: page (1-based; 10 rows per page).

Response — 200 OK

{
  "payouts": [
    {
      "date": "2026-10-01T00:00:00.000Z",
      "commission": 4485,
      "currency": "usd",
      "revenue": 44850,
      "status": "pending",
      "isRefund": false,
      "refundStatus": "none",
      "testTransaction": false
    }
  ],
  "pagination": { "results": 1, "pages": 1 }
}

Field notes

Field	Values	Meaning
`date`	ISO 8601	When the payout was recorded (the moment the referred sale settled).
`commission`	integer	What the affiliate earns from the sale — in the currency's smallest unit (4485 = $44.85). Negative on refund rows.
`revenue`	integer	The gross product value of the referred order that generated the commission — same unit.
`currency`	string	Lowercase ISO currency code of the sale.
`status`	`pending` \| `delayed` \| `overdue` \| `success`	See the lifecycle below.
`isRefund`	boolean	`true` marks a refund clawback row: the referenced order was refunded and this row reverses the commission (negative amounts).
`refundStatus`	`none` \| `partially_refunded` \| `fully_refunded`	How much of this payout was clawed back after its order was refunded. `none` = untouched.
`testTransaction`	boolean	`true` = the underlying checkout was a flagged test: the payout was auto-settled without any money moving.

The `status` lifecycle

Status	Meaning
`pending`	Commission recorded and in its 30-day holding/dispute window, waiting for the merchant's automated payout cycle (or a manual payout).
`delayed`	Still unpaid 30+ days after the order — the automated payout attempt failed (typically no chargeable card on file) and the holding window elapsed. It is retried automatically.
`overdue`	Still unpaid 37+ days after the order. From 44 days the merchant's affiliate program is suspended until the balance is settled.
`success`	Paid out to the affiliate's Stripe Express account. Test-transaction payouts are created directly in this state.

Aging runs on every automated-payout pass: pending → delayed at 30 days → overdue at 37 days → program suspension at 44 days, each measured from the payout's date.

Errors — all { "error": "<message>" }:

Status	`error` values
403	`The affiliate must accept the current affiliate legal terms.`
404	`Program not found` · `Affiliate not found`