Skip to main content
Esta página documenta todas las clases, métodos, propiedades y tipos disponibles en el SDK WhopCheckout.
Para ver guías, consulta Crea un paywall o Comprueba los entitlements.

Checkout

La clase principal para gestionar las compras dentro de la app. El sistema de entorno de SwiftUI puede usar esta clase @Observable.

shared

La instancia compartida de Checkout. Usa este singleton para configurar el SDK y gestionar las compras.
Ejemplo:

configure(companyId:apiKey:planMappings:)

Configura e inicializa el SDK. Llámalo una vez al iniciar la app.
Parámetros: Ejemplo:

isInitialized

Indica si el SDK ha terminado de inicializarse.
Ejemplo:

deviceId

El identificador único de dispositivo que gestiona el SDK. Persiste entre inicios de la app gracias al Keychain de iOS.

appUserId

El ID del usuario actual, o nil si es un invitado.

plans

Propiedad de compatibilidad que contiene las variantes de suscripción disponibles para los productos configurados.
Ejemplo:

memberships

Array de membresías activas del usuario o dispositivo actual.

isSubscribed

Indica si el usuario tiene alguna membresía activa.
Ejemplo:

supportsExternalPurchases

Indica si la región actual de la App Store admite compras externas (no de StoreKit). Actualmente es true para usuarios de Estados Unidos y false en el resto del mundo.
Cuando es true, el SDK usa de forma predeterminada el checkout web de Whop (comisiones más bajas). Cuando es false, usa de forma predeterminada StoreKit.

refreshPlans()

Actualiza desde el servidor las variantes disponibles.
Devuelve: las variantes actualizadas con los precios vigentes. Lanza: WhopCheckoutError si la actualización falla. Llámalo para actualizar los precios o la disponibilidad de las variantes después de la inicialización. También actualiza la propiedad de compatibilidad plans con los datos más recientes. Ejemplo:

hasAccess(to:)

Comprueba si el usuario tiene acceso a un producto específico.
Parámetros: Devuelve: true si el usuario tiene una membresía activa para el producto Ejemplo:

purchase(_:method:)

Inicia un flujo de compra para una variante. De forma predeterminada, usa el checkout web de Whop en Estados Unidos (comisiones más bajas) y StoreKit en el resto del mundo.
Parámetros: Devuelve: CheckoutPurchaseResult, que contiene el ID del recibo y la información de la membresía Lanza:
  • WhopCheckoutError.cancelled si el usuario cierra el checkout
  • WhopCheckoutError.notConfigured si el SDK no está configurado
  • WhopCheckoutError.paymentFailed(String) si el pago falla
Ejemplo:
Para Apple Pay, usa Checkout.ApplePayButton, o presentApplePay(_:) cuando tu interfaz active Apple Pay desde una interacción personalizada.

logIn(appUserId:)

Inicia la sesión de un usuario y reclama las membresías no reclamadas asociadas al dispositivo.
Parámetros: Ejemplo:

logOut()

Cierra la sesión del usuario actual y borra sus membresías del estado local.
Ejemplo:

restorePurchases()

Restaura las compras tanto de StoreKit como de Whop.
Devuelve: true si el SDK encontró una suscripción activa Ejemplo:

Tipos

CheckoutPurchaseResult

El resultado de una compra correcta.
La propiedad membership depende del método de pago utilizado:Por qué las compras de StoreKit devuelven nil: Apple procesa las transacciones de StoreKit de forma asíncrona. Cuando se completa la compra, es posible que el SDK aún no haya sincronizado la membresía de Whop. El SDK también registra los entitlements de StoreKit, así que checkout.isSubscribed seguirá devolviendo true.Cómo gestionar ambos casos:
Punto clave: no dependas de que membership no sea nil para conceder acceso. Usa siempre checkout.isSubscribed o checkout.hasAccess(to:) para comprobar el estado de la suscripción.

PlanMapping

