> ## 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.

# Whop Partners API

> 추천 링크로 비즈니스를 Whop에 추천하고 해당 활동에 대한 수익을 얻으세요. 수익은 API에서 확인할 수 있습니다.

추천이 유지되는 동안 네 가지 개별 수입원에서 수익을 얻습니다. 한 번의 호출로 등록되고 링크가 반환됩니다. 나머지는 모두 추천한 대상과 얻은 수익을 보고합니다.

## 만들 수 있는 것

* 자신의 링크를 자신의 오디언스와 공유하는 **직접 운영하는 추천 프로그램**.
* **추천한 대상에 대한 보고**: 어떤 비즈니스와 사용자가 여전히 활성 상태인지, 각각이 무엇을 창출하는지.
* 모든 항목의 기반이 되는 거래와 요율까지 세분화된 **수익 명세서**.
* 파트너 리더보드를 활용한 **공개 순위 페이지**.

## 핵심 객체

파트너, 추천된 비즈니스, 파트너 수익. 각 객체는 [핵심 개념](https://docs.whop.com/ko/developer/concepts.md)에 정의되어 있습니다.

## 등록

[`POST /partners`](https://docs.whop.com/ko/api-reference/partners/enroll-as-a-whop-partner)는 호출한 사용자를 등록하고 해당 파트너 비즈니스가 수익을 받을 수 있도록 합니다. 크레딧을 받기 위해 공유하는 URL인 `referral_link`와 `whop_partner_enabled_at`을 반환합니다. 다시 등록해도 원래 등록 시간이 초기화되지 않고 유지되므로, 이 호출은 안전하게 반복할 수 있습니다.

`partner:create` 권한이 필요합니다. 추천 및 수익을 읽으려면 `partner:basic:read`가 필요하며, 추천된 비즈니스 목록 조회에는 `referral:basic:read`도 허용됩니다. [권한](https://docs.whop.com/ko/developer/guides/permissions.md)을 참고하세요.

## 수익 발생 대상

추천된 비즈니스의 `payout_percentages`는 수입원별 요율을 소수로 나타내므로 `0.3`은 30%를 의미합니다. 네 가지 중 세 가지는 Whop 매출총이익의 일정 비율입니다. 광고 지출은 예외로, 지출 자체의 일정 비율입니다.

| `income_source` | 배분 기준 |
| - | - |
| `sales` | 비즈니스의 상품 판매에서 발생한 Whop의 이익 |
| `ad_spend` | 비즈니스의 Whop Ads 지출 |
| `transfer` | 플랫폼 잔액 이체에서 발생한 Whop의 이익 |
| `card_interchange` | 카드 인터체인지에서 발생한 Whop의 이익 |

파트너 비즈니스를 위해 성사된 비즈니스의 경우 해당 요율은 팀에 귀속됩니다. [`GET /partners/businesses/:id`](https://docs.whop.com/ko/api-reference/partners/retrieve-a-referred-business)는 각 요율에서 본인의 몫인 `my_payout_percentages`도 반환합니다. 직접 비즈니스를 추천한 경우에는 전체 요율입니다. 파트너 비즈니스의 거래에서는 요율 중 본인 팀의 몫입니다. 매니저는 자신의 몫에서 하위 담당자의 몫을 뺀 금액을 받고, 거래 참여자는 자신의 몫을 받습니다. 해당 비즈니스에서 수익이 없으면 `null`입니다.

[`GET /partners/businesses`](https://docs.whop.com/ko/api-reference/partners/list-referred-businesses)는 추천한 모든 항목을 최신순으로 나열합니다. 각 파트너 비즈니스에는 `coma_` ID, `active` 또는 `removed`인 `status`, 그리고 `referral_started_at`과 `referral_expires_at`이 포함됩니다.

`earnings_usd`와 `volume_usd`는 단일 숫자가 아니라 객체입니다. `earnings_usd`는 `completed`, `pending`, `total`로 나뉩니다. `volume_usd`는 `attributed`, `awaiting_settlement`, `settled`로 나뉩니다.

## 수익 조회

[`GET /partners/businesses/{id}/earnings`](https://docs.whop.com/ko/api-reference/partners/list-referred-business-earnings)는 하나의 비즈니스에 대해 Whop이 지급하는 금액을 항목별로 나열합니다. 각 수익에는 `income_source`, 수익의 출처인 `transaction_amount_usd`, 그리고 `payout_percentage`가 표시됩니다.

수익은 지급되기 전에 정산됩니다. 정산되기 전까지 `commission_amount_usd`와 `payout_percentage`는 모두 `null`입니다.

| `status` | 의미 |
| - | - |
| `awaiting_settlement` | 기반 거래가 아직 정산되지 않음 |
| `pending` | 정산되었으나 아직 지급되지 않음 |
| `completed` | 지급됨 |
| `canceled` | 지급 전에 무효화됨(`cancelation_reason` 포함) |
| `reversed` | 사후에 회수됨(`cancelation_reason` 포함) |

데이터가 있는 경우 `financial_activity`는 수수료의 기반이 되는 수입 및 비용 항목을 세분화합니다. Whop이 해당 세부 정보를 기록하기 전에 정산된 수익의 경우 `null`입니다.

## 리더보드

[`GET /partners/leaderboard`](https://docs.whop.com/ko/api-reference/partners/retrieve-the-leaderboard)는 파트너 수익을 기준으로 추천인의 순위를 매깁니다. `period` 매개변수는 `day`, `month`, `year`, `last_30_days` 또는 `all_time`을 받으며 기본값은 `all_time`입니다.

인증은 선택 사항입니다. 익명 호출자는 `leaders`에서 순위를 받고, 인증된 호출자는 `me`에서 자신의 순위도 받습니다. 아직 추천 수익이 없으면 `me`는 `null`입니다.

## 다음 단계

> [card] [파트너로 등록](https://docs.whop.com/ko/api-reference/partners/enroll-as-a-whop-partner.md)
>
> 한 번의 호출로 가입하고 추천 링크를 받으세요.

> [card] [추천 목록 조회](https://docs.whop.com/ko/api-reference/partners/list-referred-businesses.md)
>
> 유치한 모든 비즈니스와 수익.

> [card] [제휴사](https://docs.whop.com/ko/developer/guides/affiliates.md)
>
> 자체 상품 내 추천 추적.

> [card] [Partners 레퍼런스](https://docs.whop.com/ko/api-reference/partners/partner)
>
> 플레이그라운드가 포함된 모든 파트너 엔드포인트.


## Related topics

- [Partners API](https://docs.whop.com/ko/api-reference/partners/partner.md)
- [Enroll as a Whop Partner](https://docs.whop.com/ko/api-reference/partners/enroll-as-a-whop-partner.md)
- [Whop API 개요](https://docs.whop.com/ko/api-reference/overview.md)
