Skip to main content
Deze pagina documenteert alle klassen, methoden, eigenschappen en typen die beschikbaar zijn in de WhopCheckout-SDK.

Checkout

De hoofdklasse voor het beheren van in-app-aankopen. Het environment-systeem van SwiftUI kan deze @Observable-klasse gebruiken.

shared

De gedeelde Checkout-instantie. Gebruik deze singleton om de SDK te configureren en aankopen te beheren.
Voorbeeld:

configure(companyId:apiKey:planMappings:)

Configureert en initialiseert de SDK. Roep dit één keer aan bij het opstarten van de app.
Parameters: Voorbeeld:

isInitialized

Geeft aan of de SDK klaar is met initialiseren.
Voorbeeld:

deviceId

De unieke apparaat-ID die door de SDK wordt beheerd. Blijft via de iOS-sleutelhanger behouden tussen het opstarten van de app.

appUserId

Het ID van de huidige gebruiker, of nil voor een gast.

plans

Compatibiliteitseigenschap met de beschikbare abonnementsvarianten voor de geconfigureerde producten.
Voorbeeld:

memberships

Array met actieve lidmaatschappen voor de huidige gebruiker of het huidige apparaat.

isSubscribed

Of de gebruiker een actief lidmaatschap heeft.
Voorbeeld:

supportsExternalPurchases

Of de huidige App Store-regio externe aankopen (niet via StoreKit) ondersteunt. Momenteel true voor gebruikers in de Verenigde Staten en elders false.
Bij true gebruikt de SDK standaard de webcheckout van Whop (lagere kosten). Bij false gebruikt de SDK standaard StoreKit.

refreshPlans()

Vernieuwt de beschikbare varianten vanaf de server.
Retourneert: de vernieuwde varianten met actuele prijzen. Genereert: WhopCheckoutError als het vernieuwen mislukt. Roep dit aan om prijzen of de beschikbaarheid van varianten na de initialisatie bij te werken. Dit werkt ook de compatibiliteitseigenschap plans bij met de nieuwste gegevens. Voorbeeld:

hasAccess(to:)

Controleert of de gebruiker toegang heeft tot een specifiek product.
Parameters: Retourneert: true als de gebruiker een actief lidmaatschap voor het product heeft Voorbeeld:

purchase(_:method:)

Start een aankoopflow voor een variant. Gebruikt standaard de webcheckout van Whop in de Verenigde Staten (lagere kosten) en elders StoreKit.
Parameters: Retourneert: CheckoutPurchaseResult met de bon-ID en lidmaatschapsgegevens Genereert:
  • WhopCheckoutError.cancelled als de gebruiker de checkout sluit
  • WhopCheckoutError.notConfigured als de SDK niet is geconfigureerd
  • WhopCheckoutError.paymentFailed(String) als de betaling mislukt
Voorbeeld:
Gebruik voor Apple Pay Checkout.ApplePayButton, of presentApplePay(_:) wanneer je UI Apple Pay activeert vanuit een aangepaste interactie.

logIn(appUserId:)

Logt een gebruiker in en claimt alle niet-geclaimde lidmaatschappen die aan het apparaat zijn gekoppeld.
Parameters: Voorbeeld:

logOut()

Logt de huidige gebruiker uit en wist diens lidmaatschappen uit de lokale status.
Voorbeeld:

restorePurchases()

Herstelt aankopen van zowel StoreKit als Whop.
Retourneert: true als de SDK een actief abonnement heeft gevonden Voorbeeld:

Typen

CheckoutPurchaseResult

Het resultaat van een geslaagde aankoop.
De eigenschap membership hangt af van de gebruikte betaalmethode:Waarom StoreKit-aankopen nil retourneren: StoreKit-transacties worden asynchroon door Apple verwerkt. Wanneer de aankoop is voltooid, heeft de SDK het Whop-lidmaatschap mogelijk nog niet gesynchroniseerd. De SDK houdt ook StoreKit-rechten bij, dus checkout.isSubscribed retourneert nog steeds true.Hoe je beide gevallen afhandelt:
Belangrijk: vertrouw er niet op dat membership niet nil is om toegang te verlenen. Gebruik altijd checkout.isSubscribed of checkout.hasAccess(to:) om de abonnementsstatus te controleren.

PlanMapping

