Skip to main content
Usa la API de Products para buscar en el marketplace público, listar los productos de una cuenta, obtener un producto y crear, actualizar o eliminar productos.
Reemplaza el recurso Legacy Products. Las integraciones Legacy existentes siguen funcionando; consulta Versiones de la API para conocer el contrato de estabilidad.

Endpoints

Atributos

string
requerido
ID del producto, con el prefijo prod_.
object | null
requerido
Cuenta que vende este producto.
number
requerido
Calificación promedio en estrellas de las reseñas publicadas de este producto, de 1.0 a 5.0. Devuelve 0.0 cuando no hay ninguna calificación de reseñas publicadas disponible.
string
requerido
Cuándo se creó el producto, como marca de tiempo ISO 8601.
string | null
requerido
Etiqueta del botón de llamada a la acción que se muestra en la página de compra del producto.Opciones 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
requerido
URL a la que enlaza el botón de llamada a la acción en lugar del checkout.
string | null
requerido
Etiqueta de texto personalizada en el extracto bancario del cliente.
object | null
requerido
Variante comprable que se muestra y con la que se hace el checkout. Es la predeterminada configurada cuando esa variante es comprable; de lo contrario, la primera variante comprable en el orden de la página del producto. null cuando ninguna es comprable.

Propiedades

string
requerido
ID de la variante, con el prefijo plan_.
number | null
requerido
Número de días entre cargos recurrentes, como 30 para mensual o 365 para anual. null para variantes de pago único.
string
requerido
Modelo de facturación de esta variante: one_time o renewal.Opciones disponibles: renewal, one_time
number | null
requerido
Duración del acceso en días para variantes con vencimiento. null para variantes sin vencimiento.
object
requerido
Lo que el checkout cobra por adelantado. amount es "0.00" cuando el primer cargo es gratuito, como en una prueba.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
El cargo recurrente cada billing_period días. amount es "0.00" para variantes de pago único.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string | null
requerido
Nombre visible de la variante que se muestra a los clientes. null si no se ha definido ningún título.
number | null
requerido
Días de prueba gratuita antes del primer cargo de renovación. null si no hay ninguna prueba configurada o si el usuario que inició sesión ya usó una prueba en esta variante.
boolean
requerido
Si la variante tiene stock ilimitado.
string
requerido
Dónde se puede ver esta variante. Las variantes visible aparecen en la página del producto.Opciones disponibles: visible, hidden, archived, quick_link
string | null
requerido
Descripción escrita que se muestra en la página del producto. null si no se ha definido ninguna.
object[]
requerido
Experiencias que incluye el producto, como cursos, chats y apps, de la más antigua a la más reciente. Contiene las primeras 100; pagina el resto con GET /experiences?product_id=.

Propiedades

string
requerido
ID de la experiencia, con el prefijo exp_.
object
requerido
App en la que se ejecuta la experiencia.

Propiedades

string
requerido
ID de la app, con el prefijo app_.
object
requerido
Icono de la app. Recurre al icono predeterminado de la app cuando no se ha subido ninguno.

Propiedades

string
requerido
URL de la imagen del icono. Siempre está presente: es el icono predeterminado de la app cuando no se ha subido ninguno.
string
requerido
Nombre visible de la app.
string | null
requerido
URL de la imagen del logo subido para esta experiencia. null cuando no tiene ninguno; muestra el icon de la app en su lugar.
string
requerido
Nombre visible de la experiencia.
string | null
requerido
Identificador externo almacenado en el producto para tu propia referencia.
Imágenes de la galería de este producto, ordenadas por posición.

Propiedades

