Referral Program

Record a payout

curl -X POST https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referral-payouts \
  -H "Authorization: Bearer sbt_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "affiliate_id": "0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b",
    "amount": 30,
    "currency_id": "f0e1d2c3-b4a5-4697-8877-665544332211",
    "reference": "PAYPAL-7F3D1C92"
  }'

Records money that already left: you paid the affiliate outside Subscriby and file it here, so the ledger marks their oldest payable commissions in that currency as paid, first in first out, until the amount is covered. Emits referral.payout_recorded. Answers 201 with the payout.

The amount is capped at the payable balance. Read the affiliate's balances first; payable in the currency is the most a payout may record. Pending commissions are still inside the hold and cannot be paid yet.

post/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.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Request body

affiliate_idstring uuid required

The affiliate who was paid, as the referral-affiliates endpoints list them.

amountnumber required

What was paid, greater than 0, at most the affiliate's payable balance in that currency.

currency_idstring required

The currency the commissions were earned in; a balance exists per currency.

referencestring nullable

Your own reference, such as a transfer id; at most 120 characters.

notestring nullable

A note for your records; at most 1,000 characters.

Response

The payout.

Changes

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