Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.

Playground

Stel de elementen samen met voorbeeldgegevens. Bedien de besturingselementen, voeg elementen toe en schik ze, en zie events live worden geactiveerd:

Opties

Geef deze mee aan whop.checkout.create({ … }), of als props op <Checkout> in React.
string
Bestaand abonnements-ID, met prefix plan_. Verkorte vorm voor een items-array met dit abonnement en quantity. Het abonnement bepaalt de prijs; niets over bedragen kan aan de clientzijde worden vastgelegd. Geef plan, items of een checkoutConfiguration mee. Alleen bij het aanmaken in te stellen: de sessie wordt ermee aangemaakt, en een latere wijziging wordt geweigerd.
number
Hoeveel eenheden er worden gekocht. Abonnementen die meerdere eenheden niet toestaan, weigeren waarden boven 1. Alleen bij het aanmaken in te stellen: de sessie wordt ermee aangemaakt, en een latere wijziging wordt geweigerd. @default 1
CheckoutItemInput[]
De abonnementen in deze checkout en hoeveel eenheden van elk er worden gekocht. Elk item moet bij dezelfde verkoper horen en compatibele factureringsvoorwaarden gebruiken; de API valideert de volledige winkelwagen en prijst die als één afschrijving. Geef dit mee in plaats van plan, quantity of checkoutConfiguration. Alleen bij het aanmaken in te stellen: de sessie wordt aangemaakt op basis van precies deze winkelwagen, en een latere wijziging wordt geweigerd.
string
Bestaand ID van een checkoutconfiguratie, met prefix ch_. Het element maakt er de checkoutsessie mee aan: de configuratie noemt het abonnement dat wordt verkocht (of, in setup-modus, geen abonnement — de checkout slaat een betaalmethode op en schrijft niets af) en levert de eigen affiliatecode, metadata, redirect en voorinstellingen voor betaalmethoden — een optie die je hier ernaast meegeeft, heeft per veld voorrang op die van de configuratie. Geef plan alleen ernaast mee om quantity in te stellen; het moet het eigen abonnement van de configuratie zijn, dat nooit onder de voorinstellingen vandaan kan worden verwisseld. Alleen bij het aanmaken in te stellen.
string
Een promotiecode die wordt toegepast voordat de koper de prijs ooit ziet — de korting staat op de eerste offerte, en de koper kan die nog wijzigen of verwijderen. Geef de code mee die een marketinglink bevatte: een code die is verlopen of nooit geldig was, opent de checkout tegen de volle prijs met de reden op de promotierij, nooit een checkout die niet opent. Alleen bij het aanmaken in te stellen.
string
De affiliate aan wie deze checkout wordt toegeschreven. Alleen bij het aanmaken in te stellen.
CheckoutAttributionInput
Waar deze verkoop vandaan kwam, voor de rapportage van het account: de campagneparameters van de link waarlangs de koper binnenkwam (utmSource, utmMedium, utmCampaign, utmTerm, utmContent, elke andere utm_*-parameter onder utm, een Whop-trackingLinkId, een funnelId en je eigen source). Alles hier wordt bij de bestelling vastgelegd en wordt nooit aan de koper getoond. Alleen bij het aanmaken in te stellen.
Record<string, string>
Je eigen sleutel/waarde-paren om bij de bestelling vast te leggen en op de betaling terug te lezen — bestellings-ID’s, winkelwagen-ID’s of alles waarmee je afstemt. Maximaal 40 stringparen. Alleen bij het aanmaken in te stellen.
string
Waar de koper terechtkomt na een externe betaalstap, ongeacht de uitkomst. Het tabblad komt aan met payment (het pay_-ID; setup met het sint_-ID voor een checkout in setup-modus) en status (succeeded, failed of canceled) toegevoegd, en je andere queryparameters intact. Vertak op status voordat je een successpagina toont: een geweigerde of afgebroken externe stap komt hier ook terecht. Lever via webhooks, niet op basis van dit bezoek. Alleen https (http voor localhost). Alleen bij het aanmaken in te stellen.
Appearance
Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale WhopElements({ appearance }). Wijzig het live met update({ appearance }).
WhopElementsLocale
Taalinstelling voor de UI-tekst van de elementen van deze groep. Stel het in op een van de ingebouwde taalinstellingen van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardtaalinstelling.

Events

Geef callbacks mee in de create-opties of als React-props.

onComplete