string
requerido
ID de la imagen de la galería.
string | null
requerido
Tipo MIME del archivo subido, como image/jpeg.
string | null
requerido
URL preoptimizada para renderizar esta imagen en el cliente.
number | null
requerido
Tasa de comisión que ganan los afiliados a través del programa de afiliados global.
string | null
requerido
Estado de inscripción en el programa de afiliados global.Opciones disponibles: enabled, disabled
string | null
requerido
Titular de marketing breve que se muestra en la página del producto.
string[]
requerido
Etiquetas en minúsculas que se usan para agrupar productos en colecciones. Filtra el endpoint de listado por labels para obtener una colección.
string | null
requerido
URL de la imagen del logo que se muestra en las páginas de producto y en los resultados de búsqueda. null cuando el producto no tiene logo.
string
requerido
Estado del listado en el marketplace de whop.com. pending_review significa enviado y a la espera de revisión; live_marketplace significa aprobado y descubrible.Opciones disponibles: not_available, pending_review, live_marketplace
number | null
requerido
Tasa de comisión que ganan los miembros a través del programa de afiliados de miembros.
string | null
requerido
Estado de inscripción en el programa de afiliados de miembros.Opciones disponibles: enabled, disabled
number
requerido
Membresías activas de este producto; 0 si los recuentos públicos de miembros están desactivados.
object | null
requerido
Pares clave-valor personalizados almacenados en el producto.
object | null
requerido
Usuario propietario de la cuenta que vende este producto.
object | null
requerido
Código de clasificación fiscal de este producto, o null si no se ha definido ningún código fiscal.
number
requerido
Reseñas de clientes publicadas de este producto.
string
requerido
Slug de URL del enlace público del producto.
string
requerido
Nombre visible del producto que se muestra a los clientes.
string
requerido
Cuándo se actualizó el producto por última vez, como marca de tiempo ISO 8601.
object | null
requerido
El conjunto de opciones que abarcan las variantes del producto, como un mapa de nombre de atributo a los valores en uso, p. ej. \{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Se deriva de las variantes visibles que no son de factura y que tienen attributes: claves en orden alfabético, valores en el orden en que se crearon las variantes. Solo lectura. null cuando el producto no tiene variantes.
object[] | null
requerido
Las variantes del producto cuya visibility es visible y que no se generaron para una factura, en orden de creación. Las opciones de precio simples se incluyen con attributes: null. Las variantes ocultas, archivadas, de enlace rápido y de factura siguen siendo accesibles a través de GET /variants. null cuando el producto tiene más de 1000 variantes (pagínalas con GET /variants?product_ids=) y en los payloads de webhooks.

Propiedades

string
requerido
ID de la variante, con el prefijo plan_.
object | null
requerido
Cuenta que vende esta variante; null para variantes de factura independientes.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string
requerido
Nombre visible de la cuenta.
boolean
requerido
Si los precios adaptativos están activados para esta variante. Es la configuración sin procesar: no comprueba la compatibilidad con el procesador ni los feature flags.
boolean
requerido
Si se puede comprar más de una unidad en un pedido. Las variantes de renovación no pueden activarlo. Cuando es false, los checkouts, carritos y facturas rechazan una cantidad superior a 1.
object | null
requerido
Valores de atributo que distinguen esta variante dentro de su producto, como un mapa de nombre de atributo a valor, p. ej. \{"color": "Blue", "size": "Large"}. Los nombres son identificadores en snake_case y se devuelven en orden alfabético. Todas las variantes con atributos de un producto tienen los mismos nombres de atributo y un conjunto distinto de valores; el producto lista el conjunto completo de opciones como variant_attributes. null cuando la variante no tiene atributos.
number | null
requerido
Número de días entre cargos recurrentes, como 30 para mensual o 365 para anual. null para variantes de pago único.
string
requerido
Modelo de facturación de esta variante.Opciones disponibles: renewal, one_time
number | null
requerido
Cuánto dura el descuento por cancelación: 0 para siempre, 1 solo el siguiente pago, o un número de meses naturales desde que el cliente lo acepta. null cuando no se ofrece ninguno o el actor no tiene el scope plan:basic:read.
number | null
requerido
Descuento por cancelación como porcentaje entero. null cuando no se ofrece ninguno o el actor no tiene el scope plan:basic:read.
object | null
requerido
Estilo del checkout a nivel de variante (background_color, button_color, font_family, border_style); null hereda el valor predeterminado de la cuenta.
string
requerido
Cuándo se creó la variante, como marca de tiempo ISO 8601.
string
requerido
Código ISO 4217 de tres letras, en minúsculas, de la divisa en la que se expresa cada precio de esta variante: la propia divisa de la variante, o la presentment_currency que solicitó la lectura cuando la variante se puede convertir a ella.
object[]
requerido
Campos de entrada personalizados que se recopilan en el formulario de checkout.

Propiedades

string
requerido
ID del campo personalizado, con el prefijo field_.
string
requerido
Tipo de entrada del campo personalizado.Opciones disponibles: text
string
requerido
Etiqueta del campo que se muestra al cliente en el checkout.
number
requerido
Posición del campo en el formulario de checkout.
string | null
requerido
Texto de marcador de posición que se muestra en el campo vacío. null si no se ha definido ninguno.
boolean
requerido
Si el cliente debe completar este campo para hacer el checkout.
string | null
requerido
Descripción de la variante visible para el cliente. Máximo 1000 caracteres. null si no se ha definido ninguna descripción.
number | null
requerido
Duración del acceso en días para variantes con vencimiento, como 365 para un pase de un año. null para variantes sin vencimiento.
string
requerido
Precio legible para mostrar (divisa + intervalo) en currency, p. ej. “$10 / month”.
object | null
requerido
Imagen del nivel de precio (url, blurhash) que se muestra en la página del producto; null cuando no se ha definido ninguna imagen.
number
requerido
Precio de compra inicial, en currency.
object
requerido
Total cobrado en el checkout por una unidad, antes de códigos promocionales e impuestos: initial_price más el primer renewal_price para variantes recurrentes, o solo initial_price mientras se aplica una prueba gratuita. La prueba no se aplica cuando el usuario que la consulta ya ha usado una para esta variante. Expresado en currency.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string | null
requerido
Notas privadas que no se muestran a los clientes. null a menos que el actor tenga el scope plan:basic:read en la cuenta de la variante.
object | null
requerido
Factura para la que se generó esta variante; null a menos que se haya creado para una factura.
number | null
requerido
Membresías activas a través de esta variante. null a menos que el actor tenga el scope plan:basic:read en la cuenta de la variante.
object | null
requerido
Pares clave-valor personalizados almacenados en la variante. Se incluyen en los payloads de webhooks de eventos de pagos y membresías. Máximo 50 claves, 100 caracteres por clave, 500 caracteres por valor. Las claves reservadas custom_cta y custom_cta_url, cuando están definidas, anulan la llamada a la acción del checkout del producto para esta variante.
boolean | null
requerido
Si se ofrece un descuento por cancelación. null a menos que el actor tenga el scope plan:basic:read en la cuenta de la variante.
object | null
requerido
Configuración de métodos de pago (enabled, disabled, include_platform_defaults); null cuando la variante usa la configuración predeterminada.
object | null
requerido
Producto al que pertenece esta variante; null para variantes independientes.
string
requerido
URL donde los clientes pueden comprar esta variante directamente.
string | null
requerido
A dónde se envía al cliente después de pagar esta variante. null cuando no se ha definido ninguna, o a menos que el actor tenga el scope plan:basic:read en la cuenta de la variante.
string
requerido
Método de venta de esta variante.Opciones disponibles: buy_now, waitlist
number
requerido
Precio recurrente cobrado en cada período de facturación, en currency.
string | null
requerido
Unidad de mantenimiento de stock (SKU), texto libre definido por el vendedor (p. ej. TSHIRT-LARGE-BLUE). No se exige que sea único. null cuando no está definido.
number | null
requerido
Pagos a plazos requeridos antes de que la suscripción se pause. Debe ser mayor que 1. null si el pago fraccionado no está configurado.
number | null
requerido
Unidades disponibles para la compra. null a menos que el actor tenga el scope plan:basic:read en la cuenta de la variante.
number | null
requerido
Precio inicial original que se muestra tachado, en currency. null cuando no se ha definido ningún tachado.
number | null
requerido
Precio de renovación original que se muestra tachado, en currency. null cuando no se ha definido ningún tachado.
string | null
requerido
Comportamiento de 3D Secure para los pagos con tarjeta en sesión admitidos. mandate_challenge exige un desafío 3DS antes de procesar el pago; mandate_if_required exige un desafío solo cuando el procesador de pagos lo requiere; frictionless_if_required usa el flujo 3DS sin fricción habitual. Los pagos de $1,000 o más usan mandate_if_required a menos que se seleccione mandate_challenge. Los requisitos de riesgo y de recuperación de autenticación pueden anular la preferencia. null hereda el valor predeterminado de la cuenta.Opciones disponibles: mandate_challenge, mandate_if_required, frictionless_if_required
string | null
requerido
Nombre visible de la variante que se muestra a los clientes. Máximo 30 caracteres. Una variante creada sin nombre usa por defecto sus valores de atributo unidos con /. null si no se ha definido ningún título.
number | null
requerido
Días de prueba gratuita antes del primer cargo de renovación. null si no hay ninguna prueba configurada o si el usuario ya usó una prueba para esta variante.
boolean
requerido
Si la variante tiene stock ilimitado. Cuando es true, el campo stock se ignora; las variantes con lista de espera siempre informan true.
string
requerido
Cuándo se actualizó la variante por última vez, como marca de tiempo ISO 8601.
string
requerido
Controla dónde se puede ver esta variante. Cuando es hidden, la variante solo es accesible mediante su enlace directo.Opciones disponibles: visible, hidden, archived, quick_link
boolean
requerido
Si Whop ha verificado el producto.
string | null
requerido
Si el producto es visible públicamente, está oculto o archivado.
Product