Earnings & referrals
Paid actors and referrals
Paid actors and referrals: the account's earnings (share, hold days, minimum payout; balance pending / available / withdrawable / requested / paid, referral commissions included, `referrals_usd` = their part of lifetime; per-actor breakdown; open payout request)
List referrals
Settings → Referrals: enabled, registration_open, terms { first_rate, first_months, rate, cap_usd (0 = none), hold_days, cookie_days }, can_manage, code (created on first call), link (`⟨web⟩/?ref=⟨code⟩`), stats { clicks, signups, paying, pending_usd, available_usd, lifetime_usd, reversed_usd }, referrals [{ id, label (masked email), signed_up_at, first_paid_at, paid_usd, earned_usd, rate, capped }] (latest 100), commissions [{ id, label, base_usd, rate, amount_usd, paid_at, available_at, reversed_at }] (latest 50)
Replace code (referrals)
Owner/admin with billing rights: own referral ID { code } (4-32 of a-z 0-9 -, lowercased; reserved words refused). Old links stop counting. 404 while the program is off
Earnings one row per charge
Earnings one row per charge (result/event), newest first. `settled_at` null: the payer's period is not billed yet, so the row is pending whatever `available_at` says; `paid_usd` is the part of `gross_usd` the payer's money covered (null until settled, under the gross when only part of the period was paid)
Create credit (earnings)
Owner/admin: move withdrawable earnings to the account's prepaid credit, 1:1 USD, at once (all of it when amount_usd is left out; at least $1). Recorded as a paid payout with kind `credit`. Earnings are never paid out in cash unless a platform setting is on (`cash_payouts` in GET /api/v3/earnings)
Payout requests and moves to credit
Payout requests and moves to credit (`kind`: credit | cash; method shown as its last characters only)
Request a cash payout of withdrawable earnings
Owner/admin: request a cash payout of withdrawable earnings (one open request at a time; at least the minimum). Paid by hand by Lantfly staff. Only with a platform setting on, else 403 payouts_disabled: use /api/v3/earnings/credit