Een koppeling tussen een Whop-variant en een Apple StoreKit-product, gebruikt tijdens de SDK-configuratie. Hiermee weet de SDK welk Apple-product moet worden gebruikt voor StoreKit-aankopen buiten de Verenigde Staten.
PlanMapping vs. CheckoutPlan: PlanMapping is voor de SDK-configuratie (ID’s koppelen). CheckoutPlan is wat je in je UI toont (met prijzen, titels enzovoort). Je maakt PlanMapping-objecten aan in configure() en opent daarna CheckoutPlan-objecten via checkout.plans.
Voorbeeld:
Je Whop-varianten en Apple-producten moeten overeenkomende prijzen en factureringsperioden hebben. Zie PlanMapping voor details over de compatibiliteits-API.

PaymentMethod

De betaalmethode die voor een aankoop wordt gebruikt.
Apple Pay is niet opgenomen in PaymentMethod; het heeft eigen onderdelen: Checkout.ApplePayButton en presentApplePay(_:).

Checkout.ApplePayButton

Een kant-en-klare SwiftUI-weergave die de officiële Apple Pay-knop van Apple rendert en de volledige aankoopflow afhandelt. Je moet deze component gebruiken (of PKPaymentButton / PayWithApplePayButton) wanneer je Apple Pay aanbiedt; knoppen met een aangepaste stijl zijn niet toegestaan volgens de Human Interface Guidelines van Apple.
Parameters: Voorbeeld:
Apple Pay is niet bedoeld voor digitale content. Gebruik Checkout.ApplePayButton alleen als je app fysieke goederen of diensten in de echte wereld verkoopt. Apps die digitale content verkopen (abonnementen op premiumfuncties, in-app-valuta, enz.) moeten StoreKit gebruiken. Zie de sectie Geschiktheid voor Apple Pay hieronder.

presentApplePay(_:)

Toont het Apple Pay-venster direct, voor UI’s die Apple Pay starten vanuit een aangepaste interactie (bijvoorbeeld een schuif-om-te-betalen-besturingselement) in plaats van de kant-en-klare knop.
Roep dit alleen aan als directe reactie op een gebruikersinteractie; Apple staat het tonen van een betalingsvenster alleen toe wanneer de gebruiker expliciet heeft gevraagd om te betalen. Genereert WhopCheckoutError.cancelled wanneer de gebruiker het venster sluit.
Dezelfde regels voor geschiktheid voor Apple Pay gelden als voor Checkout.ApplePayButton.

CheckoutPlan-weergavemodel

Een abonnementsvariant die te koop is, toegankelijk via de compatibiliteitseigenschap checkout.plans. Gebruik dit om variantinformatie in je UI te tonen en om aankopen te doen.
Compatibiliteitstypen: CheckoutPlan bevat volledige variantgegevens (prijzen, titels, proefperiode-informatie) voor je UI. Plan is een ID-koppeling die tijdens de SDK- configuratie wordt gebruikt. Je maakt nooit zelf CheckoutPlan-objecten aan; ze komen uit checkout.plans na de configuratie.

CheckoutMembership

Een actief abonnementslidmaatschap.

WhopCheckoutError

Fouten die door de SDK worden gegenereerd.

Geschiktheid voor Apple Pay

De meeste apps zouden Apple Pay niet moeten gebruiken. Apple Pay via de WhopCheckout-SDK is alleen bedoeld voor apps die fysieke goederen of diensten in de echte wereld verkopen, niet voor digitale content, abonnementen op appfuncties of in-app-valuta.

Richtlijnen voor App Store-beoordeling

App Store Review Guideline 3.1.1 van Apple vereist dat digitale goederen en diensten (premiumfuncties, abonnementen, het ontgrendelen van content, virtuele valuta) In-App Purchase (StoreKit) gebruiken. Apple Pay is voor deze transacties uitdrukkelijk verboden. Guideline 3.1.3(e) en de Apple Pay-richtlijnen staan Apple Pay toe voor de aankoop van fysieke goederen en diensten in de echte wereld.

Apps die in aanmerking komen

Apps die Apple Pay (Checkout.ApplePayButton) mogen gebruiken: Apps die StoreKit (.storeKit) of de webcheckout van Whop (.whop) moeten gebruiken:

Hoe je kiest

Als je app in aanmerking komt, gebruik dan Checkout.ApplePayButton. Als je niet zeker weet of je app in aanmerking komt, kies dan standaard .whop (Verenigde Staten) of .storeKit (elders). De SDK regelt dit automatisch wanneer je purchase() aanroept zonder een methode op te geven.

Vereisten

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