# Interface: Referral

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:45

## Properties

### clicked\_at?

> `optional` **clicked\_at?**: `string`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:51

ISO timestamp — when the click was recorded, when provided by the server.

***

### code

> **code**: `string`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:49

The partner's link code that was clicked.

***

### expires\_at

> **expires\_at**: `string`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:53

ISO timestamp — end of the program's attribution window.

***

### holdout

> **holdout**: `boolean`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:55

Visitor is in the badge holdout group (badge suppressed; attribution unaffected).

***

### partner

> **partner**: [`ReferralPartner`](https://plandalf.com/docs/packages/sdk/interfaces/ReferralPartner)

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:56

***

### promo

> **promo**: \{ `slug`: `string`; \} \| `null`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:58

Present when the partner's link targets a Promo.

***

### token

> **token**: `string`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:47

Server-issued, unguessable, org-scoped token (`rt_…`).

Source: https://plandalf.com/docs/packages/sdk/interfaces/Referral