Skip to main content
Cette page documente toutes les classes, méthodes, propriétés et tous les types disponibles dans le SDK WhopCheckout.
Pour les guides, consultez Créer un paywall ou Vérifier les droits d’accès.

Checkout

La classe principale de gestion des achats intégrés. Le système d’environnement de SwiftUI peut utiliser cette classe @Observable.

shared

L’instance Checkout partagée. Utilisez ce singleton pour configurer le SDK et gérer les achats.
Exemple :

configure(companyId:apiKey:planMappings:)

Configure et initialise le SDK. Appelez-la une seule fois au démarrage de l’app.
Paramètres : Exemple :

isInitialized

Indique si le SDK a terminé son initialisation.
Exemple :

deviceId

L’identifiant unique de l’appareil géré par le SDK. Il persiste entre les lancements de l’app grâce au trousseau iOS (Keychain).

appUserId

L’ID de l’utilisateur actuel, ou nil pour un invité.

plans

Propriété de compatibilité contenant les variantes d’abonnement disponibles pour les produits configurés.
Exemple :

memberships

Tableau des adhésions actives de l’utilisateur ou de l’appareil actuel.

isSubscribed

Indique si l’utilisateur dispose d’au moins une adhésion active.
Exemple :

supportsExternalPurchases

Indique si la région App Store actuelle prend en charge les achats externes (hors StoreKit). Actuellement true pour les utilisateurs aux États-Unis et false ailleurs.
Lorsque la valeur est true, le SDK utilise par défaut le checkout web de Whop (frais réduits). Lorsqu’elle est false, il utilise par défaut StoreKit.

refreshPlans()

Actualise les variantes disponibles depuis le serveur.
Renvoie : les variantes actualisées avec leurs prix actuels. Lève : WhopCheckoutError si l’actualisation échoue. Appelez cette méthode pour mettre à jour les prix ou la disponibilité des variantes après l’initialisation. Elle met aussi à jour la propriété de compatibilité plans avec les dernières données. Exemple :

hasAccess(to:)

Vérifie si l’utilisateur a accès à un produit spécifique.
Paramètres : Renvoie : true si l’utilisateur dispose d’une adhésion active pour le produit Exemple :

purchase(_:method:)

Lance un parcours d’achat pour une variante. Par défaut, utilise le checkout web de Whop aux États-Unis (frais réduits) et StoreKit ailleurs.
Paramètres : Renvoie : CheckoutPurchaseResult contenant l’ID du reçu et les informations d’adhésion Lève :
  • WhopCheckoutError.cancelled si l’utilisateur ferme le checkout
  • WhopCheckoutError.notConfigured si le SDK n’est pas configuré
  • WhopCheckoutError.paymentFailed(String) si le paiement échoue
Exemple :
Pour Apple Pay, utilisez Checkout.ApplePayButton, ou presentApplePay(_:) lorsque votre interface déclenche Apple Pay à partir d’une interaction personnalisée.

logIn(appUserId:)

Connecte un utilisateur et revendique les adhésions non revendiquées associées à l’appareil.
Paramètres : Exemple :

logOut()

Déconnecte l’utilisateur actuel et efface ses adhésions de l’état local.
Exemple :

restorePurchases()

Restaure les achats depuis StoreKit et Whop.
Renvoie : true si le SDK a trouvé un abonnement actif Exemple :

Types

CheckoutPurchaseResult

Le résultat d’un achat réussi.
La propriété membership dépend du moyen de paiement utilisé :Pourquoi les achats StoreKit renvoient nil : Les transactions StoreKit sont traitées de manière asynchrone par Apple. Lorsque l’achat se termine, le SDK n’a peut-être pas encore synchronisé l’adhésion Whop. Le SDK suit aussi les droits StoreKit : checkout.isSubscribed renverra donc tout de même true.Comment gérer les deux cas :
Point clé : ne vous fiez pas à une valeur non nil de membership pour accorder l’accès. Utilisez toujours checkout.isSubscribed ou checkout.hasAccess(to:) pour vérifier le statut d’abonnement.

PlanMapping

