Erstatter Legacy-ressourcen Products. Eksisterende Legacy-integrationer fortsætter med at virke; se API-versioner for stabilitetsaftalen.
Endpoints
Attributter
Gennemsnitlig stjernebedømmelse på tværs af offentliggjorte anmeldelser for dette produkt, fra
1.0 til 5.0. Returnerer 0.0, når der ikke er nogen bedømmelse fra offentliggjorte anmeldelser.Etiket på call-to-action-knappen, der vises på produktets købsside.Tilgængelige muligheder:
get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_orderKøbbar variant, der skal vises og bruges til checkout. Den konfigurerede standard, når den variant er købbar, ellers den første købbare variant i produktsidens rækkefølge.
null, når ingen er købbar.Egenskaber
Egenskaber
Antal dage mellem tilbagevendende opkrævninger, f.eks. 30 for månedlig eller 365 for årlig.
null for engangsvarianter.Faktureringsmodel for denne variant:
one_time eller renewal.Tilgængelige muligheder: renewal, one_timeAdgangsvarighed i dage for udløbsbaserede varianter.
null for varianter uden udløb.Hvad checkout opkræver på forhånd.
amount er "0.00", når den første opkrævning er gratis, f.eks. en prøveperiode.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den tilbagevendende opkrævning hver
billing_period dage. amount er "0.00" for engangsvarianter.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Variantens visningsnavn, som vises for kunder.
null, hvis der ikke er angivet en titel.Gratis prøvedage før den første fornyelsesopkrævning.
null, hvis der ikke er konfigureret en prøveperiode, eller den indloggede bruger allerede har brugt en prøveperiode på denne variant.Skriftlig beskrivelse, der vises på produktsiden.
null, hvis der ikke er angivet nogen.Experiences, som produktet indeholder, f.eks. kurser, chats og apps, ældste først. Indeholder de første 100; bladr gennem resten via
GET /experiences?product_id=.Egenskaber
Egenskaber
Den app, som experiencen kører i.
URL til logobillede uploadet for denne experience.
null, når der ikke er noget; vis i stedet appens icon.Den kommissionssats, som affiliates tjener gennem det globale affiliateprogram.
Tilmeldingsstatus i det globale affiliateprogram.Tilgængelige muligheder:
enabled, disabledEtiketter med små bogstaver, der bruges til at gruppere produkter i samlinger. Filtrér list-endpointet efter
labels for at hente én samling.URL til logobillede, der vises på produktsider og i søgeresultater.
null, når produktet ikke har noget logo.Listningsstatus på whop.com-markedspladsen.
pending_review betyder indsendt og afventer gennemgang; live_marketplace betyder godkendt og synlig.Tilgængelige muligheder: not_available, pending_review, live_marketplaceTilmeldingsstatus i medlemsaffiliateprogrammet.Tilgængelige muligheder:
enabled, disabledSkatteklassificeringskode for dette produkt, eller
null, hvis der ikke er angivet nogen skattekode.Det sæt af muligheder, som produktets varianter spænder over, som et kort fra attributnavn til de værdier, der er i brug, f.eks.
\{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Udledt fra de synlige varianter, der ikke er fakturavarianter, og som har attributes: nøgler i alfabetisk rækkefølge, værdier i den rækkefølge, varianterne blev oprettet. Skrivebeskyttet. null, når produktet ikke har nogen varianter.Produktets varianter, hvis
visibility er visible, og som ikke blev genereret til en faktura, i oprettelsesrækkefølge. Almindelige prismuligheder er inkluderet med attributes: null. Skjulte, arkiverede, quick-link- og fakturavarianter kan stadig nås via GET /variants. null, når produktet har mere end 1000 varianter (bladr gennem dem via GET /variants?product_ids=) og i webhook-payloads.Egenskaber
Egenskaber
Om adaptiv prissætning er aktiveret for denne variant. Rå indstilling — kontrollerer ikke processorkompatibilitet eller feature flags.
Om mere end én enhed kan købes i en ordre. Fornyelsesvarianter kan ikke aktivere det. Når
false, afviser checkouts, kurve og fakturaer et antal over 1.Attributværdier, der adskiller denne variant inden for dens produkt, som et kort fra attributnavn til værdi, f.eks.
\{"color": "Blue", "size": "Large"}. Navne er snake_case-identifikatorer og returneres i alfabetisk rækkefølge. Hver variant med attributter på et produkt har de samme attributnavne og et unikt sæt værdier; produktet viser det fulde sæt af muligheder som variant_attributes. null, når varianten ikke har nogen attributter.Antal dage mellem tilbagevendende opkrævninger, f.eks. 30 for månedlig eller 365 for årlig.
null for engangsvarianter.Hvor længe annulleringsrabatten varer:
0 for altid, 1 kun den næste betaling eller et antal kalendermåneder fra det tidspunkt, kunden accepterer den. null, når der ikke tilbydes nogen, eller aktøren mangler scopet plan:basic:read.Annulleringsrabat som en procentdel i hele tal.
null, når der ikke tilbydes nogen, eller aktøren mangler scopet plan:basic:read.Checkout-styling på variantniveau (
background_color, button_color, font_family, border_style); null arver kontoens standard.Trebogstavs ISO 4217-kode med små bogstaver for den valuta, som alle priser på denne variant er angivet i: variantens egen valuta eller den
presentment_currency, som læsningen bad om, når varianten kan omregnes til den.Brugerdefinerede inputfelter, der indsamles på checkout-formularen.
Egenskaber
Egenskaber
Pladsholdertekst, der vises i det tomme felt.
null, hvis der ikke er angivet nogen.Variantbeskrivelse, der er synlig for kunder. Maksimalt 1000 tegn.
null, hvis der ikke er angivet nogen beskrivelse.Adgangsvarighed i dage for udløbsbaserede varianter, f.eks. 365 for et etårigt pas.
null for varianter uden udløb.Billede for prisniveau (
url, blurhash), der vises på produktsiden; null, når der ikke er angivet noget billede.Samlet beløb opkrævet i checkout for én enhed, før rabatkoder og moms:
initial_price plus den første renewal_price for tilbagevendende varianter, eller initial_price alene, mens en gratis prøveperiode gælder. Prøveperioden gælder ikke, når den visende bruger allerede har brugt en for denne variant. Angivet i currency.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Private noter, der ikke vises for kunder.
null, medmindre aktøren har scopet plan:basic:read på variantens konto.Den faktura, som denne variant blev genereret til;
null, medmindre den er oprettet til en faktura.Aktive medlemskaber via denne variant.
null, medmindre aktøren har scopet plan:basic:read på variantens konto.Brugerdefinerede nøgle-værdi-par gemt på varianten. Inkluderet i webhook-payloads for betalings- og medlemskabshændelser. Maksimalt 50 nøgler, 100 tegn pr. nøgle, 500 tegn pr. værdi. De reserverede nøgler
custom_cta og custom_cta_url tilsidesætter, når de er angivet, produktets checkout-call-to-action for denne variant.Om der tilbydes en annulleringsrabat.
null, medmindre aktøren har scopet plan:basic:read på variantens konto.Konfiguration af betalingsmetoder (
enabled, disabled, include_platform_defaults); null, når varianten bruger standardindstillinger.Hvor kunden sendes hen efter at have betalt for denne variant.
null, når der ikke er angivet noget, eller medmindre aktøren har scopet plan:basic:read på variantens konto.Lagerenhed (SKU), fri tekst angivet af sælgeren (f.eks.
TSHIRT-LARGE-BLUE). Håndhæves ikke som unik. null, når den ikke er angivet.Antal afdragsbetalinger, der kræves, før abonnementet sættes på pause. Skal være større end 1.
null, hvis split pay ikke er konfigureret.Enheder tilgængelige for køb.
null, medmindre aktøren har scopet plan:basic:read på variantens konto.Oprindelig startpris vist med gennemstregning, i
currency. null, når der ikke er angivet nogen gennemstregning.Oprindelig fornyelsespris vist med gennemstregning, i
currency. null, når der ikke er angivet nogen gennemstregning.3D Secure-adfærd for understøttede on-session-kortbetalinger.
mandate_challenge kræver en 3DS-challenge før betalingsbehandling; mandate_if_required kræver kun en challenge, når betalingsprocessoren kræver det; frictionless_if_required bruger det almindelige friktionsfri 3DS-flow. Betalinger på $1.000 eller mere bruger mandate_if_required, medmindre mandate_challenge er valgt. Krav til risiko og godkendelsesgendannelse kan tilsidesætte præferencen. null arver kontoens standard.Tilgængelige muligheder: mandate_challenge, mandate_if_required, frictionless_if_requiredVariantens visningsnavn, som vises for kunder. Maksimalt 30 tegn. En variant oprettet uden et navn får som standard sine attributværdier sammensat med
/. null, hvis der ikke er angivet en titel.Gratis prøvedage før den første fornyelsesopkrævning.
null, hvis der ikke er konfigureret en prøveperiode, eller brugeren allerede har brugt en prøveperiode for denne variant.Om varianten har ubegrænset lager. Når
true, ignoreres feltet stock; venteliste-varianter rapporterer altid true.Product

