---
title: "Your referral link and earnings"
method: GET
path: "/v1/referral"
tags: ["Referrals"]
---

# Your referral link and earnings

`GET /v1/referral`

## Request

- Base URL: `https://api.puntersedge.online`
- URL: `https://api.puntersedge.online/v1/referral`
- Auth: API key in header `X-API-Key`

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.

## Headers

- `X-API-Key` string
- `X-RapidAPI-Proxy-Secret` string

## Response `200`

Successful Response

- unknown

## Other responses

- `401`: Missing or invalid API key. Send `X-API-Key`. See https://puntersedge.online/developers/errors
- `402`: Monthly credit allowance exhausted for this plan. Upgrade at https://puntersedge.online/api/pricing
- `422`: Validation Error
- `429`: Rate limit exceeded for this plan. Honour the `Retry-After` header (seconds) before retrying. See https://puntersedge.online/developers/rate-limits
- `500`: Unexpected server error. Safe to retry with backoff.

---

[API](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api.md) · [All operations](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/llms.txt) · [OpenAPI document](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/revisions/f35b6aab1946?raw)