Skip to main content
Products API를 사용하면 공개 마켓플레이스를 검색하고, 계정의 상품 목록을 조회하고, 상품을 조회하고, 상품을 생성, 업데이트 또는 삭제할 수 있습니다.
Legacy Products 리소스를 대체합니다. 기존 Legacy 통합은 계속 작동합니다. 안정성 계약은 API 버전을 참조하세요.

엔드포인트

속성

string
필수
prod_ 접두사가 붙은 상품 ID입니다.
object | null
필수
이 상품을 판매하는 계정입니다.
number
필수
이 상품의 게시된 리뷰 전체의 평균 별점으로, 1.0에서 5.0 사이입니다. 게시된 리뷰 평점이 없으면 0.0을 반환합니다.
string
필수
상품이 생성된 시각으로, ISO 8601 타임스탬프입니다.
string | null
필수
상품 구매 페이지에 표시되는 행동 유도(CTA) 버튼 레이블입니다.사용 가능한 옵션: get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_order
string | null
필수
행동 유도 버튼이 결제 화면 대신 연결되는 URL입니다.
string | null
필수
고객의 은행 명세서에 표시되는 사용자 정의 텍스트 레이블입니다.
object | null
필수
표시하고 결제에 사용할 구매 가능한 변형입니다. 구성된 기본 변형이 구매 가능하면 그 변형이고, 그렇지 않으면 상품 페이지 순서상 첫 번째 구매 가능한 변형입니다. 구매 가능한 변형이 없으면 null입니다.
string | null
필수
상품 페이지에 표시되는 설명 문구입니다. 설정되지 않은 경우 null입니다.
object[]
필수
상품에 포함된 경험(코스, 채팅, 앱 등)으로, 가장 오래된 것이 먼저 나옵니다. 처음 100개만 포함하며, 나머지는 GET /experiences?product_id=로 페이지별로 조회하세요.

속성

string
필수
exp_ 접두사가 붙은 경험 ID입니다.
object
필수
경험이 실행되는 앱입니다.

속성

string
필수
app_ 접두사가 붙은 앱 ID입니다.
object
필수
앱 아이콘입니다. 업로드된 아이콘이 없으면 기본 앱 아이콘으로 대체됩니다.

속성

string
필수
아이콘 이미지 URL입니다. 항상 존재하며, 업로드된 아이콘이 없으면 기본 앱 아이콘입니다.
string
필수
앱 표시 이름입니다.
string | null
필수
이 경험에 업로드된 로고 이미지 URL입니다. 없으면 null이며, 이 경우 앱의 icon을 대신 표시하세요.
string
필수
경험 표시 이름입니다.
string | null
필수
사용자 참조용으로 상품에 저장된 외부 식별자입니다.
이 상품의 갤러리 이미지로, 위치 순서대로 정렬됩니다.

속성

