Get the programme
/v1/projects/{project}/referral-program in the Referral Program API.
curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referral-program \ -H "Authorization: Bearer sbt_..."The programme as it stands, with its commission currency's ISO code loaded. 404 RESOURCE_NOT_FOUND while the project has none.
Three fields that are easy to misread
plan_ids: []means every plan, not no plans. A conversion counts on every plan in the project, including plans added later. Treating it as "restricted to nothing" inverts the meaning.
commission_period_months is 0 for the friend's first payment only, a number of months, or null for life. A fixed commission is always the first payment only and always reports 0.
commission_value is a decimal string with four places: "20.0000" for 20% of each payment, "10.0000" for ten of the commission currency. Parse it as a decimal, never a float. commission_currency_id is null on a percentage, which is earned in each payment's own currency.
Requires ability
The token must hold this ability, or the call is refused with 403.
Run the same action from an agent, behind the same ability.
Authorization
bearerToken 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
Path Parameters
The project, resolved by the route binder.
uuidResponses
200OKapplication/json
The programme; 404 RESOURCE_NOT_FOUND while the project has none.
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).
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.
404Not foundRESOURCE_NOT_FOUNDapplication/json
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.
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.
How is this guide?
Last updated on
Referral Program API
A project's Referral Program turns members into affiliates: each gets a code and a link, a friend who arrives through them is counted for thirty days, and when that friend's first payment settles the affiliate earns what the programme promises, free membership days or a cash commission the creator pays out themselves.
Set up or change the programme
/v1/projects/{project}/referral-program in the Referral Program API.