Referral Program

List rewards

curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referral-rewards?affiliate_id=0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b&status=approved" \
  -H "Authorization: Bearer sbt_..."

Pages the ledger, newest first: one row per settled payment per side of a referral. affiliate_id, status (pending, approved, paid, applied, reversed) and beneficiary (referrer, friend) narrow it. A reversal is a row of its own with a negative amount and reverses_reward_id naming the reward it cancels. The ledger is read-only: rewards are written when a payment settles, made payable by the hold, paid by a recorded payout and reversed by a refund.

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

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

affiliate_idstring uuid

Keep only the rewards one affiliate's referrals earned.

status'pending' | 'approved' | 'paid' | 'reversed' | 'applied'

Where a reward row stands. Cash moves Pending → Approved → Paid, or to Reversed when the payment behind it is refunded before it was paid out; days move Pending (waiting on the affiliate's balance) → Applied (banked on a purchase).

Keep only rewards in this state: pending (inside the hold, or days waiting on the balance), approved (payable), paid (recorded in a payout), applied (days banked on a membership) or reversed (taken back by a refund).

beneficiary'referrer' | 'friend'

Who a reward row is for: the member who referred, or the member who was referred.

Keep only the rewards of one side: referrer or friend.

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.