Skip to main content
이 페이지는 WhopCheckout SDK에서 사용할 수 있는 모든 클래스, 메서드, 속성, 타입을 설명합니다.
가이드는 페이월 만들기 또는 이용 권한 확인하기를 참고하세요.

Checkout

인앱 구매를 관리하는 기본 클래스입니다. SwiftUI의 environment 시스템에서 이 @Observable 클래스를 사용할 수 있습니다.

shared

공유 Checkout 인스턴스입니다. 이 싱글톤을 사용해 SDK를 구성하고 구매를 관리하세요.
예제:

configure(companyId:apiKey:planMappings:)

SDK를 구성하고 초기화합니다. 앱 시작 시 한 번 호출하세요.
매개변수: 예제:

isInitialized

SDK 초기화가 완료되었는지 나타냅니다.
예제:

deviceId

SDK가 관리하는 고유 기기 식별자입니다. iOS Keychain을 사용해 앱을 다시 실행해도 유지됩니다.

appUserId

현재 사용자의 ID이며, 게스트인 경우 nil입니다.

plans

구성된 상품에 대해 사용 가능한 구독 변형을 담고 있는 호환성 속성입니다.
예제:

memberships

현재 사용자 또는 기기의 활성 멤버십 배열입니다.

isSubscribed

사용자에게 활성 멤버십이 있는지 여부입니다.
예제:

supportsExternalPurchases

현재 App Store 지역이 외부(StoreKit이 아닌) 구매를 지원하는지 여부입니다. 현재 미국 사용자에게는 true, 그 외 지역에서는 false입니다.
true이면 SDK는 기본적으로 Whop 웹 체크아웃(더 낮은 수수료)을 사용합니다. false이면 기본적으로 StoreKit을 사용합니다.

refreshPlans()

서버에서 사용 가능한 변형을 새로 고칩니다.
반환값: 현재 가격이 반영된 새로 고친 변형. 발생하는 오류: 새로 고침이 실패하면 WhopCheckoutError. 초기화 후 가격이나 변형 사용 가능 여부를 업데이트하려면 이를 호출하세요. 호환성 속성 plans도 최신 데이터로 업데이트됩니다. 예제:

hasAccess(to:)

사용자가 특정 상품에 접근할 수 있는지 확인합니다.
매개변수: 반환값: 사용자에게 해당 상품의 활성 멤버십이 있으면 true 예제:

purchase(_:method:)

변형에 대한 구매 흐름을 시작합니다. 기본적으로 미국에서는 Whop 웹 체크아웃(더 낮은 수수료)을, 그 외 지역에서는 StoreKit을 사용합니다.
매개변수: 반환값: 영수증 ID와 멤버십 정보를 담은 CheckoutPurchaseResult 발생하는 오류:
  • 사용자가 체크아웃을 닫으면 WhopCheckoutError.cancelled
  • SDK가 구성되지 않았으면 WhopCheckoutError.notConfigured
  • 결제가 실패하면 WhopCheckoutError.paymentFailed(String)
예제:
Apple Pay에는 Checkout.ApplePayButton을 사용하거나, UI가 사용자 지정 상호작용으로 Apple Pay를 시작하는 경우 presentApplePay(_:)를 사용하세요.

logIn(appUserId:)

사용자를 로그인시키고 기기와 연결된, 아직 귀속되지 않은 멤버십을 귀속시킵니다.
매개변수: 예제:

logOut()

현재 사용자를 로그아웃시키고 로컬 상태에서 멤버십을 지웁니다.
예제:

restorePurchases()

StoreKit과 Whop 모두에서 구매를 복원합니다.
반환값: SDK가 활성 구독을 찾으면 true 예제:

타입

CheckoutPurchaseResult

성공한 구매의 결과입니다.
membership 속성은 사용된 결제 수단에 따라 달라집니다:StoreKit 구매가 nil을 반환하는 이유: StoreKit 거래는 Apple이 비동기적으로 처리합니다. 구매가 완료될 때 SDK가 아직 Whop 멤버십을 동기화하지 못했을 수 있습니다. SDK는 StoreKit 이용 권한도 추적하므로 checkout.isSubscribed는 여전히 true를 반환합니다.두 경우를 모두 처리하는 방법:
핵심: 액세스를 부여할 때 membership이 nil이 아니라는 데 의존하지 마세요. 구독 상태를 확인하려면 항상 checkout.isSubscribed 또는 checkout.hasAccess(to:)를 사용하세요.

PlanMapping

