Skip to main content
변형은 가격, 청구 주기, 재고, SKU, 속성, 세금 처리, 결제 필드, 구매 노출 여부를 제어합니다. 변형 ID는 계속 plan_ 접두사를 사용합니다. Variants API를 사용하여 상품의 변형을 생성하고, 기존 변형을 나열하고, 변형 구성을 조회하거나 업데이트하고, 결제를 위한 세금을 계산하고, 더 이상 제공하지 않을 변형을 삭제하세요.

엔드포인트

속성

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

속성

string
필수
계정 ID이며, 접두사는 biz_입니다.
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이면 계정 기본값을 상속합니다.
boolean
필수
계정의 세금 구성에 따라 이 변형의 구매에 세금이 징수되는지 여부.
string
필수
변형이 생성된 시점(ISO 8601 타임스탬프).
string
필수
이 변형의 모든 가격이 표시되는 통화의 소문자 3자리 ISO 4217 코드: 변형 자체의 통화, 또는 변형을 변환할 수 있는 경우 조회 시 요청한 presentment_currency.
object[]
필수
결제 양식에서 수집하는 커스텀 입력 필드.

속성

string
필수
커스텀 필드 ID이며, 접두사는 field_입니다.
string
필수
커스텀 필드 입력 유형.사용 가능한 옵션: text
string
필수
결제 시 고객에게 표시되는 필드 레이블.
number
필수
결제 양식에서의 필드 위치.
string | null
필수
빈 필드에 표시되는 자리 표시자 텍스트. 설정되지 않은 경우 null입니다.
boolean
필수
결제하기 위해 고객이 이 필드를 반드시 작성해야 하는지 여부.
boolean | null
필수
변형을 삭제할 수 있는지 여부(멤버십이나 대기자 명단 항목이 없는 경우). 행위자가 변형 계정에 대한 plan:basic:read 범위를 가진 경우가 아니면 null입니다.
string | null
필수
고객에게 표시되는 변형 설명. 최대 1000자. 설명이 설정되지 않은 경우 null입니다.
object | null
필수
모든 계층(변형 자체 및 계정)을 거쳐 해석된, 이 변형의 결제를 관리하는 구성으로, 세션의 payment_method_configuration이 가지는 형태입니다. 제공 가능한 집합을 얻으려면 결제 수단 유형 카탈로그에 적용하세요. null은 플랫폼 기본값을 의미하며, payment_method_configuration은 변형 자체의 편집 가능한 재정의로 유지됩니다.

속성

string[]
필수
기본값이 제공하더라도 이 체크아웃에서 제외하는 결제 수단입니다.
string[]
필수
기본값이 제공하는 것에 더해 이 체크아웃에서 추가로 제공하는 결제 수단입니다.
boolean
필수
Whop의 기본 설정을 시작점으로 사용하는지 여부입니다. false이면 enabled만 제공됩니다.
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
필수
판매자가 설정하는 자유 텍스트 재고 관리 단위(예: TSHIRT-LARGE-BLUE). 고유성이 강제되지 않습니다. 설정되지 않은 경우 null입니다.
number | null
필수
구독이 일시 중지되기 전에 필요한 할부 결제 횟수. 1보다 커야 합니다. 분할 결제가 구성되지 않은 경우 null입니다.
number | null
필수
구매 가능한 단위 수. 행위자가 변형 계정에 대한 plan:basic:read 범위를 가진 경우가 아니면 null입니다.
number | null
필수
취소선과 함께 표시되는 currency 기준 원래 초기 가격. 취소선이 설정되지 않은 경우 null입니다.
number | null
필수
취소선과 함께 표시되는 currency 기준 원래 갱신 가격. 취소선이 설정되지 않은 경우 null입니다.
string
필수
세금이 가격에 포함되는지, 결제 시 추가되는지, 또는 구성되지 않았는지를 포함하여 이 변형의 세금 처리 방식.사용 가능한 옵션: inclusive, exclusive, unspecified
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를 보고합니다.
integer | null
필수
이 변형에 대해 발행되었지만 결제되거나 무효화되지 않은 인보이스 수. 이 값이 0보다 큰 동안에는 변형의 가격, 청구 기간, 체험, 결제 횟수, 통화 또는 청구 유형을 변경할 수 없습니다. 행위자가 변형 계정에 대한 plan:basic:read 범위를 가진 경우가 아니면 null입니다.
string
필수
변형이 마지막으로 업데이트된 시점(ISO 8601 타임스탬프).
string
필수
이 변형을 볼 수 있는 위치를 제어합니다. hidden인 경우 변형은 직접 링크로만 접근할 수 있습니다.사용 가능한 옵션: visible, hidden, archived, quick_link
Variant