Driver en fuld hostet checkout for en eller flere planer — specificeret prisoversigt, rabatkoder, den valuta, køberen betaler i, og hele fladen til indsamling af betaling (betalingselementerne, sammensat indeni) — mod Whops API til checkout-sessioner. Montér den med items, en enkelt plan eller en checkoutConfiguration, du har oprettet, og elementet åbner selv checkout-sessionen; sessionens legitimationsoplysninger forlader aldrig elementet. En checkout-konfiguration i setup-tilstand monterer det samme element som en lagring af betalingsmetode: intet opkræves, køberens metode gemmes, så du kan opkræve den senere, og den gennemførte checkout omdirigerer med setup_intent_id. Køberen betaler inde i elementet, og en gennemført checkout omdirigerer den aktuelle fane til returnUrl, inklusive den side, der indeholder elementet. Lever ud fra webhooks i stedet for en browser-callback. Uden en returnUrl bliver køberen på elementets egen succesvisning. Elementet driver automatisk et eksternt betalingstrin, såsom 3DS eller en bankside. På whop.com bringer det køberen tilbage til den gendannede checkout; i en indlejring vender køberen tilbage til den samme returnUrl uanset udfaldet, med query-parametrene payment og status (succeeded, failed eller canceled), så siden på returnUrl skal læse status, før den behandler besøget som et salg. En betaling, der fejler inde i elementet, genåbner den samme checkout med årsagen vist, så køberen kan betale igen. Alle indstillinger angives ved oprettelsen: elementet udsteder en checkout-session ud fra disse værdier, når det monteres. Ændres en af dem senere med update() eller nye React-props, fejler det i stedet for at ændre den eksisterende ordre. Montér en ny checkout for at ændre, hvad der købes.
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.
Playground
Sæt elementerne sammen med eksempeldata. Betjen kontrollerne, tilføj og arrangér elementer, og se events blive udløst live:
import { WhopElements, Checkout } from "@whop/elements-react";import { loadWhop } from "@whop/elements";function Example() { return ( <WhopElements elements={loadWhop()}> <Checkout /* options */> {/* mount elements here */} </Checkout> </WhopElements> );}
Angiv disse til whop.checkout.create({ … }) eller som props på <Checkout> i React.
string
Eksisterende plan-ID med præfikset plan_. Genvej til et items-array, der indeholder denne plan og quantity. Planen definerer prisen; intet om beløb kan fastsættes på klientsiden. Angiv enten plan, items eller en checkoutConfiguration. Angives kun ved oprettelse: sessionen udstedes ud fra den, og en senere ændring afvises.
number
Hvor mange enheder der skal købes. Planer, der ikke tillader flere, afviser værdier over 1. Angives kun ved oprettelse: sessionen udstedes med den, og en senere ændring afvises. @default 1
CheckoutItemInput[]
Planerne i denne checkout og hvor mange enheder af hver, der skal købes. Alle varer skal tilhøre den samme sælger og bruge kompatible faktureringsvilkår; API’et validerer hele kurven og prissætter den som én opkrævning. Angiv dette i stedet for plan, quantity eller checkoutConfiguration. Angives kun ved oprettelse: sessionen udstedes ud fra præcis denne kurv, og en senere ændring afvises.
Vis egenskaber
string
påkrævet
Eksisterende plan-ID med præfikset plan_.
number
Antal enheder, der skal købes. Standard er 1; planer kan forbyde antal over 1.
string
Eksisterende checkout-konfigurations-ID med præfikset ch_. Elementet opretter checkout-sessionen ud fra den: konfigurationen angiver den plan, der sælges (eller, i setup-tilstand, ingen plan — checkouten gemmer en betalingsmetode og opkræver intet), og forudfylder sin egen affiliate-kode, metadata, omdirigering og forudindstillinger for betalingsmetoder — en indstilling, der angives her ved siden af den, vinder over konfigurationens kopi, felt for felt. Angiv kun plan sammen med den for at sætte quantity; det skal være konfigurationens egen plan, som aldrig kan skiftes ud under dens forudindstillinger. Angives kun ved oprettelse.
string
En rabatkode, der anvendes, før køberen overhovedet ser prisen — rabatten er med i det første prisoverslag, og køberen kan stadig ændre eller fjerne den. Angiv den kode, et markedsføringslink indeholdt: en kode, der er udløbet eller aldrig var gyldig, åbner checkouten til fuld pris med årsagen i rabatrækken, aldrig en checkout, der ikke vil åbne. Angives kun ved oprettelse.
string
Den affiliate, som denne checkout tilskrives. Angives kun ved oprettelse.
CheckoutAttributionInput
Hvor dette salg kom fra, til kontoens rapportering: kampagneparametrene fra det link, køberen ankom via (utmSource, utmMedium, utmCampaign, utmTerm, utmContent, enhver anden utm_*-parameter under utm, et Whop-trackingLinkId, et funnelId og din egen source). Alt her registreres på ordren og vises aldrig for køberen. Angives kun ved oprettelse.
Vis egenskaber
string
string
string
string
string
string
string
string
Record<string, string>
Enhver anden utm_*-parameter, linket indeholdt, med det fulde navn som nøgle ({ utm_funnel: 'spring' }). Nøgler, der ikke starter med utm_, ignoreres, og de navngivne felter ovenfor vinder over den samme nøgle her.
Record<string, string>
Dine egne nøgle/værdi-par, der registreres på ordren og kan læses tilbage på betalingen — ordre-ID’er, kurv-ID’er eller hvad du ellers afstemmer mod. Op til 40 strengpar. Angives kun ved oprettelse.
string
Hvor køberen lander efter et eksternt betalingstrin, uanset udfaldet. Fanen ankommer med payment (pay_-ID’et; setup med sint_-ID’et for en checkout i setup-tilstand) og status (succeeded, failed eller canceled) tilføjet, og dine andre query-parametre intakte. Forgren på status, før du viser en successide: et afvist eller afbrudt eksternt trin lander også her. Lever ud fra webhooks, ikke ud fra dette besøg. Kun https (http for localhost). Angives kun ved oprettelse.
Appearance
Visuel tilpasning af denne gruppes elementer. Tilsidesætter den globale WhopElements({ appearance }). Ændr den live med update({ appearance }).
WhopElementsLocale
Sprog for UI-teksten i denne gruppes elementer. Sæt den til et af appens indbyggede sprog for at tilsidesætte den globale konfiguration. Enhver anden værdi falder tilbage til standardsproget.
Events
Angiv callbacks i create-indstillingerne eller som React-props.
onComplete
Udløses én gang pr. montering, når checkouten gennemføres, og resultatet står fast. result angiver, hvad der står fast: payment (køberen betalte — paymentId), waitlist_entry (køberen kom på en venteliste — entryId) eller setup (en checkout i setup-tilstand gemte betalingsmetoden — setupIntentId); sessionId er checkout-sessionen i alle tilfælde. Udløses før enhver returnUrl-navigation, så det er her, dine egne analyser eller annoncepixels registrerer købet. Lever ud fra webhooks, ikke ud fra denne callback: en checkout, der gendannes ved en senere sideindlæsning, udløser den igen for det samme resultat.
Betalingen med præfikset pay_ — det id, købet skal registreres under.
Skjul CheckoutWaitlistCompletion
string
påkrævet
Checkout-sessionen med præfikset chs_.
"waitlist_entry"
påkrævet
string
påkrævet
Ventelisteposten med præfikset ent_.
Skjul CheckoutSetupCompletion
string
påkrævet
Checkout-sessionen med præfikset chs_.
"setup"
påkrævet
string
påkrævet
Den gemte setup med præfikset sint_.
onLoadingChange
Kører, når den samlede indlæsningstilstand ændres. Værdien er true, så længe et monteret element stadig indlæses.
boolean
Metoder
Kald disse på Checkout-handlet fra whop.checkout.create({ … }) eller useCheckout().
update
Fletter nye handle-indstillinger ind i alle monterede elementer. I React ændrer du i stedet namespace-props.Parametre
Partial<CheckoutOptions>
påkrævet
destroy
Ødelægger alle elementer og sub-controllere, som dette handle har oprettet, fjerner controller-framen og frigiver dens abonnementer. Du kan kalde den mere end én gang, men et ødelagt handle afviser alle andre kald — opret et nyt handle for at starte forfra. React fjerner gruppen automatisk, når provideren afmonteres.
Ressourcer
Opret disse SDK-objekter uden at montere et element. Hvert objekt har sin egen side:
CheckoutSession
Lavniveau, headless checkout-session til en side, der tegner sin egen PayPal-knap. load() opretter checkout-sessionen ud fra lineItems; show("paypal", { termsAccepted: true }) sender køberen til PayPal — et pop op-vindue på desktop, hele fanen på telefoner — og resolver med betalingen, når køberen godkender. Med paymentMethodOptions.paypal.requestShipping beder PayPal køberen om en leveringsadresse, og kontoens webhook, der abonnerer på shipping_address.changed, prissætter hver adresse på din server, mens køberen er på PayPal; betalingen oprettes først, når køberen godkender, til den pris. Efter en helsidesomdirigering bliver promiset aldrig afgjort; aflæs i stedet udfaldet fra query-parametrene payment og status på redirectUrl.
Elementer
De elementer, som denne gruppe monterer. Hvert element har sin egen side:Alternativer. Montér ét ad gangen. Ødelæg det, før du monterer et andet:
CheckoutElement
Hele checkout-fladen — ordreoversigt med det aktuelle prisoverslag, indtastning af rabatkode, den valuta, køberen betaler i, alt det, denne checkout skal indsamle fra køberen, den sammensatte flade med betalingsmetoder og betalingsforløbet. Det, den indsamler, er det, sælgeren har sat op (e-mail, sælgerens egne spørgsmål, et telefonnummer, en leveringsadresse til fysiske varer, en udtrykkelig accept af sælgerens vilkår), renderet samlet på én skærm i den rækkefølge, sælgeren har valgt — så en sælger, der begynder at bede om noget nyt, kræver ingen ændring her. Renderer hele købet; checkout-controlleren ejer sessionen og legitimationsoplysningerne. Efter en betaling, der kræver et eksternt trin, renderer den samme flade det udfald, serveren rapporterer, når køberen vender tilbage.
ExpressCheckoutElement
Apple Pay-, Google Pay- og PayPal-knapper med ét tryk til en checkout — wallet’en indsamler det, sessionen stadig mangler (køberens e-mail, en leveringsadresse til fysiske varer, et telefonnummer, hvor sælgeren indsamler et, i Apple Pay og Google Pay, og i Apple Pay en rabatkode, hvor sælgeren tilbyder indtastning), og ét tryk gennemfører købet. Den deler checkoutens indgangsplads med det fulde checkout-element, så et handle monterer præcis ét af de to: denne knap alene, hvor købet er enkelt nok til, at et sheet kan gennemføre det, eller hele checkout-fladen til alt andet. Renderer kun de wallets, køberens enhed faktisk kan betale med — og som checkoutens egen betalingsmetodekonfiguration tillader — med den leverede knapgrafik, og renderer intet, hvor ingen wallet er tilgængelig. PayPal vises, hvor sælgeren accepterer det, åbner i sit eget vindue og gemmer køberens PayPal-konto sammen med købet, så en fornyelse, en gratis prøveperiode og senere opkrævninger fra sælgeren fungerer som et gemt kort. Alle tre wallets kræver Apple Pay på sidens domæne: førstepartssider på whop.com er forhåndsgodkendt, og ethvert andet website skal tilføje Apple Pay til sit domæne via Domains API, før nogen af disse knapper renderes der. At tilbyde Google Pay på dit eget website er underlagt Google Pay API’s servicevilkår. En checkout, som sheetet ikke ærligt kan gennemføre — tilmelding til en venteliste, en overførsel, et formularspørgsmål, som kun en side kan stille — afviser tydeligt i stedet for at rendere en knap, der er dømt til at fejle.
Assistant
Responses are generated using AI and may contain mistakes.