Partner Program

Get a referral

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.

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

Path parameters

referralstring uuid required

The referral, resolved within the caller's partnership by the route binder.

Response

The referral.

Example response

{
  "data": {
    "id": "3c4d5e6f-7081-4a2b-9c3d-4e5f6a7b8c9d",
    "referred_name": "Grace Hopper",
    "source": "link",
    "status": "converted",
    "plan": "starter",
    "signed_up_at": "2026-10-08T11:00:00+00:00",
    "expires_at": "2027-04-06T11:00:00+00:00",
    "converted_at": "2026-10-09T14:20:00+00:00",
    "commission_percent": "15.00",
    "commission_ends_at": "2027-10-09T14:20:00+00:00",
    "created_at": "2026-10-08T11:00:00+00:00"
  }
}

Changes

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