Vervangt de Legacy-resource Products.
Bestaande Legacy-integraties blijven werken; zie API-versies
voor het stabiliteitscontract.
Endpoints
Attributen
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.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_orderKoopbare 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
Eigenschappen
Aantal dagen tussen terugkerende afschrijvingen, zoals 30 voor maandelijks of 365 voor jaarlijks.
null voor eenmalige varianten.Factureringsmodel voor deze variant:
one_time of renewal.Beschikbare opties: renewal, one_timeToegangsduur in dagen voor varianten met een vervaldatum.
null voor varianten
zonder vervaldatum.Wat de checkout vooraf in rekening brengt.
amount is "0.00" wanneer de eerste afschrijving gratis is, zoals bij een proefperiode.Eigenschappen
Eigenschappen
Het bedrag in hoofdeenheden, als exacte decimale string.
"10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
De terugkerende afschrijving elke
billing_period dagen. amount is "0.00" voor eenmalige varianten.Eigenschappen
Eigenschappen
Het bedrag in hoofdeenheden, als exacte decimale string.
"10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
Weergavenaam van de variant die aan klanten wordt getoond.
null als er geen titel is ingesteld.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.Geschreven beschrijving die op de productpagina wordt getoond.
null als er geen is ingesteld.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
Eigenschappen
App waarin de experience draait.
Eigenschappen
Eigenschappen
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.Externe identificatie die bij het product is opgeslagen voor je eigen referentie.
Commissiepercentage dat affiliates verdienen via het globale affiliateprogramma.
Inschrijvingsstatus in het globale affiliateprogramma.Beschikbare opties:
enabled, disabledLabels in kleine letters waarmee producten in collecties worden gegroepeerd.
Filter het list-endpoint op
labels om één collectie op te halen.URL van de logo-afbeelding die op productpagina’s en in zoekresultaten wordt
getoond.
null als het product geen logo heeft.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_marketplaceInschrijvingsstatus in het affiliateprogramma voor leden.Beschikbare opties:
enabled, disabledActieve lidmaatschappen voor dit product; 0 als openbare ledenaantallen zijn uitgeschakeld.
Belastingclassificatiecode voor dit product, of
null als er geen belastingcode is ingesteld.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.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
Eigenschappen
Of adaptieve prijsstelling is ingeschakeld voor deze variant. Ruwe instelling — controleert geen compatibiliteit met de verwerker of feature flags.
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.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.Aantal dagen tussen terugkerende afschrijvingen, zoals 30 voor maandelijks of 365 voor jaarlijks.
null voor eenmalige varianten.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.Annuleringskorting als percentage in hele getallen.
null wanneer er geen wordt aangeboden of de actor de scope plan:basic:read niet heeft.Checkoutstyling op variantniveau (
background_color, button_color, font_family, border_style); null neemt de standaard van het account over.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.Aangepaste invoervelden die op het checkoutformulier worden verzameld.
Eigenschappen
Eigenschappen
Placeholdertekst die in het lege veld wordt getoond.
null als er geen is ingesteld.Voor de klant zichtbare variantbeschrijving. Maximaal 1000 tekens.
null als er geen beschrijving is ingesteld.Toegangsduur in dagen voor varianten met een vervaldatum, zoals 365 voor een jaarpas.
null voor varianten zonder vervaldatum.Afbeelding van de prijslaag (
url, blurhash) die op de productpagina wordt getoond; null wanneer er geen afbeelding is ingesteld.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
Eigenschappen
Het bedrag in hoofdeenheden, als exacte decimale string.
"10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
Privénotities die niet aan klanten worden getoond.
null tenzij de actor de scope plan:basic:read heeft op het account van de variant.Factuur waarvoor deze variant is gegenereerd;
null tenzij aangemaakt voor een factuur.Actieve memberships via deze variant.
null tenzij de actor de scope plan:basic:read heeft op het account van de variant.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.Of er een annuleringskorting wordt aangeboden.
null tenzij de actor de scope plan:basic:read heeft op het account van de variant.Configuratie van betaalmethoden (
enabled, disabled, include_platform_defaults); null wanneer de variant standaardinstellingen gebruikt.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.Terugkerende prijs die elke factureringsperiode in rekening wordt gebracht, in
currency.Stock keeping unit, vrije tekst ingesteld door de verkoper (bijv.
TSHIRT-LARGE-BLUE). Uniciteit wordt niet afgedwongen. null wanneer niet ingesteld.Termijnbetalingen die vereist zijn voordat het abonnement wordt gepauzeerd. Moet groter zijn dan 1.
null als gespreid betalen niet is geconfigureerd.Eenheden beschikbaar voor aankoop.
null tenzij de actor de scope plan:basic:read heeft op het account van de variant.Oorspronkelijke initiële prijs, doorgestreept weergegeven, in
currency. null wanneer er geen doorgestreepte prijs is ingesteld.Oorspronkelijke verlengingsprijs, doorgestreept weergegeven, in
currency. null wanneer er geen doorgestreepte prijs is ingesteld.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_requiredWeergavenaam 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.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.Of de variant onbeperkte voorraad heeft. Wanneer
true, wordt het veld stock genegeerd; wachtlijstvarianten rapporteren altijd true.Product