Wordt eenmaal per mount geactiveerd wanneer de checkout is voltooid en het resultaat vaststaat. result zegt wat er vaststaat: payment (de koper heeft betaald — paymentId), waitlist_entry (de koper heeft zich aangemeld voor een wachtlijst — entryId) of setup (een checkout in setup-modus heeft de betaalmethode opgeslagen — setupIntentId); sessionId is in alle gevallen de checkoutsessie. Wordt geactiveerd vóór elke navigatie naar returnUrl, dus hier leggen je eigen analytics of advertentiepixels de aankoop vast. Lever via webhooks, niet vanuit deze callback: een checkout die bij een latere paginalading wordt hersteld, activeert hem opnieuw voor hetzelfde resultaat.
CheckoutPaymentCompletion | CheckoutWaitlistCompletion | CheckoutSetupCompletion

onLoadingChange

Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is true zolang een gemount element nog laadt.
boolean

Methoden

Roep deze aan op de Checkout-handle van whop.checkout.create({ … }) of useCheckout().

update

Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de namespace-props. Parameters
Partial<CheckoutOptions>
vereist

destroy

Verwijdert elk element en elke subcontroller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen vrij. Je kunt het meerdere keren aanroepen, maar een verwijderde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt ontkoppeld.

Resources

Maak deze SDK-objecten aan zonder een element te mounten. Elk heeft een eigen pagina:

CheckoutSession

Low-level, headless checkoutsessie voor een pagina die zijn eigen PayPal-knop tekent. load() maakt de checkoutsessie aan op basis van lineItems; show("paypal", { termsAccepted: true }) stuurt de koper naar PayPal — een pop-upvenster op desktop, het hele tabblad op telefoons — en wordt opgelost met de betaling zodra de koper akkoord geeft. Met paymentMethodOptions.paypal.requestShipping vraagt PayPal de koper om een verzendadres en prijst de webhook van het account die is geabonneerd op shipping_address.changed elk adres op je server terwijl de koper op PayPal is; de betaling wordt pas aangemaakt nadat de koper akkoord geeft, tegen die prijs. Na een volledige paginaredirect wordt de promise nooit afgehandeld; lees de uitkomst in plaats daarvan uit de queryparameters payment en status van redirectUrl.

Elementen

De elementen die deze groep mount. Elk heeft een eigen pagina: Alternatieven. Mount er één tegelijk. Verwijder het voordat je een ander mount:

CheckoutElement

Het volledige checkoutoppervlak — orderoverzicht met de live offerte, invoer van promotiecodes, de valuta waarin de koper betaalt, alles wat deze checkout bij de koper moet verzamelen, het samengestelde oppervlak voor betaalmethoden en de betaalflow. Wat er wordt verzameld, is wat de verkoper heeft ingesteld (e-mail, eigen vragen, een telefoonnummer, een verzendadres voor fysieke goederen, een uitdrukkelijke instemming met hun voorwaarden), samen weergegeven op één scherm in de volgorde die zij kozen — dus een verkoper die iets nieuws gaat vragen, hoeft hier niets te wijzigen. Geeft de volledige aankoop weer; de checkout-controller beheert de sessie en de referentie. Na een betaling die een externe stap vereist, geeft ditzelfde oppervlak de uitkomst weer die de server meldt wanneer de koper terugkomt.

ExpressCheckoutElement

Apple Pay-, Google Pay- en PayPal-knoppen met één druk voor een checkout — de wallet verzamelt wat de sessie nog nodig heeft (het e-mailadres van de koper, een verzendadres voor fysieke goederen, een telefoonnummer wanneer de verkoper er een verzamelt in Apple Pay en Google Pay, en in Apple Pay een promotiecode wanneer de verkoper invoer daarvan aanbiedt) en één druk rondt de aankoop af. Het deelt de invoerplek van de checkout met het volledige checkoutelement, zodat een handle precies één van de twee mount: deze knop alleen wanneer de aankoop eenvoudig genoeg is om in een sheet af te ronden, of het volledige checkoutoppervlak voor al het andere. Geeft alleen de wallets weer waarmee het apparaat van de koper daadwerkelijk kan betalen — en die de betaalmethodeconfiguratie van de checkout toestaat — met de geleverde knopafbeeldingen, en geeft niets weer wanneer er geen wallet beschikbaar is. PayPal verschijnt wanneer de verkoper het accepteert, opent in een eigen venster en slaat het PayPal-account van de koper op bij de aankoop, zodat een verlenging, een gratis proefperiode en latere afschrijvingen door de verkoper werken als een opgeslagen kaart. Alle drie de wallets vereisen Apple Pay op het domein van de pagina: first-party whop.com-pagina’s zijn vooraf goedgekeurd, en elke andere site moet Apple Pay aan zijn domein toevoegen via de Domains API voordat een van deze knoppen daar wordt weergegeven. Het aanbieden van Google Pay op je eigen site is onderworpen aan de Google Pay API Terms of Service. Een checkout die de sheet niet eerlijk kan afronden — aanmelding voor een wachtlijst, een overdracht, een formuliervraag die alleen een pagina kan stellen — weigert duidelijk in plaats van een kansloze knop weer te geven.