GET /v1/referral

Your referral code, the link to share, and what it has earned. The code is minted on your first call to this endpoint and never changes afterwards, so the link is safe to print. Sharing it costs nothing and referring a free signup earns nothing: the commission is on what a referred customer actually pays. **What you earn.** 10% of every invoice a customer you referred pays us, for 12 months from their first payment, taken either as cash or as API credits — `terms` in the response carries the live numbers rather than these words, which is what you should read from. **Credits settle immediately** and are added to your allowance for the current month. **Cash is held** until it clears the minimum payout in `terms.min_payout_aud`, then paid by transfer. `owing_aud` is what is currently unpaid.

Request

curl 'https://api.puntersedge.online/v1/referral' \
  -H 'X-API-Key: YOUR_KEY'

Parameters

This endpoint takes no parameters beyond authentication.

Responses

Status codes: 200, 401, 402, 422, 429, 500. Response bodies are JSON; the full schema is in /openapi.json.

Example response

200 application/json Field names and types are as the API returns them; values are a real sample, trimmed to a few items.

{
  "code": "PE-7QK2ZD",
  "reward_type": "credits",
  "payout_email": null,
  "active": true,
  "terms": {
    "commission_pct": 10,
    "term_months": 12,
    "credits_per_aud": 1000,
    "min_payout_aud": 50
  },
  "signups": 14,
  "converted": 3,
  "active_referrals": 3,
  "expired_referrals": 0,
  "earned_aud": 26.1,
  "owing_aud": 0.0,
  "credits_earned": 26100,
  "recent": [
    {
      "at": "2026-09-19T04:12:08Z",
      "amount_aud": 9.9,
      "reward": "credits"
    }
  ],
  "link": "https://puntersedge.online/api?ref=PE-7QK2ZD"
}

Related endpoints

• POST /v1/referral — Choose how your referral reward is paid