Skip to main content
Elle contrôle le prix, la fréquence de facturation, le stock, le SKU, les attributs, le comportement fiscal, les champs du checkout et la visibilité à l’achat. Les ID de variante restent préfixés par plan_. Utilisez l’API Variantes pour créer des variantes de produits, lister les variantes existantes, récupérer ou mettre à jour la configuration d’une variante, calculer la taxe pour le checkout, et supprimer les variantes qui ne doivent plus être proposées.

Endpoints

Attributs

string
requis
ID de la variante, préfixé par plan_.
object | null
requis
Compte qui vend cette variante ; null pour les variantes de facture autonomes.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
boolean
requis
Indique si la tarification adaptative est activée pour cette variante. Paramètre brut — ne vérifie pas la compatibilité avec le processeur ni les feature flags.
boolean
requis
Indique si plusieurs unités peuvent être achetées dans une commande. Les variantes à renouvellement ne peuvent pas l’activer. Lorsque false, les checkouts, paniers et factures refusent une quantité supérieure à 1.
object | null
requis
Valeurs d’attributs qui distinguent cette variante au sein de son produit, sous forme de correspondance entre nom d’attribut et valeur, par exemple \{"color": "Blue", "size": "Large"}. Les noms sont des identifiants en snake_case et sont renvoyés par ordre alphabétique. Chaque variante dotée d’attributs sur un produit porte les mêmes noms d’attributs et un ensemble distinct de valeurs ; le produit liste l’ensemble complet des options dans variant_attributes. null lorsque la variante n’a pas d’attributs.
number | null
requis
Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un abonnement mensuel ou 365 pour un abonnement annuel. null pour les variantes à paiement unique.
string
requis
Modèle de facturation de cette variante.Options disponibles : renewal, one_time
number | null
requis
Durée de la remise d’annulation : 0 pour toujours, 1 pour le prochain paiement uniquement, ou un nombre de mois calendaires à compter de son acceptation par le client. null lorsqu’aucune n’est proposée ou que l’acteur ne dispose pas de la portée plan:basic:read.
number | null
requis
Remise d’annulation sous forme de pourcentage entier. null lorsqu’aucune n’est proposée ou que l’acteur ne dispose pas de la portée plan:basic:read.
object | null
requis
Style du checkout au niveau de la variante (background_color, button_color, font_family, border_style) ; null hérite de la valeur par défaut du compte.
boolean
requis
Indique si la taxe est perçue sur les achats de cette variante, selon la configuration fiscale du compte.
string
requis
Date de création de la variante, sous forme d’horodatage ISO 8601.
string
requis
Code ISO 4217 à trois lettres, en minuscules, de la devise dans laquelle tous les prix de cette variante sont exprimés : la devise propre de la variante, ou la presentment_currency demandée lors de la lecture lorsque la variante peut y être convertie.
object[]
requis
Champs de saisie personnalisés collectés sur le formulaire du checkout.

Propriétés

string
requis
ID du champ personnalisé, préfixé par field_.
string
requis
Type de saisie du champ personnalisé.Options disponibles : text
string
requis
Libellé du champ affiché au client lors du checkout.
number
requis
Position du champ sur le formulaire du checkout.
string | null
requis
Texte indicatif affiché dans le champ vide. null si aucun n’est défini.
boolean
requis
Indique si le client doit remplir ce champ pour finaliser le checkout.
boolean | null
requis
Indique si la variante peut être supprimée (elle n’a ni adhésions ni entrées de liste d’attente). null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
string | null
requis
Description de la variante visible par le client. 1000 caractères maximum. null si aucune description n’est définie.
object | null
requis
La configuration régissant un checkout pour cette variante, résolue à travers chaque niveau (celui de la variante et celui du compte) — la forme que porte le payment_method_configuration d’une session. Appliquez-la au catalogue des types de moyens de paiement pour obtenir l’ensemble proposable. null signifie les valeurs par défaut de la plateforme ; payment_method_configuration reste la surcharge modifiable propre à la variante.

Propriétés

