Referral Program

Get the programme

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.

get/v1/projects/{project}/referral-program

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/referral-program
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Response

The programme; 404 RESOURCE_NOT_FOUND while the project has none.

Example response

{
  "data": {
    "id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "active": true,
    "reward_kind": "cash",
    "commission_type": "percentage",
    "commission_value": "20.0000",
    "commission_period_months": 6,
    "hold_days": 14,
    "minimum_payout": "50.0000",
    "friend_reward_kind": "free_days",
    "friend_reward_days": 3,
    "payout_details_label": "PayPal email",
    "terms": "One referral per household.",
    "created_at": "2026-10-01T09:14:02+00:00",
    "updated_at": "2026-10-08T16:41:11+00:00"
  }
}

Changes

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