Skip to main content
Brug Products API’et til at søge på den offentlige markedsplads, vise en kontos produkter, hente et produkt og oprette, opdatere eller slette produkter.
Erstatter Legacy-ressourcen Products. Eksisterende Legacy-integrationer fortsætter med at virke; se API-versioner for stabilitetsaftalen.

Endpoints

Attributter

string
påkrævet
Produkt-id med præfikset prod_.
object | null
påkrævet
Den konto, der sælger dette produkt.
number
påkrævet
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.
string
påkrævet
Hvornår produktet blev oprettet, som et ISO 8601-tidsstempel.
string | null
påkrævet
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_order
string | null
påkrævet
Den URL, som call-to-action-knappen linker til i stedet for checkout.
string | null
påkrævet
Brugerdefineret tekstetiket på kundens kontoudtog.
object | null
påkrævet
Kø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

string
påkrævet
Variant-id med præfikset plan_.
number | null
påkrævet
Antal dage mellem tilbagevendende opkrævninger, f.eks. 30 for månedlig eller 365 for årlig. null for engangsvarianter.
string
påkrævet
Faktureringsmodel for denne variant: one_time eller renewal.Tilgængelige muligheder: renewal, one_time
number | null
påkrævet
Adgangsvarighed i dage for udløbsbaserede varianter. null for varianter uden udløb.
object
påkrævet
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

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen lokalitet ved hjælp af dette.
object
påkrævet
Den tilbagevendende opkrævning hver billing_period dage. amount er "0.00" for engangsvarianter.

Egenskaber

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen lokalitet ved hjælp af dette.
string | null
påkrævet
Variantens visningsnavn, som vises for kunder. null, hvis der ikke er angivet en titel.
number | null
påkrævet
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.
boolean
påkrævet
Om varianten har ubegrænset lager.
string
påkrævet
Hvor denne variant kan ses. visible-varianter vises på produktsiden.Tilgængelige muligheder: visible, hidden, archived, quick_link
string | null
påkrævet
Skriftlig beskrivelse, der vises på produktsiden. null, hvis der ikke er angivet nogen.
object[]
påkrævet
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

string
påkrævet
Experience-id med præfikset exp_.
object
påkrævet
Den app, som experiencen kører i.

Egenskaber

string
påkrævet
App-id med præfikset app_.
object
påkrævet
App-ikon. Falder tilbage til standard-app-ikonet, når der ikke er uploadet noget.

Egenskaber

string
påkrævet
URL til ikonbillede. Altid til stede — standard-app-ikonet, når der ikke er uploadet noget.
string
påkrævet
Appens visningsnavn.
string | null
påkrævet
URL til logobillede uploadet for denne experience. null, når der ikke er noget; vis i stedet appens icon.
string
påkrævet
Experiencens visningsnavn.
string | null
påkrævet
Ekstern identifikator gemt på produktet til din egen reference.
Galleribilleder for dette produkt, sorteret efter position.

Egenskaber

string
påkrævet
Galleribilledets id.
string | null
påkrævet
Den uploadede fils MIME-type, f.eks. image/jpeg.
string | null
påkrævet
Præoptimeret URL til visning af dette billede på klienten.
number | null
påkrævet
Den kommissionssats, som affiliates tjener gennem det globale affiliateprogram.
string | null
påkrævet
Tilmeldingsstatus i det globale affiliateprogram.Tilgængelige muligheder: enabled, disabled
string | null
påkrævet
Kort markedsføringsoverskrift, der vises på produktsiden.
string[]
påkrævet
Etiketter med små bogstaver, der bruges til at gruppere produkter i samlinger. Filtrér list-endpointet efter labels for at hente én samling.
string | null
påkrævet
URL til logobillede, der vises på produktsider og i søgeresultater. null, når produktet ikke har noget logo.
string
påkrævet
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_marketplace
number | null
påkrævet
Den kommissionssats, som medlemmer tjener gennem medlemsaffiliateprogrammet.
string | null
påkrævet
Tilmeldingsstatus i medlemsaffiliateprogrammet.Tilgængelige muligheder: enabled, disabled
number
påkrævet
Aktive medlemskaber for dette produkt; 0, hvis offentlige medlemstal er deaktiveret.
object | null
påkrævet
Brugerdefinerede nøgle-værdi-par gemt på produktet.
object | null
påkrævet
Den bruger, der ejer kontoen, som sælger dette produkt.
object | null
påkrævet
Skatteklassificeringskode for dette produkt, eller null, hvis der ikke er angivet nogen skattekode.
number
påkrævet
Offentliggjorte kundeanmeldelser for dette produkt.
string
påkrævet
URL-slug for produktets offentlige link.
string
påkrævet
Produktets visningsnavn, som vises for kunder.
string
påkrævet
Hvornår produktet sidst blev opdateret, som et ISO 8601-tidsstempel.
object | null
påkrævet
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.
object[] | null
påkrævet
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

