Partner Program

List your commissions

curl "https://api.subscriby.net/v1/me/partner/rewards?status=approved" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Pages the commission ledger, newest first: one commission row per paid platform invoice of a referred creator, priced from the invoice's total before tax and after discount (base_amount) at the referral's locked rate (amount), plus the clawback rows that answer a reversal of money already settled, each with a negative amount. 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. The ledger is read-only on every surface: rows are written by invoices, moved by the hold, settled by a credit or a payout and reversed by a refund or a dispute.

get/v1/me/partner/rewards

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/me/partner/rewards
  • Auth: HTTP bearer

Query parameters

status'pending' | 'approved' | 'credited' | 'paid' | 'reversed'

Where a partner commission stands. A commission is born Pending behind the hold, becomes Approved (payable) when the hold passes, and is settled either as Credited on the partner's Stripe balance or Paid by a recorded payout; a refund inside the hold makes it Reversed, and a refund after settlement leaves it as it is and writes a clawback beside it.

Keep only rows in this state: pending, approved, credited, paid or reversed.

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.

Example response

{
  "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",
      "created_at": "2026-10-09T14:20:00+00:00"
    }
  ],
  "links": {
    "first": "https://api.subscriby.net/v1/me/partner/rewards?page=1",
    "last": "https://api.subscriby.net/v1/me/partner/rewards?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.subscriby.net/v1/me/partner/rewards",
    "per_page": 25,
    "to": 1,
    "total": 1
  }
}

Changes

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