SDK 구성 중에 사용되는 Whop 변형과 Apple StoreKit 상품 간의 매핑입니다. 미국 외 지역의 StoreKit 구매에 어떤 Apple 상품을 사용할지 SDK에 알려줍니다.
PlanMapping과 CheckoutPlan 비교: PlanMapping은 SDK 구성(ID 매핑)용입니다. CheckoutPlan은 UI에 표시하는 것입니다(가격, 제목 등 포함). configure()에서 PlanMapping 객체를 만든 다음, checkout.plans를 통해 CheckoutPlan 객체에 접근하세요.
예제:
Whop 변형과 Apple 상품의 가격 및 청구 주기가 일치해야 합니다. 호환성 API 세부 정보는 PlanMapping을 참고하세요.

PaymentMethod

구매에 사용할 결제 수단입니다.
Apple Pay는 PaymentMethod에 포함되지 않으며, 별도의 인터페이스가 있습니다: Checkout.ApplePayButton 및 presentApplePay(_:).

Checkout.ApplePayButton

Apple의 공식 Apple Pay 버튼을 렌더링하고 전체 구매 흐름을 처리하는 미리 만들어진 SwiftUI 뷰입니다. Apple Pay를 제공할 때는 이 컴포넌트(또는 PKPaymentButton / PayWithApplePayButton)를 사용해야 합니다. Apple의 Human Interface Guidelines는 사용자 지정 스타일 버튼을 허용하지 않습니다.
매개변수: 예제:
Apple Pay는 디지털 콘텐츠용이 아닙니다. 앱이 실물 상품이나 오프라인 서비스를 판매하는 경우에만 Checkout.ApplePayButton을 사용하세요. 디지털 콘텐츠(프리미엄 기능 구독, 인앱 화폐 등)를 판매하는 앱은 StoreKit을 사용해야 합니다. 아래의 Apple Pay 사용 자격 섹션을 참고하세요.

presentApplePay(_:)

미리 만들어진 버튼 대신 사용자 지정 상호작용(예: 밀어서 결제 컨트롤)으로 Apple Pay를 시작하는 UI를 위해 Apple Pay 시트를 직접 표시합니다.
사용자 상호작용에 대한 직접적인 응답으로만 호출하세요. Apple은 사용자가 명시적으로 결제를 요청한 경우에만 결제 시트 표시를 허용합니다. 사용자가 시트를 닫으면 WhopCheckoutError.cancelled가 발생합니다.
Checkout.ApplePayButton과 동일한 Apple Pay 사용 자격 규칙이 적용됩니다.

CheckoutPlan 표시 모델

호환성 속성 checkout.plans를 통해 접근하는, 구매 가능한 구독 변형입니다. UI에 변형 정보를 표시하고 구매하는 데 사용하세요.
호환성 타입: CheckoutPlan에는 UI를 위한 전체 변형 세부 정보(가격, 제목, 체험 정보)가 포함됩니다. Plan은 SDK 구성 중에 사용되는 ID 매핑입니다. CheckoutPlan 객체는 직접 만들지 않으며, 구성 후 checkout.plans에서 가져옵니다.

CheckoutMembership

활성 구독 멤버십입니다.

WhopCheckoutError

SDK가 발생시키는 오류입니다.

Apple Pay 사용 자격

대부분의 앱은 Apple Pay를 사용해서는 안 됩니다. WhopCheckout SDK를 통한 Apple Pay는 실물 상품이나 오프라인 서비스를 판매하는 앱 전용이며, 디지털 콘텐츠, 앱 기능 구독, 인앱 화폐에는 사용할 수 없습니다.

App Store 심사 지침

Apple의 App Store 심사 지침 3.1.1은 디지털 상품 및 서비스(프리미엄 기능, 구독, 콘텐츠 잠금 해제, 가상 화폐)에 인앱 구매(StoreKit)를 사용하도록 요구합니다. 이러한 거래에는 Apple Pay 사용이 명시적으로 금지됩니다. 지침 3.1.3(e)와 Apple Pay 지침은 실물 상품 및 오프라인 서비스 구매에 Apple Pay를 허용합니다.

자격을 갖춘 앱

Apple Pay(Checkout.ApplePayButton)를 사용할 수 있는 앱: StoreKit(.storeKit) 또는 Whop 웹 체크아웃(.whop)을 반드시 사용해야 하는 앱:

선택 방법

앱이 자격을 갖추었다면 Checkout.ApplePayButton을 사용하세요. 앱의 자격 여부가 확실하지 않다면 기본적으로 .whop(미국) 또는 .storeKit(그 외 지역)을 사용하세요. 방법을 지정하지 않고 purchase()를 호출하면 SDK가 이를 자동으로 처리합니다.

요구 사항

  • iOS 17.0+
  • Xcode 15.0+
  • Swift 5.10+