Get your partnership

curl https://api.subscriby.net/v1/me/partner \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Where you stand, whole. status is applied while Subscriby reviews the application, active once approved, rejected with reapply_available_at when it was declined, or suspended. Until approval the computed parts are null: there is no code, no links, no commission_percent, no balance.

Once approved:

code is the seven-character partner code and links.web the address to hand out; links.connectors carries one deep link per connector whose bot signs creators up, each opening the sign-up conversation with the code attached.
commission_percent is the rate a creator who converts from now on is locked to, as a decimal string with two places. It is a ladder: base_percent plus commitment_points (the verified promotion commitments) plus volume_points (the volume tiers reached at paying_referrals), capped at max_percent; next_tier_at and next_tier_points say what the next tier takes and adds. A referral keeps the rate it was promised at conversion; a raise reaches every referral still inside its commission period, a drop only new conversions.
referrals tallies the creators brought in by state, and balance carries the ledger's sums as decimal strings with four places in currency: pending (inside the hold), payable (approved and not yet settled, clawbacks netted), credited, paid and earned (all of them together).
commitments lists every promotion commitment with its proof state; a commitment is made and its proof submitted on the dashboard or in the bot, where the rules are explained.

Requires ability

account:read

The token must hold this ability, or the call is refused with 403.

MCP tool

get_partner_program

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Responses

200OKapplication/json

The partner object; 404 RESOURCE_NOT_FOUND until the caller applies.

data*

The response's payload.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

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.

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

Until the caller applies.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/me/partner"

{  "data": {    "id": "4b7e2d19-5c3a-4f80-9e6b-1d2c3b4a5f60",    "status": "active",    "code": "ADA7Q2X",    "links": {      "web": "https://app.subscriby.net/r/ADA7Q2X",      "connectors": [        {          "connector": "telegram",          "name": "Telegram",          "url": "https://t.me/SubscribyBot?start=partner_ADA7Q2X"        }      ]    },    "commission_percent": "15.00",    "base_percent": 5,    "max_percent": 30,    "commitment_points": 10,    "volume_points": 0,    "paying_referrals": 3,    "next_tier_at": 10,    "next_tier_points": 5,    "commission_months": 12,    "hold_days": 30,    "minimum_cash_payout": "50",    "friend_discount_percent": 20,    "friend_discount_months": 3,    "currency": "USD",    "clicks": 412,    "referrals": {      "total": 7,      "signed_up": 3,      "converted": 3,      "under_review": 0,      "expired": 1,      "rejected": 0    },    "balance": {      "pending": "11.7000",      "payable": "52.6500",      "credited": "0.0000",      "paid": "117.0000",      "earned": "181.3500"    },    "payout_method": "paypal",    "payout_details_complete": true,    "legal_name": "Ada Lovelace",    "tax_country": "GB",    "us_person": false,    "terms_accepted_at": "2026-10-02T09:14:02+00:00",    "terms_version": "2026-10-10",    "commitments": [      {        "id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",        "kind": "long_form_video",        "status": "verified",        "audience_channel": "youtube",        "audience_url": "https://www.youtube.com/@ada",        "reach": "up_to_50k",        "points": 10,        "proof_url": "https://www.youtube.com/watch?v=example",        "promised_at": "2026-10-01T09:14:02+00:00",        "due_at": "2026-12-01T09:14:02+00:00",        "proof_submitted_at": "2026-10-20T16:41:11+00:00",        "verified_at": "2026-10-21T08:00:00+00:00",        "lapsed_at": null,        "created_at": "2026-10-01T09:14:02+00:00"      }    ],    "applied_at": "2026-10-01T09:14:02+00:00",    "joined_at": "2026-10-02T09:14:02+00:00",    "rejected_at": null,    "rejection_reason": null,    "reapply_available_at": null,    "suspended_at": null,    "created_at": "2026-10-01T09:14:02+00:00",    "updated_at": "2026-10-21T08:00:00+00:00"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: PartnerResource;}export interface PartnerResource {  id: string;  status: string;  code: string | null;  links: Links | null;  commission_percent: string | null;  base_percent: number;  max_percent: number;  commitment_points: number | null;  volume_points: number | null;  paying_referrals: number | null;  next_tier_at: number | null;  next_tier_points: number | null;  commission_months: number;  hold_days: number;  minimum_cash_payout: string;  friend_discount_percent: number;  friend_discount_months: number;  currency: string;  clicks: number;  referrals: Referrals;  balance: Balance | null;  payout_method: string | null;  payout_details_complete: boolean;  legal_name: string | null;  tax_country: string | null;  us_person: boolean | null;  terms_accepted_at: string | null;  terms_version: string | null;  commitments: unknown[];  applied_at: string;  joined_at: string | null;  rejected_at: string | null;  rejection_reason: string | null;  reapply_available_at: string | null;  suspended_at: string | null;  created_at: string | null;  updated_at: string | null;}export interface Links {  web: string;  connectors: Connector[];}export interface Connector {  connector: string;  name: string;  url: string;}export interface Referrals {  total: number;  signed_up: number;  converted: number;  under_review: number;  expired: number;  rejected: number;}export interface Balance {  pending: string;  payable: string;  credited: string;  paid: string;  earned: string;}

Get your partnership

AuthorizationCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Responses