string
påkrævet
Variant-id med præfikset plan_.
object | null
påkrævet
Den konto, der sælger denne variant; null for selvstændige fakturavarianter.

Egenskaber

string
påkrævet
Konto-id med præfikset biz_.
string
påkrævet
Kontoens visningsnavn.
boolean
påkrævet
Om adaptiv prissætning er aktiveret for denne variant. Rå indstilling — kontrollerer ikke processorkompatibilitet eller feature flags.
boolean
påkrævet
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.
object | null
påkrævet
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.
number | null
påkrævet
Antal dage mellem tilbagevendende opkrævninger, f.eks. 30 for månedlig eller 365 for årlig. null for engangsvarianter.
string
påkrævet
Faktureringsmodel for denne variant.Tilgængelige muligheder: renewal, one_time
number | null
påkrævet
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.
number | null
påkrævet
Annulleringsrabat som en procentdel i hele tal. null, når der ikke tilbydes nogen, eller aktøren mangler scopet plan:basic:read.
object | null
påkrævet
Checkout-styling på variantniveau (background_color, button_color, font_family, border_style); null arver kontoens standard.
string
påkrævet
Hvornår varianten blev oprettet, som et ISO 8601-tidsstempel.
string
påkrævet
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.
object[]
påkrævet
Brugerdefinerede inputfelter, der indsamles på checkout-formularen.

Egenskaber

string
påkrævet
Id for brugerdefineret felt med præfikset field_.
string
påkrævet
Inputtype for brugerdefineret felt.Tilgængelige muligheder: text
string
påkrævet
Feltetiket, der vises for kunden i checkout.
number
påkrævet
Feltets position på checkout-formularen.
string | null
påkrævet
Pladsholdertekst, der vises i det tomme felt. null, hvis der ikke er angivet nogen.
boolean
påkrævet
Om kunden skal udfylde dette felt for at gennemføre checkout.
string | null
påkrævet
Variantbeskrivelse, der er synlig for kunder. Maksimalt 1000 tegn. null, hvis der ikke er angivet nogen beskrivelse.
number | null
påkrævet
Adgangsvarighed i dage for udløbsbaserede varianter, f.eks. 365 for et etårigt pas. null for varianter uden udløb.
string
påkrævet
Menneskelæsbar pris til visning (valuta + interval) i currency, f.eks. “$10 / month”.
object | null
påkrævet
Billede for prisniveau (url, blurhash), der vises på produktsiden; null, når der ikke er angivet noget billede.
number
påkrævet
Indledende købspris i currency.
object
påkrævet
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

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen lokalitet ved hjælp af dette.
string | null
påkrævet
Private noter, der ikke vises for kunder. null, medmindre aktøren har scopet plan:basic:read på variantens konto.
object | null
påkrævet
Den faktura, som denne variant blev genereret til; null, medmindre den er oprettet til en faktura.
number | null
påkrævet
Aktive medlemskaber via denne variant. null, medmindre aktøren har scopet plan:basic:read på variantens konto.
object | null
påkrævet
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.
boolean | null
påkrævet
Om der tilbydes en annulleringsrabat. null, medmindre aktøren har scopet plan:basic:read på variantens konto.
object | null
påkrævet
Konfiguration af betalingsmetoder (enabled, disabled, include_platform_defaults); null, når varianten bruger standardindstillinger.
object | null
påkrævet
Det produkt, som denne variant tilhører; null for selvstændige varianter.
string
påkrævet
URL, hvor kunder kan købe denne variant direkte.
string | null
påkrævet
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.
string
påkrævet
Salgsmetode for denne variant.Tilgængelige muligheder: buy_now, waitlist
number
påkrævet
Tilbagevendende pris, der opkræves hver faktureringsperiode, i currency.
string | null
påkrævet
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.
number | null
påkrævet
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.
number | null
påkrævet
Enheder tilgængelige for køb. null, medmindre aktøren har scopet plan:basic:read på variantens konto.
number | null
påkrævet
Oprindelig startpris vist med gennemstregning, i currency. null, når der ikke er angivet nogen gennemstregning.
number | null
påkrævet
Oprindelig fornyelsespris vist med gennemstregning, i currency. null, når der ikke er angivet nogen gennemstregning.
string | null
påkrævet
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_required
string | null
påkrævet
Variantens 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.
number | null
påkrævet
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.
boolean
påkrævet
Om varianten har ubegrænset lager. Når true, ignoreres feltet stock; venteliste-varianter rapporterer altid true.
string
påkrævet
Hvornår varianten sidst blev opdateret, som et ISO 8601-tidsstempel.
string
påkrævet
Styrer, hvor denne variant kan ses. Når hidden, kan varianten kun nås via sit direkte link.Tilgængelige muligheder: visible, hidden, archived, quick_link
boolean
påkrævet
Om produktet er blevet verificeret af Whop.
string | null
påkrævet
Om produktet er offentligt synligt, skjult eller arkiveret.
Product