Referral Program

List payouts

Pages the payouts the creator recorded, newest first; affiliate_id narrows to one affiliate. rewards_paid is how many commissions each payout covered.

get/v1/projects/{project}/referral-payouts

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/referral-payouts
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

affiliate_idstring uuid

Keep only the payouts recorded against one affiliate.

pageinteger

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Response

The page.

Changes

No recorded changes to this operation across all 1 revision of this API.