Skip to main content
Den styrer pris, faktureringskadence, lager, SKU, attributter, momsadfærd, checkout-felter og købssynlighed. Variant-ID’er har fortsat præfikset plan_. Brug Variants API’et til at oprette varianter til produkter, vise eksisterende varianter, hente eller opdatere variantkonfiguration, beregne moms til checkout og slette varianter, der ikke længere skal tilbydes.

Endpoints

Attributter

string
påkrævet
Variant-ID med præfikset plan_.
object | null
påkrævet
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 en mængde over 1.
object | null
påkrævet
Attributværdier, der adskiller denne variant inden for dens produkt, som et map 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 særskilt 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, såsom 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, hvor kunden accepterer den. null når ingen tilbydes, eller aktøren mangler plan:basic:read-scopet.
number | null
påkrævet
Annulleringsrabat som en heltalsprocent. null, når ingen tilbydes, eller aktøren mangler plan:basic:read-scopet.
object | null
påkrævet
Checkout-styling på variantniveau (background_color, button_color, font_family, border_style); null arver kontoens standard.
boolean
påkrævet
Om der opkræves moms ved køb af denne variant, baseret på kontoens momskonfiguration.
string
påkrævet
Hvornår varianten blev oprettet, som et ISO 8601-tidsstempel.
string
påkrævet
Trebogstavs ISO 4217-kode for den valuta, som alle priser på denne variant er angivet i, med små bogstaver: 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 i 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 ved checkout.
number
påkrævet
Feltets position i checkout-formularen.
string | null
påkrævet
Pladsholdertekst, der vises i det tomme felt. null, hvis ingen er angivet.
boolean
påkrævet
Om kunden skal udfylde dette felt for at gennemføre checkout.
boolean | null
påkrævet
Om varianten kan slettes (den har ingen medlemskaber eller ventelisteposter). null, medmindre aktøren har plan:basic:read-scopet på variantens konto.
string | null
påkrævet
Variantbeskrivelse, der er synlig for kunden. Maksimalt 1000 tegn. null, hvis ingen beskrivelse er angivet.
object | null
påkrævet
Den konfiguration, der styrer en checkout for denne variant, opløst gennem alle lag (variantens egen og kontoens) — den form, som en sessions payment_method_configuration har. Anvend den oven på kataloget over betalingsmetodetyper for at få det sæt, der kan tilbydes. null betyder platformens standarder; payment_method_configuration forbliver variantens egen redigerbare tilsidesættelse.

Egenskaber

string[]
påkrævet
Betalingsmetoder, som denne checkout tilbageholder, selv når standarderne ville tilbyde dem.
string[]
påkrævet
Betalingsmetoder, som denne checkout tilbyder ud over det, standarderne giver.
boolean
påkrævet
Om Whops standardsæt er udgangspunktet. Når false, tilbydes kun enabled.
number | null
påkrævet
Adgangsvarighed i dage for udløbsbaserede varianter, såsom 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 intet billede er angivet.
number
påkrævet
Indledende købspris, i currency.
object
påkrævet
Samlet beløb opkrævet ved 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 eksakt 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, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og 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 locale ved hjælp af dette.
string | null
påkrævet
Private noter, der ikke vises for kunder. null, medmindre aktøren har plan:basic:read-scopet på variantens konto.
object | null
påkrævet
Faktura, som denne variant blev genereret til; null, medmindre den er oprettet til en faktura.
number | null
påkrævet
Aktive medlemskaber gennem denne variant. null, medmindre aktøren har plan:basic:read-scopet 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 plan:basic:read-scopet 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
Produkt, som denne variant hører til; 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 betaling for denne variant. null, når intet er angivet, eller medmindre aktøren har plan:basic:read-scopet 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), fritekst 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
Ratebetalinger, 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 plan:basic:read-scopet på variantens konto.
number | null
påkrævet
Oprindelig startpris vist med gennemstregning, i currency. null, når ingen gennemstregning er angivet.
number | null
påkrævet
Oprindelig fornyelsespris vist med gennemstregning, i currency. null, når ingen gennemstregning er angivet.
string
påkrævet
Hvordan moms håndteres for denne variant, herunder om moms er inkluderet i prisen, lægges til ved checkout eller ikke er konfigureret.Tilgængelige muligheder: inclusive, exclusive, unspecified
string | null
påkrævet
3D Secure-adfærd for understøttede kortbetalinger i sessionen. mandate_challenge kræver en 3DS-udfordring før betalingsbehandling; mandate_if_required kræver kun en udfordring, 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 gendannelse af godkendelse 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, der vises for kunder. Maksimalt 30 tegn. En variant, der oprettes uden et, får som standard sine attributværdier sammensat med /. null hvis ingen titel er angivet.
number | null
påkrævet
Dage med gratis prøveperiode før den første fornyelsesopkrævning. null, hvis ingen prøveperiode er konfigureret, 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; ventelistevarianter rapporterer altid true.
integer | null
påkrævet
Antal udstedte fakturaer for denne variant, der ikke er betalt eller annulleret. Mens det er over 0, kan du ikke ændre variantens priser, faktureringsperiode, prøveperiode, antal betalinger, valuta eller faktureringstype. null, medmindre aktøren har plan:basic:read-scopet på variantens konto.
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 dens direkte link.Tilgængelige muligheder: visible, hidden, archived, quick_link
Variant