> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Affiliate

> An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations.

```json Example theme={null}
{
	"active_members_count": 42,
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "<string>"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"customer_retention_rate": "<string>",
	"customer_retention_rate_ninety_days": "<string>",
	"id": "aff_xxxxxxxxxxxxxx",
	"monthly_recurring_revenue_usd": "<string>",
	"status": "active",
	"total_overrides_count": 42,
	"total_referral_earnings_usd": "<string>",
	"total_referrals_count": 42,
	"total_revenue_usd": "<string>",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "Jane Smith",
		"username": "janesmith"
	}
}
```

**active\_members\_count** `integer` *required*

The total active members of the affiliate

Example: `42`

**company** `object` *required*

The company attached to this affiliate

**child attributes**

**id** `string` *required*

The unique identifier for the company.

Example: `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

The written name of the company.

**created\_at** `string\<date-time\>` *required*

The datetime the affiliate was created.

Example: `2023-12-01T05:00:00.401Z`

**customer\_retention\_rate** `string` *required*

The percentage of referred customers who are still active members

**customer\_retention\_rate\_ninety\_days** `string` *required*

The percentage of referred customers who remained active over the last 90 days

**id** `string` *required*

The unique identifier for the affiliate.

Example: `aff_xxxxxxxxxxxxxx`

**monthly\_recurring\_revenue\_usd** `string` *required*

The monthly recurring revenue generated by this affiliate's referrals,
formatted as a USD currency string

**status** `Status | null` *required*

The status of the affiliate

Available options: `active`, `archived`, `deleted`

**total\_overrides\_count** `integer` *required*

The total count of all overrides for this affiliate

Example: `42`

**total\_referral\_earnings\_usd** `string` *required*

The total commission earnings paid to this affiliate, formatted as a USD
currency string

**total\_referrals\_count** `integer` *required*

The total referrals of the affiliate

Example: `42`

**total\_revenue\_usd** `string` *required*

The total revenue generated from this affiliate's referrals, formatted as a
USD currency string

**updated\_at** `string\<date-time\>` *required*

The datetime the affiliate was last updated.

Example: `2023-12-01T05:00:00.401Z`

**user** `object` *required*

The user attached to this affiliate

**child attributes**

**id** `string` *required*

The unique identifier for the user.

Example: `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

The display name set on the user's Whop profile. Null if the user has not set a name.

Example: `Jane Smith`

**username** `string | null` *required*

The unique username chosen by the user for their Whop profile. Null if the user has not set a username.

Example: `janesmith`


## Related topics

- [Affiliates](https://docs.whop.com/developer/guides/affiliates.md)
- [Create affiliate](https://docs.whop.com/api-reference/legacy/affiliates/create-affiliate.md)
- [Archive affiliate](https://docs.whop.com/api-reference/legacy/affiliates/archive-affiliate.md)