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
Om adaptiv prissætning er aktiveret for denne variant. Rå indstilling — kontrollerer ikke
processorkompatibilitet eller feature flags.
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.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.Antal dage mellem tilbagevendende opkrævninger, såsom 30 for månedlig eller 365 for
årlig.
null for engangsvarianter.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.Annulleringsrabat som en heltalsprocent.
null, når ingen
tilbydes, eller aktøren mangler plan:basic:read-scopet.Checkout-styling på variantniveau (
background_color, button_color,
font_family, border_style); null arver kontoens standard.Om der opkræves moms ved køb af denne variant, baseret på kontoens
momskonfiguration.
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.Brugerdefinerede inputfelter, der indsamles i checkout-formularen.
Egenskaber
Egenskaber
Om varianten kan slettes (den har ingen medlemskaber eller ventelisteposter).
null, medmindre aktøren har plan:basic:read-scopet på
variantens konto.Variantbeskrivelse, der er synlig for kunden. Maksimalt 1000 tegn.
null, hvis ingen
beskrivelse er angivet.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.Adgangsvarighed i dage for udløbsbaserede varianter, såsom 365 for et
etårigt pas.
null for varianter uden udløb.Billede for prisniveau (
url, blurhash), der vises på produktsiden; null, når
intet billede er angivet.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
Egenskaber
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.Hvor mange decimaler beløbet har. Dette er den præcision, som selve
opkrævningen kører med.
Private noter, der ikke vises for kunder.
null, medmindre aktøren har
plan:basic:read-scopet på variantens konto.Faktura, som denne variant blev genereret til;
null, medmindre den er oprettet til en faktura.Aktive medlemskaber gennem denne variant.
null, medmindre aktøren har
plan:basic:read-scopet på variantens konto.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.Om der tilbydes en annulleringsrabat.
null, medmindre aktøren har
plan:basic:read-scopet på variantens konto.Konfiguration af betalingsmetoder (
enabled, disabled,
include_platform_defaults); null, når varianten bruger standardindstillinger.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.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.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.Enheder tilgængelige for køb.
null, medmindre aktøren har
plan:basic:read-scopet på variantens konto.Oprindelig startpris vist med gennemstregning, i
currency. null, når
ingen gennemstregning er angivet.Oprindelig fornyelsespris vist med gennemstregning, i
currency. null, når
ingen gennemstregning er angivet.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, unspecified3D 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_requiredVariantens 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.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.Om varianten har ubegrænset lager. Når
true, ignoreres feltet stock;
ventelistevarianter rapporterer altid true.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.Variant

