---
title: "List your commissions"
method: GET
path: "/v1/me/partner/rewards"
tags: ["Partner Program"]
---

# List your commissions

`GET /v1/me/partner/rewards`

## Request

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

```bash
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.

## 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.
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page.

- object
  - `data` PartnerRewardResource[], required: The items on this page.
    - `id` string, required: The reward's id.
    - `referral_id` string, required: The referral it was earned on.
    - `kind` string, required: `commission` (earned on a paid invoice) or `clawback` (a negative row answering a reversal of money already settled).
    - `invoice_id` string, nullable, required: The referred creator's Stripe invoice the commission was priced from; null on a clawback.
    - `base_amount` string, nullable, required: The invoice's total before tax and after discount, as a decimal string with four places; null on a clawback.
    - `amount` string, required: The commission as a decimal string with four places; negative on a clawback.
    - `currency` string, required: The ISO 4217 code of both amounts.
    - `status` string, required: `pending` (inside the hold), `approved` (payable), `credited` (applied as Subscriby Credit), `paid` (covered by a cash payout) or `reversed` (taken back before it was settled).
    - `hold_until` string, nullable, required: When the hold ends and the commission becomes payable, ISO 8601.
    - `approved_at` string, nullable, required: When it became payable, ISO 8601; null until then.
    - `credited_at` string, nullable, required: When it was applied as Subscriby Credit, ISO 8601; null otherwise.
    - `paid_at` string, nullable, required: When a cash payout covered it, ISO 8601; null otherwise.
    - `reversed_at` string, nullable, required: When it was reversed, ISO 8601; null otherwise.
    - `payout_id` string, nullable, required: The payout that covered it; null until then.
    - `reverses_reward_id` string, nullable, required: On a clawback, the reward whose settled money it takes back; null otherwise.
    - `note` string, nullable, required: Why the row was reversed or re-priced: `refund`, `dispute`, `rejected` (the referral was rejected after review) or `repriced` (a commitment lapsed); null otherwise.
    - `created_at` string, nullable, required: When the row was written, ISO 8601.
  - `links` object, required: Links to the first, last, previous and next pages.
    - `first` string, nullable, required: The first page's URL.
    - `last` string, nullable, required: The last page's URL.
    - `prev` string, nullable, required: The previous page's URL; null on the first page.
    - `next` string, nullable, required: The next page's URL; null on the last page.
  - `meta` object, required: The paging counters for this page.
    - `current_page` integer, required: The page returned, 1-indexed.
    - `from` integer, nullable, required: The 1-indexed position of this page's first item across every page; null when the page is empty.
    - `last_page` integer, required: How many pages there are.
    - `links` object[], required: Generated paginator links.
      - `url` string, nullable, required: The page's URL; null for the ellipsis and the disabled arrows.
      - `label` string, required: The link's label: a page number, the previous or next arrow, or an ellipsis.
      - `active` boolean, required: Whether this link is the current page.
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `to` integer, nullable, required: Number of the last item in the slice.
    - `total` integer, required: Total number of items being paginated.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)