> ## 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. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md 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. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md 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

> Affiliate는 회사에 대한 사용자의 추천 실적과 커미션 수익을 추적하며, 유지율, 수익 지표, 지급 구성을 포함합니다.

```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*

제휴자의 총 활성 회원 수

예시: `42`

**company** `object` *required*

이 제휴자에 연결된 회사

**하위 속성**

**id** `string` *required*

회사의 고유 식별자입니다.

예시: `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

회사의 표기 이름입니다.

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

제휴자가 생성된 일시입니다.

예시: `2023-12-01T05:00:00.401Z`

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

추천된 고객 중 여전히 활성 회원인 고객의 비율

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

추천된 고객 중 지난 90일 동안 활성 상태를 유지한 고객의 비율

**id** `string` *required*

제휴자의 고유 식별자입니다.

예시: `aff_xxxxxxxxxxxxxx`

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

이 제휴자의 추천으로 발생한 월간 반복 수익으로, USD 통화 문자열 형식입니다

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

제휴자의 상태

사용 가능한 옵션: `active`, `archived`, `deleted`

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

이 제휴자의 전체 오버라이드 수

예시: `42`

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

이 제휴자에게 지급된 총 커미션 수익으로, USD 통화 문자열 형식입니다

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

제휴자의 총 추천 수

예시: `42`

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

이 제휴자의 추천으로 발생한 총 수익으로, USD 통화 문자열 형식입니다

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

제휴자가 마지막으로 업데이트된 일시입니다.

예시: `2023-12-01T05:00:00.401Z`

**user** `object` *required*

이 제휴자에 연결된 사용자

**하위 속성**

**id** `string` *required*

사용자의 고유 식별자입니다.

예시: `user_xxxxxxxxxxxxx`

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

사용자의 Whop 프로필에 설정된 표시 이름입니다. 사용자가 이름을 설정하지 않은 경우 Null입니다.

예시: `Jane Smith`

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

사용자가 Whop 프로필에 선택한 고유 사용자 이름입니다. 사용자가 사용자 이름을 설정하지 않은 경우 Null입니다.

예시: `janesmith`
