Skip to main content
Gebruik de Products API om de openbare marketplace te doorzoeken, de producten van een account weer te geven, een product op te halen en producten aan te maken, bij te werken of te verwijderen.
Vervangt de Legacy-resource Products. Bestaande Legacy-integraties blijven werken; zie API-versies voor het stabiliteitscontract.

Endpoints

Attributen

string
vereist
Product-ID, met voorvoegsel prod_.
object | null
vereist
Account dat dit product verkoopt.
number
vereist
Gemiddelde sterrenbeoordeling over gepubliceerde reviews voor dit product, van 1.0 tot 5.0. Retourneert 0.0 als er geen beoordeling uit gepubliceerde reviews beschikbaar is.
string
vereist
Wanneer het product is aangemaakt, als ISO 8601-tijdstempel.
string | null
vereist
Label van de call-to-action-knop die op de aankooppagina van het product wordt getoond.Beschikbare opties: 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
vereist
URL waarnaar de call-to-action-knop linkt in plaats van naar de checkout.
string | null
vereist
Aangepast tekstlabel op het bankafschrift van de klant.
object | null
vereist
Koopbare variant om te tonen en mee af te rekenen. De ingestelde standaardvariant als die koopbaar is, anders de eerste koopbare variant in de volgorde van de productpagina. null als er geen koopbaar is.

Eigenschappen

string
vereist
Variant-ID, met prefix plan_.
number | null
vereist
Aantal dagen tussen terugkerende afschrijvingen, zoals 30 voor maandelijks of 365 voor jaarlijks. null voor eenmalige varianten.
string
vereist
Factureringsmodel voor deze variant: one_time of renewal.Beschikbare opties: renewal, one_time
number | null
vereist
Toegangsduur in dagen voor varianten met een vervaldatum. null voor varianten zonder vervaldatum.
object
vereist
Wat de checkout vooraf in rekening brengt. amount is "0.00" wanneer de eerste afschrijving gratis is, zoals bij een proefperiode.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
De terugkerende afschrijving elke billing_period dagen. amount is "0.00" voor eenmalige varianten.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Weergavenaam van de variant die aan klanten wordt getoond. null als er geen titel is ingesteld.
number | null
vereist
Dagen gratis proefperiode vóór de eerste verlengingsbetaling. null als er geen proefperiode is ingesteld of de ingelogde gebruiker al een proefperiode voor deze variant heeft gebruikt.
boolean
vereist
Of de variant een onbeperkte voorraad heeft.
string
vereist
Waar deze variant zichtbaar is. Varianten met visible verschijnen op de productpagina.Beschikbare opties: visible, hidden, archived, quick_link
string | null
vereist
Geschreven beschrijving die op de productpagina wordt getoond. null als er geen is ingesteld.
object[]
vereist
Experiences die het product bevat, zoals cursussen, chats en apps, oudste eerst. Bevat de eerste 100; blader door de rest via GET /experiences?product_id=.

Eigenschappen

string
vereist
Experience-ID, met prefix exp_.
object
vereist
App waarin de experience draait.

Eigenschappen

string
vereist
App-ID, met prefix app_.
object
vereist
App-icoon. Valt terug op het standaard app-icoon wanneer er geen is geüpload.

Eigenschappen

string
vereist
URL van de icoonafbeelding. Altijd aanwezig — het standaard app-icoon wanneer er geen is geüpload.
string
vereist
Weergavenaam van de app.
string | null
vereist
URL van de logo-afbeelding die voor deze experience is geüpload. null als er geen is; toon in plaats daarvan het icon van de app.
string
vereist
Weergavenaam van de experience.
string | null
vereist
Externe identificatie die bij het product is opgeslagen voor je eigen referentie.
Galerijafbeeldingen voor dit product, gesorteerd op positie.

Eigenschappen