string[]
requis
Moyens de paiement que ce checkout exclut, même lorsque les valeurs par défaut les proposeraient.
string[]
requis
Moyens de paiement que ce checkout propose en plus de ceux fournis par les valeurs par défaut.
boolean
requis
Indique si l’ensemble par défaut de Whop sert de point de départ. Lorsque false, seuls les moyens de enabled sont proposés.
number | null
requis
Durée d’accès en jours pour les variantes à expiration, par exemple 365 pour un pass d’un an. null pour les variantes sans expiration.
string
requis
Prix lisible destiné à l’affichage (devise + intervalle) en currency, par exemple « $10 / month ».
object | null
requis
Image du niveau tarifaire (url, blurhash) affichée sur la page produit ; null lorsqu’aucune image n’est définie.
number
requis
Prix d’achat initial, en currency.
object
requis
Total prélevé au checkout pour une unité, avant codes promo et taxes : initial_price plus le premier renewal_price pour les variantes récurrentes, ou initial_price seul lorsqu’un essai gratuit s’applique. L’essai ne s’applique pas lorsque l’utilisateur qui consulte en a déjà utilisé un pour cette variante. Exprimé en currency.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string | null
requis
Notes privées non affichées aux clients. null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
object | null
requis
Facture pour laquelle cette variante a été générée ; null sauf si elle a été créée pour une facture.
number | null
requis
Adhésions actives via cette variante. null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
object | null
requis
Paires clé-valeur personnalisées stockées sur la variante. Incluses dans les payloads de webhook pour les événements de paiement et d’adhésion. 50 clés maximum, 100 caractères par clé, 500 caractères par valeur. Les clés réservées custom_cta et custom_cta_url, lorsqu’elles sont définies, remplacent l’appel à l’action du checkout du produit pour cette variante.
boolean | null
requis
Indique si une remise d’annulation est proposée. null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
object | null
requis
Configuration des moyens de paiement (enabled, disabled, include_platform_defaults) ; null lorsque la variante utilise les paramètres par défaut.
object | null
requis
Produit auquel appartient cette variante ; null pour les variantes autonomes.
string
requis
URL où les clients peuvent acheter directement cette variante.
string | null
requis
Page vers laquelle le client est redirigé après avoir payé cette variante. null lorsqu’aucune n’est définie, ou sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
string
requis
Méthode de vente de cette variante.Options disponibles : buy_now, waitlist
number
requis
Prix récurrent prélevé à chaque période de facturation, en currency.
string | null
requis
Unité de gestion de stock (SKU), texte libre défini par le vendeur (par exemple TSHIRT-LARGE-BLUE). Son unicité n’est pas imposée. null lorsqu’il n’est pas défini.
number | null
requis
Paiements échelonnés requis avant la mise en pause de l’abonnement. Doit être supérieur à 1. null si le paiement fractionné n’est pas configuré.
number | null
requis
Unités disponibles à l’achat. null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
number | null
requis
Prix initial d’origine affiché barré, en currency. null lorsqu’aucun prix barré n’est défini.
number | null
requis
Prix de renouvellement d’origine affiché barré, en currency. null lorsqu’aucun prix barré n’est défini.
string
requis
Mode de gestion de la taxe pour cette variante, y compris si la taxe est incluse dans le prix, ajoutée au checkout ou non configurée.Options disponibles : inclusive, exclusive, unspecified
string | null
requis
Comportement 3D Secure pour les paiements par carte en session pris en charge. mandate_challenge exige un challenge 3DS avant le traitement du paiement ; mandate_if_required impose un challenge uniquement lorsque le processeur de paiement l’exige ; frictionless_if_required utilise le flux 3DS frictionless habituel. Les paiements de 1 000 $ ou plus utilisent mandate_if_required sauf si mandate_challenge est sélectionné. Les exigences de gestion des risques et de récupération de l’authentification peuvent prévaloir sur cette préférence. null hérite de la valeur par défaut du compte.Options disponibles : mandate_challenge, mandate_if_required, frictionless_if_required
string | null
requis
Nom d’affichage de la variante présenté aux clients. 30 caractères maximum. Une variante créée sans nom prend par défaut ses valeurs d’attributs jointes par /. null si aucun titre n’a été défini.
number | null
requis
Jours d’essai gratuit avant le premier prélèvement de renouvellement. null si aucun essai n’est configuré ou si l’utilisateur a déjà utilisé un essai pour cette variante.
boolean
requis
Indique si la variante a un stock illimité. Lorsque true, le champ stock est ignoré ; les variantes avec liste d’attente indiquent toujours true.
integer | null
requis
Nombre de factures émises pour cette variante qui ne sont ni payées ni annulées. Tant qu’il est supérieur à 0, vous ne pouvez pas modifier les prix, la période de facturation, l’essai, le nombre de paiements, la devise ou le type de facturation de la variante. null sauf si l’acteur dispose de la portée plan:basic:read sur le compte de la variante.
string
requis
Date de dernière mise à jour de la variante, sous forme d’horodatage ISO 8601.
string
requis
Contrôle où cette variante peut être vue. Lorsque hidden, la variante n’est accessible que via son lien direct.Options disponibles : visible, hidden, archived, quick_link
Variant