Skip to main content
Utilisez l’API Products pour effectuer des recherches sur la marketplace publique, lister les produits d’un compte, récupérer un produit, et créer, mettre à jour ou supprimer des produits.
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

string
requis
ID du produit, préfixé par prod_.
object | null
requis
Compte qui vend ce produit.
number
requis
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.
string
requis
Date de création du produit, sous forme d’horodatage ISO 8601.
string | null
requis
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_order
string | null
requis
URL vers laquelle renvoie le bouton d’appel à l’action au lieu du checkout.
string | null
requis
Libellé de texte personnalisé sur le relevé bancaire du client.
object | null
requis
Variante 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

string
requis
ID de la variante, préfixé par plan_.
number | null
requis
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.
string
requis
Modèle de facturation de cette variante : one_time ou renewal.Options disponibles : renewal, one_time
number | null
requis
Durée d’accès en jours pour les variantes avec expiration. null pour les variantes sans expiration.
object
requis
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

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 en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
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 écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object
requis
Le prélèvement récurrent tous les billing_period jours. amount vaut "0.00" pour les variantes à paiement unique.

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 en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
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 écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Nom d’affichage de la variante présenté aux clients. 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 connecté a déjà bénéficié d’un essai sur cette variante.
boolean
requis
Indique si la variante dispose d’un stock illimité.
string
requis
Où cette variante est visible. Les variantes visible apparaissent sur la page produit.Options disponibles : visible, hidden, archived, quick_link
string | null
requis
Description écrite affichée sur la page produit. null si aucune n’est définie.
object[]
requis
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

string
requis
ID de l’expérience, préfixé par exp_.
object
requis
App dans laquelle s’exécute l’expérience.

Propriétés

string
requis
ID de l’app, préfixé par app_.
object
requis
Icône de l’app. L’icône d’app par défaut est utilisée si aucune n’a été importée.

Propriétés

string
requis
URL de l’image de l’icône. Toujours présente — l’icône d’app par défaut si aucune n’a été importée.
string
requis
Nom d’affichage de l’app.
string | null
requis
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.
string
requis
Nom d’affichage de l’expérience.
string | null
requis
Identifiant externe stocké sur le produit pour votre propre référence.
Images de galerie de ce produit, triées par position.

Propriétés

string
requis
ID de l’image de galerie.
string | null
requis
Type MIME du fichier importé, par exemple image/jpeg.
string | null
requis
URL pré-optimisée pour afficher cette image côté client.
number | null
requis
Taux de commission que les affiliés perçoivent via le programme d’affiliation global.
string | null
requis
Statut d’inscription au programme d’affiliation global.Options disponibles : enabled, disabled
string | null
requis
Court slogan marketing affiché sur la page produit.
string[]
requis
Libellés en minuscules utilisés pour regrouper les produits en collections. Filtrez l’endpoint de liste par labels pour récupérer une collection.
string | null
requis
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.
string
requis
É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_marketplace
number | null
requis
Taux de commission que les membres perçoivent via le programme d’affiliation des membres.
string | null
requis
Statut d’inscription au programme d’affiliation des membres.Options disponibles : enabled, disabled
number
requis
Abonnements actifs pour ce produit ; 0 si l’affichage public du nombre de membres est désactivé.
object | null
requis
Paires clé-valeur personnalisées stockées sur le produit.
object | null
requis
Utilisateur propriétaire du compte qui vend ce produit.
object | null
requis
Code de classification fiscale de ce produit, ou null si aucun code fiscal n’est défini.
number
requis
Nombre d’avis clients publiés pour ce produit.
string
requis
Slug d’URL du lien public du produit.
string
requis
Nom d’affichage du produit présenté aux clients.
string
requis
Date de la dernière mise à jour du produit, sous forme d’horodatage ISO 8601.
object | null
requis
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.
object[] | null
requis
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

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 ni la compatibilité du processeur ni les feature flags.
boolean
requis
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.
object | null
requis
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.
number | null
requis
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.
string
requis
Modèle de facturation de cette variante.Options disponibles : renewal, one_time
number | null
requis
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.
number | null
requis
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.
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.
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 à la variante, ou la presentment_currency demandée lors de la lecture si la variante peut y être convertie.
object[]
requis
Champs de saisie personnalisés collectés sur le formulaire de paiement.

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 paiement.
number
requis
Position du champ sur le formulaire de paiement.
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 paiement.
string | null
requis
Description de la variante visible par le client. 1000 caractères maximum. null si aucune description n’est définie.
number | null
requis
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.
string
requis
Prix lisible destiné à l’affichage (devise + intervalle) dans currency, par ex. “$10 / month”.
object | null
requis
Image du niveau tarifaire (url, blurhash) affichée sur la page produit ; null si aucune image n’est définie.
number
requis
Prix d’achat initial, en currency.
object
requis
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

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 en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
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 écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
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.
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
Abonnements actifs via cette variante. null sauf si l’acteur dispose du scope 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 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.
boolean | null
requis
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.
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 permettant aux clients d’acheter directement cette variante.
string | null
requis
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.
string
requis
Mode 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 ex. TSHIRT-LARGE-BLUE). Unicité non imposée. null si non défini.
number | null
requis
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é.
number | null
requis
Unités disponibles à l’achat. null sauf si l’acteur dispose du scope plan:basic:read sur le compte de la variante.
number | null
requis
Prix initial d’origine affiché barré, en currency. null si aucun prix barré n’est défini.
number | null
requis
Prix de renouvellement d’origine affiché barré, en currency. null si aucun prix barré n’est défini.
string | null
requis
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_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 reliées 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à bénéficié d’un essai pour cette variante.
boolean
requis
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.
string
requis
Date de la dernière mise à jour de la variante, sous forme d’horodatage ISO 8601.
string
requis
Détermine où cette variante est visible. Lorsqu’elle est hidden, la variante n’est accessible que par son lien direct.Options disponibles : visible, hidden, archived, quick_link
boolean
requis
Indique si le produit a été vérifié par Whop.
string | null
requis
Indique si le produit est visible publiquement, masqué ou archivé.
Product