Remplace la ressource Legacy Products.
Les intégrations Legacy existantes continuent de fonctionner ; consultez Versions
de l’API pour connaître l’engagement de stabilité.
Endpoints
Attributs
Note moyenne en étoiles de l’ensemble des avis publiés pour ce produit, de
1.0 à 5.0. Renvoie 0.0 lorsqu’aucune note d’avis publié n’est disponible.Libellé du bouton d’appel à l’action affiché sur la page d’achat du produit.Options disponibles :
get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_orderVariante achetable à afficher et à utiliser pour le paiement. Il s’agit de la variante par défaut configurée lorsqu’elle est achetable, sinon de la première variante achetable dans l’ordre de la page produit.
null si aucune n’est achetable.Propriétés
Propriétés
Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un rythme mensuel ou 365 pour un rythme annuel.
null pour les variantes à paiement unique.Modèle de facturation de cette variante :
one_time ou renewal.Options disponibles : renewal, one_timeDurée d’accès en jours pour les variantes avec expiration.
null pour les variantes sans expiration.Ce que le checkout prélève immédiatement.
amount vaut "0.00" lorsque le premier prélèvement est gratuit, comme pour un essai.Propriétés
Propriétés
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 en transit.Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
Le prélèvement récurrent tous les
billing_period jours. amount vaut "0.00" pour les variantes à paiement unique.Propriétés
Propriétés
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 en transit.Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
Nom d’affichage de la variante présenté aux clients.
null si aucun titre n’a été défini.Jours d’essai gratuit avant le premier prélèvement de renouvellement.
null si aucun essai n’est configuré ou si l’utilisateur connecté a déjà bénéficié d’un essai sur cette variante.Expériences incluses dans le produit, comme des cours, des chats et des apps, de la plus ancienne à la plus récente. Contient les 100 premières ; parcourez les suivantes page par page via
GET /experiences?product_id=.Propriétés
Propriétés
App dans laquelle s’exécute l’expérience.
Propriétés
Propriétés
URL de l’image du logo importée pour cette expérience.
null si elle n’en a pas ; affichez plutôt l’icon de l’app.Taux de commission que les affiliés perçoivent via le programme d’affiliation global.
Statut d’inscription au programme d’affiliation global.Options disponibles :
enabled, disabledLibellés en minuscules utilisés pour regrouper les produits en collections. Filtrez l’endpoint de liste par
labels pour récupérer une collection.URL de l’image du logo affichée sur les pages produit et dans les résultats de recherche.
null si le produit n’a pas de logo.État de la fiche sur la marketplace whop.com.
pending_review signifie soumis et en attente d’examen ; live_marketplace signifie approuvé et visible.Options disponibles : not_available, pending_review, live_marketplaceTaux de commission que les membres perçoivent via le programme d’affiliation des membres.
Statut d’inscription au programme d’affiliation des membres.Options disponibles :
enabled, disabledAbonnements actifs pour ce produit ; 0 si l’affichage public du nombre de membres est désactivé.
Code de classification fiscale de ce produit, ou
null si aucun code fiscal n’est défini.L’ensemble des options couvertes par les variantes du produit, sous forme de table associant chaque nom d’attribut aux valeurs utilisées, par ex.
\{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Dérivé des variantes visibles, hors factures, qui portent des attributes : clés par ordre alphabétique, valeurs dans l’ordre de création des variantes. Lecture seule. null si le produit n’a pas de variantes.Les variantes du produit dont la
visibility est visible et qui n’ont pas été générées pour une facture, dans l’ordre de création. Les options tarifaires simples sont incluses avec attributes: null. Les variantes masquées, archivées, en lien rapide et de facture restent accessibles via GET /variants. null lorsque le produit compte plus de 1000 variantes (parcourez-les page par page via GET /variants?product_ids=) ainsi que dans les payloads de webhook.Propriétés
Propriétés
Indique si la tarification adaptative est activée pour cette variante. Paramètre brut — ne vérifie ni la compatibilité du processeur ni les feature flags.
Indique si plusieurs unités peuvent être achetées dans une même commande. Les variantes à renouvellement ne peuvent pas l’activer. Lorsque la valeur est
false, les checkouts, paniers et factures refusent une quantité supérieure à 1.Valeurs d’attributs qui distinguent cette variante au sein de son produit, sous forme de table associant chaque nom d’attribut à une valeur, par ex.
\{"color": "Blue", "size": "Large"}. Les noms sont des identifiants en snake_case et sont renvoyés par ordre alphabétique. Toutes les variantes à attributs d’un produit portent les mêmes noms d’attributs et un ensemble de valeurs distinct ; le produit liste l’ensemble complet des options dans variant_attributes. null si la variante n’a pas d’attributs.Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un rythme mensuel ou 365 pour un rythme annuel.
null pour les variantes à paiement unique.Durée de la réduction d’annulation :
0 pour toujours, 1 pour le prochain paiement uniquement, ou un nombre de mois calendaires à partir de son acceptation par le client. null si aucune n’est proposée ou si l’acteur ne dispose pas du scope plan:basic:read.Réduction d’annulation exprimée en pourcentage entier.
null si aucune n’est proposée ou si l’acteur ne dispose pas du scope plan:basic:read.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.Code ISO 4217 à trois lettres, en minuscules, de la devise dans laquelle tous les prix de cette variante sont exprimés : la devise propre à la variante, ou la
presentment_currency demandée lors de la lecture si la variante peut y être convertie.Champs de saisie personnalisés collectés sur le formulaire de paiement.
Propriétés
Propriétés
Description de la variante visible par le client. 1000 caractères maximum.
null si aucune description n’est définie.Durée d’accès en jours pour les variantes avec expiration, par exemple 365 pour un pass d’un an.
null pour les variantes sans expiration.Prix lisible destiné à l’affichage (devise + intervalle) dans
currency, par ex. “$10 / month”.Image du niveau tarifaire (
url, blurhash) affichée sur la page produit ; null si aucune image n’est définie.Total prélevé lors du paiement pour une unité, avant codes promo et taxes :
initial_price plus le premier renewal_price pour les variantes récurrentes, ou initial_price seul tant qu’un essai gratuit s’applique. L’essai ne s’applique pas si l’utilisateur qui consulte en a déjà bénéficié pour cette variante. Exprimé en currency.Propriétés
Propriétés
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 en transit.Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
Notes privées non affichées aux clients.
null sauf si l’acteur dispose du scope plan:basic:read sur le compte de la variante.Facture pour laquelle cette variante a été générée ;
null sauf si elle a été créée pour une facture.Abonnements actifs via cette variante.
null sauf si l’acteur dispose du scope plan:basic:read sur le compte de la variante.Paires clé-valeur personnalisées stockées sur la variante. Incluses dans les payloads de webhook des événements de paiement et d’abonnement. 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.Indique si une réduction d’annulation est proposée.
null sauf si l’acteur dispose du scope plan:basic:read sur le compte de la variante.Configuration des moyens de paiement (
enabled, disabled, include_platform_defaults) ; null lorsque la variante utilise les paramètres par défaut.Page vers laquelle le client est redirigé après avoir payé cette variante.
null si aucune n’est définie, ou si l’acteur ne dispose pas du scope plan:basic:read sur le compte de la variante.Unité de gestion de stock (SKU), texte libre défini par le vendeur (par ex.
TSHIRT-LARGE-BLUE). Unicité non imposée. null si non défini.Nombre de 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é.Unités disponibles à l’achat.
null sauf si l’acteur dispose du scope plan:basic:read sur le compte de la variante.Prix initial d’origine affiché barré, en
currency. null si aucun prix barré n’est défini.Prix de renouvellement d’origine affiché barré, en
currency. null si aucun prix barré n’est défini.Comportement 3D Secure pour les paiements par carte en session pris en charge.
mandate_challenge exige une vérification 3DS avant le traitement du paiement ; mandate_if_required impose une vérification uniquement lorsque le processeur de paiement l’exige ; frictionless_if_required utilise le flux 3DS sans friction habituel. Les paiements de 1 000 $ ou plus utilisent mandate_if_required, sauf si mandate_challenge est sélectionné. Les exigences en matière de risque et de récupération d’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_requiredNom 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 reliées par
/. null si aucun titre n’a été défini.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à bénéficié d’un essai pour cette variante.Indique si la variante dispose d’un stock illimité. Lorsque la valeur est
true, le champ stock est ignoré ; les variantes en liste d’attente indiquent toujours true.Product