string
vereist
Galerijafbeelding-ID.
string | null
vereist
MIME-type van het geüploade bestand, zoals image/jpeg.
string | null
vereist
Vooraf geoptimaliseerde URL om deze afbeelding op de client weer te geven.
number | null
vereist
Commissiepercentage dat affiliates verdienen via het globale affiliateprogramma.
string | null
vereist
Inschrijvingsstatus in het globale affiliateprogramma.Beschikbare opties: enabled, disabled
string | null
vereist
Korte marketingkop die op de productpagina wordt getoond.
string[]
vereist
Labels in kleine letters waarmee producten in collecties worden gegroepeerd. Filter het list-endpoint op labels om één collectie op te halen.
string | null
vereist
URL van de logo-afbeelding die op productpagina’s en in zoekresultaten wordt getoond. null als het product geen logo heeft.
string
vereist
Vermeldingsstatus op de whop.com-marketplace. pending_review betekent ingediend en wachtend op beoordeling; live_marketplace betekent goedgekeurd en vindbaar.Beschikbare opties: not_available, pending_review, live_marketplace
number | null
vereist
Commissiepercentage dat leden verdienen via het affiliateprogramma voor leden.
string | null
vereist
Inschrijvingsstatus in het affiliateprogramma voor leden.Beschikbare opties: enabled, disabled
number
vereist
Actieve lidmaatschappen voor dit product; 0 als openbare ledenaantallen zijn uitgeschakeld.
object | null
vereist
Aangepaste key-value-paren die bij het product zijn opgeslagen.
object | null
vereist
Gebruiker die eigenaar is van het account dat dit product verkoopt.
object | null
vereist
Belastingclassificatiecode voor dit product, of null als er geen belastingcode is ingesteld.
number
vereist
Gepubliceerde klantreviews voor dit product.
string
vereist
URL-slug voor de openbare link van het product.
string
vereist
Weergavenaam van het product die aan klanten wordt getoond.
string
vereist
Wanneer het product voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
object | null
vereist
De optieset die de varianten van het product omvatten, als map van attribuutnaam naar de gebruikte waarden, bijv. \{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Afgeleid van de zichtbare varianten die niet voor een factuur zijn en attributes hebben: sleutels alfabetisch, waarden in de volgorde waarin de varianten zijn aangemaakt. Alleen-lezen. null als het product geen varianten heeft.
object[] | null
vereist
De varianten van het product waarvan visibility gelijk is aan visible en die niet voor een factuur zijn gegenereerd, in volgorde van aanmaak. Gewone prijsopties worden opgenomen met attributes: null. Verborgen, gearchiveerde, quick-link- en factuurvarianten blijven bereikbaar via GET /variants. null als het product meer dan 1000 varianten heeft (blader erdoor via GET /variants?product_ids=) en in webhook-payloads.

Eigenschappen

string
vereist
Variant-ID, met prefix plan_.
object | null
vereist
Account dat deze variant verkoopt; null voor zelfstandige factuurvarianten.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string
vereist
Weergavenaam van het account.
boolean
vereist
Of adaptieve prijsstelling is ingeschakeld voor deze variant. Ruwe instelling — controleert geen compatibiliteit met de verwerker of feature flags.
boolean
vereist
Of er meer dan één eenheid in een bestelling kan worden gekocht. Verlengingsvarianten kunnen dit niet inschakelen. Wanneer false, weigeren checkouts, winkelwagens en facturen een hoeveelheid boven 1.
object | null
vereist
Attribuutwaarden die deze variant binnen het product onderscheiden, als een map van attribuutnaam naar waarde, bijv. \{"color": "Blue", "size": "Large"}. Namen zijn snake_case-identifiers en worden in alfabetische volgorde geretourneerd. Elke variant met attributen binnen een product heeft dezelfde attribuutnamen en een unieke set waarden; het product vermeldt de volledige set opties als variant_attributes. null wanneer de variant geen attributen heeft.
number | null
vereist
Aantal dagen tussen terugkerende afschrijvingen, zoals 30 voor maandelijks of 365 voor jaarlijks. null voor eenmalige varianten.
string
vereist
Factureringsmodel voor deze variant.Beschikbare opties: renewal, one_time
number | null
vereist
Hoe lang de annuleringskorting geldt: 0 voor altijd, 1 alleen voor de volgende betaling, of een aantal kalendermaanden vanaf het moment dat de klant deze accepteert. null wanneer er geen wordt aangeboden of de actor de scope plan:basic:read niet heeft.
number | null
vereist
Annuleringskorting als percentage in hele getallen. null wanneer er geen wordt aangeboden of de actor de scope plan:basic:read niet heeft.
object | null
vereist
Checkoutstyling op variantniveau (background_color, button_color, font_family, border_style); null neemt de standaard van het account over.
string
vereist
Wanneer de variant is aangemaakt, als ISO 8601-tijdstempel.
string
vereist
Driecijferige ISO 4217-code van de valuta waarin elke prijs op deze variant is uitgedrukt, in kleine letters: de eigen valuta van de variant, of de presentment_currency waarom bij het lezen is gevraagd wanneer de variant daarnaar kan worden omgerekend.
object[]
vereist
Aangepaste invoervelden die op het checkoutformulier worden verzameld.

Eigenschappen

string
vereist
ID van het aangepaste veld, met prefix field_.
string
vereist
Invoertype van het aangepaste veld.Beschikbare opties: text
string
vereist
Veldlabel dat bij de checkout aan de klant wordt getoond.
number
vereist
Positie van het veld op het checkoutformulier.
string | null
vereist
Placeholdertekst die in het lege veld wordt getoond. null als er geen is ingesteld.
boolean
vereist
Of de klant dit veld moet invullen om af te rekenen.
string | null
vereist
Voor de klant zichtbare variantbeschrijving. Maximaal 1000 tekens. null als er geen beschrijving is ingesteld.
number | null
vereist
Toegangsduur in dagen voor varianten met een vervaldatum, zoals 365 voor een jaarpas. null voor varianten zonder vervaldatum.
string
vereist
Leesbare prijs voor weergave (valuta + interval) in currency, bijv. “$10 / month”.
object | null
vereist
Afbeelding van de prijslaag (url, blurhash) die op de productpagina wordt getoond; null wanneer er geen afbeelding is ingesteld.
number
vereist
Initiële aankoopprijs, in currency.
object
vereist
Totaal dat bij de checkout voor één eenheid in rekening wordt gebracht, vóór promotiecodes en belasting: initial_price plus de eerste renewal_price voor terugkerende varianten, of alleen initial_price zolang er een gratis proefperiode geldt. De proefperiode geldt niet wanneer de bekijkende gebruiker er al een voor deze variant heeft gebruikt. Uitgedrukt in currency.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Privénotities die niet aan klanten worden getoond. null tenzij de actor de scope plan:basic:read heeft op het account van de variant.
object | null
vereist
Factuur waarvoor deze variant is gegenereerd; null tenzij aangemaakt voor een factuur.
number | null
vereist
Actieve memberships via deze variant. null tenzij de actor de scope plan:basic:read heeft op het account van de variant.
object | null
vereist
Aangepaste sleutel-waardeparen die op de variant zijn opgeslagen. Opgenomen in webhook-payloads voor betalings- en membership-events. Maximaal 50 sleutels, 100 tekens per sleutel, 500 tekens per waarde. De gereserveerde sleutels custom_cta en custom_cta_url overschrijven, wanneer ingesteld, de checkout-call-to-action van het product voor deze variant.
boolean | null
vereist
Of er een annuleringskorting wordt aangeboden. null tenzij de actor de scope plan:basic:read heeft op het account van de variant.
object | null
vereist
Configuratie van betaalmethoden (enabled, disabled, include_platform_defaults); null wanneer de variant standaardinstellingen gebruikt.
object | null
vereist
Product waartoe deze variant behoort; null voor zelfstandige varianten.
string
vereist
URL waar klanten deze variant direct kunnen kopen.
string | null
vereist
Waar de klant naartoe wordt gestuurd na betaling voor deze variant. null wanneer er niets is ingesteld, of tenzij de actor de scope plan:basic:read heeft op het account van de variant.
string
vereist
Verkoopmethode voor deze variant.Beschikbare opties: buy_now, waitlist
number
vereist
Terugkerende prijs die elke factureringsperiode in rekening wordt gebracht, in currency.
string | null
vereist
Stock keeping unit, vrije tekst ingesteld door de verkoper (bijv. TSHIRT-LARGE-BLUE). Uniciteit wordt niet afgedwongen. null wanneer niet ingesteld.
number | null
vereist
Termijnbetalingen die vereist zijn voordat het abonnement wordt gepauzeerd. Moet groter zijn dan 1. null als gespreid betalen niet is geconfigureerd.
number | null
vereist
Eenheden beschikbaar voor aankoop. null tenzij de actor de scope plan:basic:read heeft op het account van de variant.
number | null
vereist
Oorspronkelijke initiële prijs, doorgestreept weergegeven, in currency. null wanneer er geen doorgestreepte prijs is ingesteld.
number | null
vereist
Oorspronkelijke verlengingsprijs, doorgestreept weergegeven, in currency. null wanneer er geen doorgestreepte prijs is ingesteld.
string | null
vereist
3D Secure-gedrag voor ondersteunde on-session kaartbetalingen. mandate_challenge vereist een 3DS-challenge vóór de verwerking van de betaling; mandate_if_required verplicht een challenge alleen wanneer de betalingsverwerker dat vereist; frictionless_if_required gebruikt de gewone frictionless 3DS-flow. Betalingen van $1,000 of meer gebruiken mandate_if_required, tenzij mandate_challenge is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. null neemt de standaardinstelling van het account over.Beschikbare opties: mandate_challenge, mandate_if_required, frictionless_if_required
string | null
vereist
Weergavenaam van de variant die aan klanten wordt getoond. Maximaal 30 tekens. Een variant die zonder naam is aangemaakt, krijgt standaard de attribuutwaarden samengevoegd met /. null als er geen titel is ingesteld.
number | null
vereist
Dagen gratis proefperiode vóór de eerste verlengingsafschrijving. null als er geen proefperiode is geconfigureerd of de gebruiker al een proefperiode voor deze variant heeft gebruikt.
boolean
vereist
Of de variant onbeperkte voorraad heeft. Wanneer true, wordt het veld stock genegeerd; wachtlijstvarianten rapporteren altijd true.
string
vereist
Wanneer de variant voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
string
vereist
Bepaalt waar deze variant zichtbaar is. Wanneer hidden, is de variant alleen bereikbaar via de directe link.Beschikbare opties: visible, hidden, archived, quick_link
boolean
vereist
Of het product door Whop is geverifieerd.
string | null
vereist
Of het product openbaar zichtbaar, verborgen of gearchiveerd is.
Product