string
필수
갤러리 이미지 ID입니다.
string | null
필수
업로드된 파일의 MIME 유형으로, 예를 들어 image/jpeg입니다.
string | null
필수
클라이언트에서 이 이미지를 렌더링하기 위해 미리 최적화된 URL입니다.
number | null
필수
글로벌 제휴 프로그램을 통해 제휴자가 받는 커미션 비율입니다.
string | null
필수
글로벌 제휴 프로그램의 등록 상태입니다.사용 가능한 옵션: enabled, disabled
string | null
필수
상품 페이지에 표시되는 짧은 마케팅 헤드라인입니다.
string[]
필수
상품을 컬렉션으로 그룹화하는 데 사용되는 소문자 레이블입니다. 하나의 컬렉션을 가져오려면 목록 엔드포인트를 labels로 필터링하세요.
string | null
필수
상품 페이지와 검색 결과에 표시되는 로고 이미지 URL입니다. 상품에 로고가 없으면 null입니다.
string
필수
whop.com 마켓플레이스의 등록 상태입니다. pending_review는 제출되어 검토를 기다리는 중임을, live_marketplace는 승인되어 검색 가능함을 의미합니다.사용 가능한 옵션: not_available, pending_review, live_marketplace
number | null
필수
회원 제휴 프로그램을 통해 회원이 받는 커미션 비율입니다.
string | null
필수
회원 제휴 프로그램의 등록 상태입니다.사용 가능한 옵션: enabled, disabled
number
필수
이 상품의 활성 멤버십 수입니다. 공개 회원 수가 비활성화된 경우 0입니다.
object | null
필수
상품에 저장된 사용자 정의 키-값 쌍입니다.
object | null
필수
이 상품을 판매하는 계정을 소유한 사용자입니다.
object | null
필수
이 상품의 세금 분류 코드이며, 세금 코드가 설정되지 않은 경우 null입니다.
number
필수
이 상품에 게시된 고객 리뷰 수입니다.
string
필수
상품 공개 링크의 URL 슬러그입니다.
string
필수
고객에게 표시되는 상품 표시 이름입니다.
string
필수
상품이 마지막으로 업데이트된 시각으로, ISO 8601 타임스탬프입니다.
object | null
필수
상품의 변형들이 아우르는 옵션 세트로, 속성 이름을 사용 중인 값에 매핑한 맵입니다. 예: \{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. attributes를 가진 표시 상태의 비인보이스 변형에서 파생되며, 키는 알파벳순, 값은 변형이 생성된 순서입니다. 읽기 전용입니다. 상품에 변형이 없으면 null입니다.
object[] | null
필수
visibility가 visible이고 인보이스용으로 생성되지 않은 상품의 변형으로, 생성 순서대로 나열됩니다. 일반 가격 옵션은 attributes: null로 포함됩니다. 숨김, 보관, 퀵 링크, 인보이스 변형은 GET /variants를 통해 계속 조회할 수 있습니다. 상품의 변형이 1000개를 초과하는 경우(GET /variants?product_ids=로 페이지별 조회)와 웹훅 페이로드에서는 null입니다.

속성

string
필수
plan_ 접두사가 붙은 변형 ID입니다.
object | null
필수
이 변형을 판매하는 계정입니다. 독립 인보이스 변형의 경우 null입니다.

속성

string
필수
biz_ 접두사가 붙은 계정 ID입니다.
string
필수
계정 표시 이름입니다.
boolean
필수
이 변형에 적응형 가격 책정이 활성화되어 있는지 여부입니다. 원시 설정값으로, 결제 처리업체 호환성이나 기능 플래그는 확인하지 않습니다.
boolean
필수
한 주문에서 두 개 이상 구매할 수 있는지 여부입니다. 갱신 변형은 이를 활성화할 수 없습니다. false이면 결제, 장바구니, 인보이스에서 1을 초과하는 수량을 거부합니다.
object | null
필수
상품 내에서 이 변형을 구별하는 속성 값으로, 속성 이름을 값에 매핑한 맵입니다. 예: \{"color": "Blue", "size": "Large"}. 이름은 snake_case 식별자이며 알파벳순으로 반환됩니다. 상품에서 속성을 가진 모든 변형은 동일한 속성 이름과 서로 다른 값 세트를 가지며, 상품은 전체 옵션 세트를 variant_attributes로 나열합니다. 변형에 속성이 없으면 null입니다.
number | null
필수
반복 청구 사이의 일수로, 예를 들어 월간은 30, 연간은 365입니다. 일회성 변형의 경우 null입니다.
string
필수
이 변형의 청구 모델입니다.사용 가능한 옵션: renewal, one_time
number | null
필수
취소 할인이 유지되는 기간입니다. 0은 영구, 1은 다음 결제에만 적용되며, 그 외에는 고객이 수락한 시점부터의 개월 수입니다. 제공되지 않거나 행위자에게 plan:basic:read 스코프가 없으면 null입니다.
number | null
필수
정수 백분율로 표시된 취소 할인입니다. 제공되지 않거나 행위자에게 plan:basic:read 스코프가 없으면 null입니다.
object | null
필수
변형 수준의 결제 화면 스타일(background_color, button_color, font_family, border_style)입니다. null이면 계정 기본값을 상속합니다.
string
필수
변형이 생성된 시각으로, ISO 8601 타임스탬프입니다.
string
필수
이 변형의 모든 가격이 표시되는 통화의 소문자 세 글자 ISO 4217 코드입니다. 변형 자체의 통화이거나, 변형을 환산할 수 있는 경우 조회 시 요청한 presentment_currency입니다.
object[]
필수
결제 양식에서 수집하는 사용자 정의 입력 필드입니다.

속성

string
필수
field_ 접두사가 붙은 사용자 정의 필드 ID입니다.
string
필수
사용자 정의 필드의 입력 유형입니다.사용 가능한 옵션: text
string
필수
결제 시 고객에게 표시되는 필드 레이블입니다.
number
필수
결제 양식에서의 필드 위치입니다.
string | null
필수
빈 필드에 표시되는 플레이스홀더 텍스트입니다. 설정되지 않은 경우 null입니다.
boolean
필수
결제하려면 고객이 이 필드를 반드시 입력해야 하는지 여부입니다.
string | null
필수
고객에게 표시되는 변형 설명입니다. 최대 1000자입니다. 설명이 설정되지 않은 경우 null입니다.
number | null
필수
만료 기반 변형의 접근 기간(일)으로, 예를 들어 1년 이용권은 365입니다. 만료가 없는 변형의 경우 null입니다.
string
필수
currency 기준으로 표시용으로 포맷된 가격(통화 + 주기)입니다. 예: “$10 / month”.
object | null
필수
상품 페이지에 표시되는 가격 등급 이미지(url, blurhash)입니다. 이미지가 설정되지 않은 경우 null입니다.
number
필수
currency 기준 초기 구매 가격입니다.
object
필수
프로모션 코드와 세금 적용 전 결제 시 한 단위에 대해 청구되는 총액입니다. 반복 변형의 경우 initial_price에 첫 renewal_price를 더한 금액이고, 무료 체험이 적용되는 동안에는 initial_price만입니다. 조회하는 사용자가 이미 이 변형의 체험판을 사용한 경우 체험판이 적용되지 않습니다. currency 기준으로 표시됩니다.

속성

string
필수
주 단위 금액이며, 정확한 십진수 문자열입니다. 예를 들어 "10.00"은 10달러입니다. 전송 중 부동소수점 반올림이 발생하지 않도록 문자열로 제공됩니다.
string
필수
소문자로 된 세 글자 ISO 4217 통화 코드입니다.
integer
필수
금액이 갖는 소수 자릿수입니다. 실제 결제가 처리되는 정밀도입니다.
integer
필수
표시할 소수 자릿수입니다. 일반적으로 decimals와 같지만, 의도적으로 항상 같지는 않습니다. COP는 센타보 단위로 청구되지만 페소 단위로 표기되므로 각각 2와 0입니다. 이 값을 사용하여 사용자의 로캘에 맞게 숫자를 포맷하세요.
string | null
필수
고객에게 표시되지 않는 비공개 메모입니다. 행위자가 변형 계정에 대한 plan:basic:read 스코프를 보유하지 않으면 null입니다.
object | null
필수
이 변형이 생성된 인보이스입니다. 인보이스용으로 생성되지 않은 경우 null입니다.
number | null
필수
이 변형을 통한 활성 멤버십 수입니다. 행위자가 변형 계정에 대한 plan:basic:read 스코프를 보유하지 않으면 null입니다.
object | null
필수
변형에 저장된 사용자 정의 키-값 쌍입니다. 결제 및 멤버십 이벤트의 웹훅 페이로드에 포함됩니다. 최대 50개의 키, 키당 100자, 값당 500자입니다. 예약된 키 custom_cta와 custom_cta_url을 설정하면 이 변형에 대해 상품의 결제 행동 유도 문구를 재정의합니다.
boolean | null
필수
취소 할인이 제공되는지 여부입니다. 행위자가 변형 계정에 대한 plan:basic:read 스코프를 보유하지 않으면 null입니다.
object | null
필수
결제 수단 구성(enabled, disabled, include_platform_defaults)입니다. 변형이 기본 설정을 사용하는 경우 null입니다.
object | null
필수
이 변형이 속한 상품입니다. 독립 변형의 경우 null입니다.
string
필수
고객이 이 변형을 직접 구매할 수 있는 URL입니다.
string | null
필수
이 변형 결제 후 고객이 이동하는 위치입니다. 설정되지 않았거나, 행위자가 변형 계정에 대한 plan:basic:read 스코프를 보유하지 않으면 null입니다.
string
필수
이 변형의 판매 방식입니다.사용 가능한 옵션: buy_now, waitlist
number
필수
currency 기준으로 청구 주기마다 청구되는 반복 가격입니다.
string | null
필수
재고 관리 단위(SKU)로, 판매자가 설정한 자유 텍스트입니다(예: TSHIRT-LARGE-BLUE). 고유성이 강제되지 않습니다. 설정되지 않은 경우 null입니다.
number | null
필수
구독이 일시 중지되기 전에 필요한 할부 결제 횟수입니다. 1보다 커야 합니다. 분할 결제가 구성되지 않은 경우 null입니다.
number | null
필수
구매 가능한 수량입니다. 행위자가 변형 계정에 대한 plan:basic:read 스코프를 보유하지 않으면 null입니다.
number | null
필수
취소선과 함께 표시되는 원래 초기 가격으로, currency 기준입니다. 취소선 가격이 설정되지 않은 경우 null입니다.
number | null
필수
취소선과 함께 표시되는 원래 갱신 가격으로, currency 기준입니다. 취소선 가격이 설정되지 않은 경우 null입니다.
string | null
필수
지원되는 온세션 카드 결제에 대한 3D Secure 동작입니다. mandate_challenge는 결제 처리 전에 3DS 챌린지를 요구하고, mandate_if_required는 결제 처리업체가 요구하는 경우에만 챌린지를 의무화하며, frictionless_if_required는 일반적인 마찰 없는 3DS 흐름을 사용합니다. $1,000 이상의 결제는 mandate_challenge를 선택하지 않는 한 mandate_if_required를 사용합니다. 위험 및 인증 복구 요구 사항이 이 설정보다 우선할 수 있습니다. null이면 계정 기본값을 상속합니다.사용 가능한 옵션: mandate_challenge, mandate_if_required, frictionless_if_required
string | null
필수
고객에게 표시되는 변형 표시 이름입니다. 최대 30자입니다. 제목 없이 생성된 변형은 기본적으로 속성 값을 /로 연결한 값을 사용합니다. 제목이 설정되지 않은 경우 null입니다.
number | null
필수
첫 갱신 청구 전 무료 체험 일수입니다. 체험판이 구성되지 않았거나 사용자가 이미 이 변형의 체험판을 사용한 경우 null입니다.
boolean
필수
변형의 재고가 무제한인지 여부입니다. true이면 stock 필드는 무시되며, 대기자 명단 변형은 항상 true를 보고합니다.
string
필수
변형이 마지막으로 업데이트된 시각으로, ISO 8601 타임스탬프입니다.
string
필수
이 변형이 표시되는 위치를 제어합니다. hidden이면 직접 링크로만 변형에 접근할 수 있습니다.사용 가능한 옵션: visible, hidden, archived, quick_link
boolean
필수
Whop이 상품을 인증했는지 여부입니다.
string | null
필수
상품이 공개, 숨김, 보관 상태 중 어느 것인지 나타냅니다.
Product