Une correspondance entre une variante Whop et un produit Apple StoreKit, utilisée lors de la configuration du SDK. Elle indique au SDK quel produit Apple utiliser pour les achats StoreKit en dehors des États-Unis.
PlanMapping vs CheckoutPlan : PlanMapping sert à la configuration du SDK (correspondance des ID). CheckoutPlan est ce que vous affichez dans votre interface (prix, titres, etc.). Vous créez des objets PlanMapping dans configure(), puis vous accédez aux objets CheckoutPlan via checkout.plans.
Exemple :
Vos variantes Whop et vos produits Apple doivent avoir des prix et des périodes de facturation correspondants. Consultez PlanMapping pour les détails de l’API de compatibilité.

PaymentMethod

Le moyen de paiement à utiliser pour un achat.
Apple Pay n’est pas inclus dans PaymentMethod : il dispose de ses propres interfaces, Checkout.ApplePayButton et presentApplePay(_:).

Checkout.ApplePayButton

Une vue SwiftUI prête à l’emploi qui affiche le bouton Apple Pay officiel d’Apple et gère l’ensemble du parcours d’achat. Vous devez utiliser ce composant (ou PKPaymentButton / PayWithApplePayButton) lorsque vous proposez Apple Pay : les Human Interface Guidelines d’Apple n’autorisent pas les boutons au style personnalisé.
Paramètres : Exemple :
Apple Pay n’est pas destiné au contenu numérique. N’utilisez Checkout.ApplePayButton que si votre app vend des biens physiques ou des services réels. Les apps qui vendent du contenu numérique (abonnements à des fonctionnalités premium, monnaie intégrée, etc.) doivent utiliser StoreKit. Consultez la section Éligibilité à Apple Pay ci-dessous.

presentApplePay(_:)

Présente directement la feuille Apple Pay, pour les interfaces qui déclenchent Apple Pay à partir d’une interaction personnalisée (par exemple un contrôle « glisser pour payer ») plutôt qu’avec le bouton prêt à l’emploi.
Appelez-la uniquement en réponse directe à une interaction de l’utilisateur : Apple n’autorise la présentation d’une feuille de paiement que lorsque l’utilisateur a explicitement demandé à payer. Lève WhopCheckoutError.cancelled lorsque l’utilisateur ferme la feuille.
Les mêmes règles d’éligibilité à Apple Pay que pour Checkout.ApplePayButton s’appliquent.

Modèle d’affichage CheckoutPlan

Une variante d’abonnement disponible à l’achat, accessible via la propriété de compatibilité checkout.plans. Utilisez-la pour afficher les informations de variante dans votre interface et pour effectuer des achats.
Types de compatibilité : CheckoutPlan contient tous les détails de la variante (prix, titres, informations d’essai) pour votre interface. Plan est une correspondance d’ID utilisée lors de la configuration du SDK. Vous ne créez jamais d’objets CheckoutPlan : ils proviennent de checkout.plans après la configuration.

CheckoutMembership

Une adhésion d’abonnement active.

WhopCheckoutError

Erreurs levées par le SDK.

Éligibilité à Apple Pay

La plupart des apps ne devraient pas utiliser Apple Pay. Apple Pay via le SDK WhopCheckout est réservé aux apps qui vendent des biens physiques ou des services réels, et non du contenu numérique, des abonnements à des fonctionnalités d’app ou une monnaie intégrée.

Directives de validation de l’App Store

La directive 3.1.1 de l’App Store Review d’Apple exige que les biens et services numériques (fonctionnalités premium, abonnements, déblocage de contenu, monnaie virtuelle) utilisent l’achat intégré (StoreKit). Apple Pay est explicitement interdit pour ces transactions. La directive 3.1.3(e) et les directives Apple Pay autorisent Apple Pay pour l’achat de biens physiques et de services réels.

Apps éligibles

Apps qui peuvent utiliser Apple Pay (Checkout.ApplePayButton) : Apps qui doivent utiliser StoreKit (.storeKit) ou le checkout web de Whop (.whop) :

Comment choisir

Si votre app est éligible, utilisez Checkout.ApplePayButton. Si vous n’êtes pas sûr que votre app soit éligible, utilisez par défaut .whop (États-Unis) ou .storeKit (ailleurs). Le SDK gère cela automatiquement lorsque vous appelez purchase() sans préciser de méthode.

Prérequis

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