---
title: "A settled payment earned a referrer, or the referred friend, days or money."
method: POST
path: "referral.reward_earned"
tags: ["referral.* events"]
---

# A settled payment earned a referrer, or the referred friend, days or money.

`POST referral.reward_earned` (webhook)

### When this fires

The ledger recorded a settled payment that a live referral earns on: the conversion earns the referrer their days or their first commission and the friend their welcome days; every later payment inside the period earns a percentage referrer another commission. One event per reward row, so a conversion on a programme with a friend reward emits two.

> **Days land at once, money waits.** A days row is `applied` when the member holds an ordinary live membership (the days are banked on it) and `pending` when they hold nothing live, in which case they wait on the affiliate's balance for their next purchase. A money row is `pending` behind the programme's hold with `hold_until` set, or `approved` at once when the hold is zero.

### Caveats

- **A redelivered payment earns nothing twice.** The ledger records a payment once, and a payment that already earned a row writes no second one.
- **A friend's days need a purchase that can carry them.** A pass or a season cannot be moved, so a friend who converts on one receives no days row at all rather than one that never applies.
- **Days are never reversed.** A refund unwinds money rows only; days already banked stay banked.

### Related events

- `referral.reward_approved`: the hold passes.
- `referral.reward_reversed`: a refund takes it back.
- `payment.succeeded`: the payment itself, from the gateway's side.

## Headers

- `SB-Signature` string, required
- `SB-Event-Id` string, required
- `SB-Event-Name` string, required
- `Content-Type` string, required
- `User-Agent` string, required

## Payload

- object: The envelope every event is delivered in.
  - `id` string, required: A ULID unique to the event, prefixed `evt_`. Every retry carries the same id, so it is the key to deduplicate on.
  - `type` 'referral.reward_earned', required: The event name, always `referral.reward_earned` here.
  - `created_at` string, date-time, required: When the event was emitted, server time, ISO 8601.
  - `api_version` string, required: The contract version of the payload shape, `2026-05-01` today. A breaking change to a shape ships under a new version.
  - `project_id` string, uuid, nullable, required: The project the event belongs to; null for team-scoped and billing events.
  - `data` object, required: The event-specific payload. Keys that do not apply to a given emission are omitted rather than sent as null, so check for presence.
    - `reward_id` string, uuid, required: The ledger row. The same id travels on `referral.reward_approved` and `referral.reward_reversed`.
    - `referral_id` string, uuid, required: The referral it was earned on.
    - `affiliate_id` string, uuid, required: The referrer, on both sides' rows: a friend's row is filed under the affiliate who brought them.
    - `beneficiary` 'referrer' | 'friend', required: Whose reward it is.
    - `kind` 'free_days' | 'cash', required: Days or money.
    - `days` integer, nullable, required: The days, on a days row. `null` on a money row.
    - `amount` string, decimal, nullable, required: The money, four decimal places, on a money row. `null` on a days row.
    - `currency_id` string, uuid, nullable, required: The currency of `amount`: the payment's own for a percentage, the programme's for a fixed amount. `null` on a days row.
    - `status` 'pending' | 'approved' | 'applied', required: Where the row starts: `applied` for days banked on a membership, `pending` for days on a balance or money inside its hold, `approved` for money with no hold.
    - `hold_until` string, date-time, nullable, required: When a held commission becomes payable. `null` on days and on money with no hold.
    - `payment_id` string, uuid, required: The ledger payment that earned it, the key the credit is idempotent on.

## Acknowledgement `2XX`

Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.

## Other responses

- `default`: Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or `POST /v1/webhook-deliveries/{delivery}/retry`. After 20 consecutive failures the endpoint is paused until it is resumed.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)