plan_.
Gebruik de Variants API om varianten voor producten aan te maken, bestaande varianten op te vragen, variantconfiguratie op te halen of bij te werken, belasting voor de checkout te berekenen en varianten te verwijderen die niet langer moeten worden aangeboden.
Endpoints
Attributen
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.Of er belasting wordt geïnd bij aankopen van deze variant, op basis van de belastingconfiguratie van het account.
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.Of de variant kan worden verwijderd (er zijn geen memberships of wachtlijstinschrijvingen).
null tenzij de actor de scope plan:basic:read heeft op het account van de variant.Voor de klant zichtbare variantbeschrijving. Maximaal 1000 tekens.
null als er geen beschrijving is ingesteld.De configuratie die een checkout voor deze variant bepaalt, opgelost via elke laag (die van de variant zelf en die van het account) — de vorm die de
payment_method_configuration van een sessie heeft. Pas deze toe op de catalogus van betaalmethodetypes voor de aan te bieden set. null betekent platformstandaarden; payment_method_configuration blijft de eigen bewerkbare override van de variant.Eigenschappen
Eigenschappen
Betaalmethoden die deze checkout achterhoudt, zelfs wanneer de standaarden ze zouden aanbieden.
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.Hoe belasting voor deze variant wordt afgehandeld, inclusief of belasting in de prijs is inbegrepen, bij de checkout wordt toegevoegd of niet is geconfigureerd.Beschikbare opties:
inclusive, exclusive, unspecified3D Secure-gedrag voor ondersteunde on-session kaartbetalingen.
mandate_challenge vereist een 3DS-challenge voordat de betaling wordt verwerkt; mandate_if_required vereist alleen een challenge 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 authenticatieherstel kunnen de voorkeur overschrijven. null neemt de standaard 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.Aantal uitgegeven facturen voor deze variant die niet zijn betaald of ongeldig gemaakt. Zolang dit boven
0 ligt, kun je de prijzen, factureringsperiode, proefperiode, het aantal betalingen, de valuta of het factureringstype van de variant niet wijzigen. null tenzij de actor de scope plan:basic:read heeft op het account van de variant.Variant

