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

# Membership

> 멤버십은 사용자와 제품 간의 활성 관계를 나타냅니다. 사용자의 접근 권한, 청구 상태, 갱신 일정을 추적합니다.

> [!NOTE]
>
> 이 리소스에는 신규 통합이 기반으로 삼아야 하는 버전 지정 API인 [Whop API](https://docs.whop.com/ko/api-reference/legacy/memberships/membership.md)에 후속 리소스가 있습니다. 이 페이지는 계속 완전히 지원됩니다.

```json Example theme={null}
{
	"cancel_at_period_end": true,
	"cancel_option": "too_expensive",
	"cancelation_status": "won_back",
	"canceled_at": "2023-12-01T05:00:00.401Z",
	"cancellation_reason": "I found a better alternative.",
	"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"custom_field_responses": [
		{
			"answer": "<string>",
			"id": "cfrp_xxxxxxxxxxxxx",
			"question": "<string>"
		}
	],
	"external_accounts": [
		{
			"external_id": "<string>",
			"platform": "<string>",
			"username": "<string>"
		}
	],
	"feedback_option": {
		"label": "<string>"
	},
	"formatted_renewal_price": "$25.00 / month",
	"id": "mem_xxxxxxxxxxxxxx",
	"initial_price_paid": "$25.00",
	"joined_at": "2023-12-01T05:00:00.401Z",
	"license_key": "A1B2C3-D4E5F6-G7H8I9",
	"manage_url": "https://whop.com/billing/manage/mem_abc123",
	"member": {
		"id": "mber_xxxxxxxxxxxxx"
	},
	"metadata": {},
	"payment_collection_paused": true,
	"plan": {
		"id": "plan_xxxxxxxxxxxxx",
		"metadata": {}
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"metadata": {},
		"title": "Pickaxe Analytics"
	},
	"promo_code": {
		"id": "promo_xxxxxxxxxxxx"
	},
	"renewal_period_end": "2023-12-01T05:00:00.401Z",
	"renewal_period_start": "2023-12-01T05:00:00.401Z",
	"status": "trialing",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"profile_pic": "<string>",
		"username": "johndoe42"
	}
}
```

**cancel\_at\_period\_end** `boolean` *required*

이 멤버십이 현재 청구 주기 종료 시 취소되도록 설정되어 있는지 여부입니다. 반복 플랜이 있는 멤버십에만 적용됩니다.

**cancel\_option** `CancelOptions | null` *required*

회원이 취소한 이유로 선택한 범주입니다(예: too\_expensive, switching, missing\_features).

사용 가능한 옵션: `too_expensive`, `switching`, `missing_features`, `technical_issues`, `bad_experience`, `unused`, `other`, `testing`

**cancelation\_status** `CancelationStatus | null` *required*

고객이 취소 중인지, 떠났는지, 다시 돌아왔는지 여부입니다. 멤버십에 취소 사유가 없거나 취소 상태를 판단할 수 없는 경우 Null입니다.

사용 가능한 옵션: `won_back`, `left`, `canceling`

**canceled\_at** `string\<date-time\> | null` *required*

고객이 이 멤버십의 취소를 시작한 시간입니다. Unix 타임스탬프 형식입니다. 멤버십이 취소되지 않은 경우 Null입니다.

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

**cancellation\_reason** `string | null` *required*

고객이 취소할 때 제공한 자유 형식 설명입니다. 고객이 사유를 제공하지 않은 경우 Null입니다.

예시: `I found a better alternative.`

**checkout\_configuration\_id** `string | null` *required*

이 멤버십을 생성한 체크아웃 세션/구성의 ID입니다(있는 경우). 멤버십을 생성한 체크아웃 구성에 다시 매핑할 때 사용하세요.

예시: `ch_xxxxxxxxxxxxxxx`

**company** `object` *required*

이 멤버십이 속한 회사입니다.

**하위 속성**

**id** `string` *required*

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

예시: `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

고객에게 표시되는 회사의 표시 이름입니다.

예시: `Pickaxe`

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

멤버십이 생성된 일시입니다.

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

**currency** `Currencies | null` *required*

이 멤버십 청구에 사용되는 세 글자 ISO 통화 코드입니다. 멤버십이 무료인 경우 Null입니다.

사용 가능한 옵션: `usd`, `sgd`, `inr`, `aud`, `brl`, `cad`, `dkk`, `eur`, `nok`, `gbp`, `sek`, `chf`, `hkd`, `huf`, `jpy`, `mxn`, `myr`, `pln`, `czk`, `nzd`, `aed`, `eth`, `ape`, `cop`, `ron`, `thb`, `bgn`, `idr`, `dop`, `php`, `try`, `krw`, `twd`, `vnd`, `pkr`, `clp`, `uyu`, `ars`, `zar`, `dzd`, `tnd`, `mad`, `kes`, `kwd`, `jod`, `all`, `xcd`, `amd`, `bsd`, `bhd`, `bob`, `bam`, `khr`, `crc`, `xof`, `egp`, `etb`, `gmd`, `ghs`, `gtq`, `gyd`, `ils`, `jmd`, `mop`, `mga`, `mur`, `mdl`, `mnt`, `nad`, `ngn`, `mkd`, `omr`, `pyg`, `pen`, `qar`, `rwf`, `sar`, `rsd`, `lkr`, `tzs`, `ttd`, `uzs`, `rub`, `btc`, `cny`, `usdt`, `kzt`, `awg`, `whop_usd`, `xau`, `hnl`

**custom\_field\_responses** `array\<object\>` *required*

구매 시점에 제품에 구성된 커스텀 체크아웃 질문에 대한 고객의 응답입니다.

**하위 속성**

**answer** `string` *required*

사용자가 특정 질문 또는 필드에 제공한 응답입니다.

**id** `string` *required*

커스텀 필드 응답의 고유 식별자입니다.

예시: `cfrp_xxxxxxxxxxxxx`

**question** `string` *required*

커스텀 필드가 묻는 질문

**external\_accounts** `array\<object\> | null` *required*

Discord, Telegram 등 외부 플랫폼에서의 회원 계정입니다. 연결된 계정이 없으면 비어 있습니다. 웹훅에서는 Null입니다.

**하위 속성**

**external\_id** `string` *required*

플랫폼에서의 회원 사용자 ID입니다(예: Discord 사용자 ID). 플랫폼 접두사가 붙으며(`discord_\<external_id>`), List Memberships가 필터링에 사용하는 `external_account` 값입니다.

**platform** `string` *required*

회원 계정이 있는 플랫폼입니다: `discord` 또는 `telegram`.

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

플랫폼에서의 회원 사용자 이름입니다. Discord ID만으로 가져온 멤버십처럼 Whop이 알지 못하는 경우 Null입니다.

**feedback\_option** `object | null` *required*

회원이 선택한 계정 자체의 취소 사유로, 회원이 본 그대로입니다. 회원이 기본 범주를 선택했거나 사유를 제공하지 않은 경우 `null`입니다.

**하위 속성**

**label** `string` *required*

회원이 선택했을 당시 옵션의 레이블입니다. 나중에 옵션 이름을 변경해도 바뀌지 않습니다.

**formatted\_renewal\_price** `string | null` *required*

이 멤버십의 반복 갱신 가격으로, 통화 기호와 청구 간격이 포함된 형식입니다. 멤버십이 반복 결제가 아닌 경우 Null입니다.

예시: `$25.00 / month`

**id** `string` *required*

멤버십의 고유 식별자입니다.

예시: `mem_xxxxxxxxxxxxxx`

**initial\_price\_paid** `string` *required*

고객이 이 멤버십을 처음 구매할 때 지불한 금액으로, 통화 기호가 포함된 형식입니다.

예시: `$25.00`

**joined\_at** `string\<date-time\> | null` *required*

사용자가 이 멤버십과 연결된 회사에 처음 가입한 시간입니다. Unix 타임스탬프 형식입니다. 회원 기록이 없는 경우 Null입니다.

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

**license\_key** `string | null` *required*

이 멤버십과 연결된 소프트웨어 라이선스 키입니다. 제품에 Whop Software Licensing 익스피리언스가 포함된 경우에만 존재합니다. 그 외의 경우 Null입니다.

예시: `A1B2C3-D4E5F6-G7H8I9`

**manage\_url** `string | null` *required*

고객이 취소 및 플랜 변경을 포함해 이 멤버십을 확인하고 관리할 수 있는 URL입니다. 회원 기록이 없는 경우 Null입니다.

예시: `https://whop.com/billing/manage/mem_abc123`

**member** `object | null` *required*

이 멤버십에 대해 사용자와 회사를 연결하는 회원 기록입니다. 회원 기록이 아직 생성되지 않은 경우 Null입니다.

**하위 속성**

**id** `string` *required*

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

예시: `mber_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

멤버십의 커스텀 키-값 쌍입니다(소프트웨어 라이선스에 주로 사용됨, 예: HWID). 최대 50개 키, 키당 100자, 문자열 값당 500자입니다.

**payment\_collection\_paused** `boolean` *required*

회사가 이 멤버십의 반복 결제 수금을 일시 중지했는지 여부입니다.

**plan** `object` *required*

이 멤버십을 생성하기 위해 고객이 구매한 플랜입니다.

**하위 속성**

**id** `string` *required*

플랜의 고유 식별자입니다.

예시: `plan_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

플랜에 저장된 커스텀 키-값 쌍입니다. 결제 및 멤버십 이벤트의 웹훅 페이로드에 포함됩니다. 최대 50개 키, 키당 100자, 문자열 값당 500자입니다. 예약 키 `custom_cta`와 `custom_cta_url`이 설정되면 이 플랜에 대한 제품의 체크아웃 행동 유도 문구를 재정의합니다.

**product** `object` *required*

이 멤버십이 접근 권한을 부여하는 제품입니다.

**하위 속성**

**id** `string` *required*

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

예시: `prod_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

제품에 저장되어 결제 및 멤버십 웹훅 페이로드에 포함되는 커스텀 키-값 쌍입니다. 최대 50개 키, 키당 100자, 문자열 값당 500자입니다.

**title** `string` *required*

제품 페이지와 검색 결과에서 고객에게 표시되는 제품의 표시 이름입니다.

예시: `Pickaxe Analytics`

**promo\_code** `object | null` *required*

현재 이 멤버십 청구에 적용된 프로모션 코드입니다. 활성 프로모션 코드가 없는 경우 Null입니다.

**하위 속성**

**id** `string` *required*

프로모션 코드의 고유 식별자입니다.

예시: `promo_xxxxxxxxxxxx`

**renewal\_period\_end** `string\<date-time\> | null` *required*

이 반복 멤버십의 현재 청구 기간 종료 시점입니다. Unix 타임스탬프 형식입니다. 멤버십이 반복 결제가 아닌 경우 Null입니다.

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

**renewal\_period\_start** `string\<date-time\> | null` *required*

이 반복 멤버십의 현재 청구 기간 시작 시점입니다. Unix 타임스탬프 형식입니다. 멤버십이 반복 결제가 아닌 경우 Null입니다.

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

**status** `MembershipStatus` *required*

멤버십의 현재 라이프사이클 상태입니다(예: active, trialing, past\_due, canceled, expired, completed).

사용 가능한 옵션: `trialing`, `active`, `past_due`, `completed`, `canceled`, `expired`, `unresolved`, `drafted`, `canceling`

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

멤버십이 마지막으로 업데이트된 일시입니다.

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

**user** `object | null` *required*

이 멤버십을 소유한 사용자입니다. 사용자 계정이 삭제된 경우 Null입니다.

**하위 속성**

**email** `string | null` *required*

사용자의 이메일 주소입니다. 접근하려면 member:email:read 권한이 필요합니다. 권한이 없으면 Null입니다.

예시: `john.doe@example.com`

**id** `string` *required*

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

예시: `user_xxxxxxxxxxxxx`

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

공개 프로필에 표시되는 사용자의 표시 이름입니다.

예시: `John Doe`

**profile\_pic** `string` *required*

사용자 프로필 사진의 URL입니다. 전체 첨부 파일 객체는 profilePicture를 사용하세요.

**username** `string` *required*

공개 프로필에 표시되는 사용자의 고유한 사용자 이름입니다.

예시: `johndoe42`


## Related topics

- [Memberships API](https://docs.whop.com/ko/api-reference/memberships/membership.md)
- [Transfer Membership](https://docs.whop.com/ko/api-reference/memberships/transfer-membership.md)
- [Reactivate Membership](https://docs.whop.com/ko/api-reference/memberships/reactivate-membership.md)
