Reemplaza el recurso Legacy Products.
Las integraciones Legacy existentes siguen funcionando; consulta Versiones
de la API para conocer el contrato de estabilidad.
Endpoints
Atributos
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.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_orderVariante 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
Propiedades
Número de días entre cargos recurrentes, como 30 para mensual o 365 para
anual.
null para variantes de pago único.Modelo de facturación de esta variante:
one_time o renewal.Opciones disponibles: renewal, one_timeDuración del acceso en días para variantes con vencimiento.
null para variantes
sin vencimiento.Lo que el checkout cobra por adelantado.
amount es "0.00" cuando el primer cargo es gratuito, como en una prueba.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta
el propio cargo.
El cargo recurrente cada
billing_period días. amount es "0.00" para variantes de pago único.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta
el propio cargo.
Nombre visible de la variante que se muestra a los clientes.
null si no se ha definido ningún título.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.Descripción escrita que se muestra en la página del producto.
null si no se ha definido ninguna.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
Propiedades
App en la que se ejecuta la experiencia.
Propiedades
Propiedades
URL de la imagen del logo subido para esta experiencia.
null cuando no tiene ninguno; muestra
el icon de la app en su lugar.Tasa de comisión que ganan los afiliados a través del programa de afiliados global.
Estado de inscripción en el programa de afiliados global.Opciones disponibles:
enabled, disabledEtiquetas en minúsculas que se usan para agrupar productos en colecciones. Filtra el
endpoint de listado por
labels para obtener una colección.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.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_marketplaceTasa de comisión que ganan los miembros a través del programa de afiliados de miembros.
Estado de inscripción en el programa de afiliados de miembros.Opciones disponibles:
enabled, disabledMembresías activas de este producto; 0 si los recuentos públicos de miembros están desactivados.
Código de clasificación fiscal de este producto, o
null si no se ha definido ningún código fiscal.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.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
Propiedades
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.
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.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.Número de días entre cargos recurrentes, como 30 para mensual o 365 para
anual.
null para variantes de pago único.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.Descuento por cancelación como porcentaje entero.
null cuando no se
ofrece ninguno o el actor no tiene el scope plan:basic:read.Estilo del checkout a nivel de variante (
background_color, button_color,
font_family, border_style); null hereda el valor predeterminado de la cuenta.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.Campos de entrada personalizados que se recopilan en el formulario de checkout.
Propiedades
Propiedades
Texto de marcador de posición que se muestra en el campo vacío.
null si no se ha definido ninguno.Descripción de la variante visible para el cliente. Máximo 1000 caracteres.
null si no
se ha definido ninguna descripción.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.Imagen del nivel de precio (
url, blurhash) que se muestra en la página del producto; null cuando
no se ha definido ninguna imagen.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
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta
el propio cargo.
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.Factura para la que se generó esta variante;
null a menos que se haya creado para una factura.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.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.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.Configuración de métodos de pago (
enabled, disabled,
include_platform_defaults); null cuando la variante usa la configuración predeterminada.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.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.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.Unidades disponibles para la compra.
null a menos que el actor tenga el
scope plan:basic:read en la cuenta de la variante.Precio inicial original que se muestra tachado, en
currency. null cuando
no se ha definido ningún tachado.Precio de renovación original que se muestra tachado, en
currency. null cuando
no se ha definido ningún tachado.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_requiredNombre 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.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.Si la variante tiene stock ilimitado. Cuando es
true, el campo stock se
ignora; las variantes con lista de espera siempre informan true.Product

