list_partner_rewards
List the token's creator's Partner Program commission ledger — one row per paid invoice of a referred creator, plus the clawbacks, each with its state from held to settled or reversed. Read-only.
Page the commission ledger, newest first, in the shape GET /v1/me/partner/rewards answers. A
commission row is written when a referred creator's platform invoice is paid, priced from the
invoice's total before tax and after discount (base_amount) at the referral's locked rate
(amount); a clawback row answers a reversal of money already settled, with a negative amount
the next settlement nets. status is typed first, so an unknown word is a VALIDATION_FAILED.
Read-only. The ledger is written by invoices, moved by the hold, settled by a credit or a payout and reversed by a refund or a dispute, never by a tool.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
statusstringoptionalOptional filter: "pending", "approved", "credited", "paid" or "reversed".
limitintegeroptionalMaximum rows to return per page (1..100).
1max100pageintegeroptional1-indexed page number.
1What it returns
{ "data": [ { "id": "8e9f0a1b-2c3d-4e5f-8a9b-0c1d2e3f4a5b", "referral_id": "3c4d5e6f-7081-4a2b-9c3d-4e5f6a7b8c9d", "kind": "commission", "invoice_id": "in_1QExampleInvoice00", "base_amount": "31.2000", "amount": "4.6800", "currency": "USD", "status": "approved", "hold_until": "2026-11-08T14:20:00+00:00", "approved_at": "2026-11-08T15:00:00+00:00", "credited_at": null, "paid_at": null, "reversed_at": null, "payout_id": null, "reverses_reward_id": null, "note": null, "created_at": "2026-10-09T14:20:00+00:00" } ], "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}status is pending (inside the hold), approved (payable), credited (applied as Subscriby
Credit), paid (covered by a cash payout) or reversed. note says why a row was reversed or
re-priced: refund, dispute, rejected (the referral was rejected after review) or repriced
(a commitment lapsed and the rate fell).
Money is a decimal string in USD
Platform invoices are USD, so every amount is a decimal string with four
places in USD. Parse it as a decimal, never a float; a clawback's amount
is negative.
How it fails
VALIDATION_FAILEDstatus is not one of pending, approved, credited, paid, reversed.
RESOURCE_NOT_FOUNDthe creator never applied to the programme.
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks account:read.
How is this guide?
Last updated on
list_partner_referrals
List the creators the token's creator brought to Subscriby as a partner — how each arrived, whether their first paid invoice converted them and until when the partner earns on them. Read-only.
update_partner_payout_details
Write how the token's creator is paid as a partner — the rail, what it pays to and the tax declaration. The destination is stored encrypted and never returned.