Una asignación entre una variante de Whop y un producto de Apple StoreKit, que se usa durante la configuración del SDK. Indica al SDK qué producto de Apple usar para las compras de StoreKit fuera de Estados Unidos.
PlanMapping frente a CheckoutPlan: PlanMapping sirve para la configuración del SDK (asignación de IDs). CheckoutPlan es lo que muestras en tu interfaz (tiene precios, títulos, etc.). Creas objetos PlanMapping en configure() y luego accedes a los objetos CheckoutPlan mediante checkout.plans.
Ejemplo:
Tus variantes de Whop y tus productos de Apple deben tener precios y periodos de facturación equivalentes. Consulta PlanMapping para ver los detalles de la API de compatibilidad.

PaymentMethod

El método de pago que se usa para una compra.
Apple Pay no está incluido en PaymentMethod: tiene sus propias superficies: Checkout.ApplePayButton y presentApplePay(_:).

Checkout.ApplePayButton

Una vista de SwiftUI prediseñada que renderiza el botón oficial de Apple Pay y gestiona todo el flujo de compra. Debes usar este componente (o PKPaymentButton / PayWithApplePayButton) cuando ofrezcas Apple Pay: las Human Interface Guidelines de Apple no permiten botones con estilo personalizado.
Parámetros: Ejemplo:
Apple Pay no es para contenido digital. Usa Checkout.ApplePayButton solo si tu app vende bienes físicos o servicios del mundo real. Las apps que venden contenido digital (suscripciones a funciones premium, moneda dentro de la app, etc.) deben usar StoreKit. Consulta la sección Elegibilidad de Apple Pay más abajo.

presentApplePay(_:)

Presenta la hoja de Apple Pay directamente, para interfaces que inician Apple Pay desde una interacción personalizada (por ejemplo, un control de deslizar para pagar) en lugar del botón prediseñado.
Llámalo solo como respuesta directa a una interacción del usuario: Apple solo permite presentar una hoja de pago cuando el usuario ha pedido pagar de forma explícita. Lanza WhopCheckoutError.cancelled cuando el usuario cierra la hoja.
Se aplican las mismas reglas de elegibilidad de Apple Pay que para Checkout.ApplePayButton.

Modelo de visualización CheckoutPlan

Una variante de suscripción disponible para comprar, a la que se accede mediante la propiedad de compatibilidad checkout.plans. Úsala para mostrar la información de la variante en tu interfaz y para realizar compras.
Tipos de compatibilidad: CheckoutPlan contiene todos los detalles de la variante (precios, títulos, información de la prueba) para tu interfaz. Plan es una asignación de IDs que se usa durante la configuración del SDK. Nunca creas objetos CheckoutPlan: provienen de checkout.plans después de la configuración.

CheckoutMembership

Una membresía de suscripción activa.

WhopCheckoutError

Errores que lanza el SDK.

Elegibilidad de Apple Pay

La mayoría de las apps no deberían usar Apple Pay. Apple Pay a través del SDK WhopCheckout es solo para apps que venden bienes físicos o servicios del mundo real, no contenido digital, suscripciones a funciones de la app ni moneda dentro de la app.

Directrices de revisión de la App Store

La App Store Review Guideline 3.1.1 de Apple exige que los bienes y servicios digitales (funciones premium, suscripciones, desbloqueo de contenido, moneda virtual) usen In-App Purchase (StoreKit). Apple Pay está explícitamente prohibido para estas transacciones. La Guideline 3.1.3(e) y las directrices de Apple Pay permiten Apple Pay para comprar bienes físicos y servicios del mundo real.

Apps que cumplen los requisitos

Apps que pueden usar Apple Pay (Checkout.ApplePayButton): Apps que deben usar StoreKit (.storeKit) o el checkout web de Whop (.whop):

Cómo elegir

Si tu app cumple los requisitos, usa Checkout.ApplePayButton. Si no estás seguro de si tu app cumple los requisitos, usa de forma predeterminada .whop (Estados Unidos) o .storeKit (resto del mundo). El SDK lo gestiona automáticamente cuando llamas a purchase() sin especificar un método.

Requisitos

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