---
title: "Get a referral"
method: GET
path: "/v1/me/partner/referrals/{referral}"
tags: ["Partner Program"]
---

# Get a referral

`GET /v1/me/partner/referrals/{referral}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me/partner/referrals/{referral}`
- Auth: HTTP bearer

One referral: how the creator arrived (`source` is `link`, `code_at_signup` or `bot_deep_link`), whether their first paid invoice converted them and on which `plan`, the `commission_percent` locked onto them at conversion, and `commission_ends_at`, when you stop earning on them. Another partner's referral is `404 RESOURCE_NOT_FOUND`.

## Path parameters

- `referral` string, uuid, required

## Response `200`

The referral.

- object
  - `data` PartnerReferralResource, required: A partner referral: a creator who signed up through the partner's link, code or bot deep link, whether their first paid invoice converted them, and until when the partner earns on them.
    - `id` string, required: The referral's id.
    - `referred_name` string, nullable, required: The referred creator's display name; null when the account is gone. Their email and id are never returned.
    - `source` string, required: How they arrived: `link` (the web link's cookie), `code_at_signup` (the code typed on the sign-up form) or `bot_deep_link` (a connector's deep link).
    - `status` string, required: `signed_up` (inside the conversion window, no paid plan yet), `converted` (first Starter or Growth invoice paid, earning), `under_review` (held by Subscriby for a fraud signal), `expired` (the window passed unpaid) or `rejected` (rejected after review).
    - `plan` string, nullable, required: The platform plan they converted on, `starter` or `growth`; null until converted.
    - `signed_up_at` string, required: When they signed up, ISO 8601.
    - `expires_at` string, required: When the conversion window closes unless they pay, ISO 8601.
    - `converted_at` string, nullable, required: When their first paid invoice settled, ISO 8601; null until then.
    - `commission_percent` string, nullable, required: The rate locked onto this referral at conversion, as a decimal string with two places; null until converted.
    - `commission_ends_at` string, nullable, required: When the partner stops earning on this creator, ISO 8601; null until converted.
    - `created_at` string, nullable, required: When the row was written, ISO 8601.

## 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.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `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)