Skip to main content
Controla el precio, la cadencia de facturación, el stock, el SKU, los atributos, el comportamiento fiscal, los campos del checkout y la visibilidad de compra. Los IDs de variante siguen teniendo el prefijo plan_. Usa la API de Variants para crear variantes de productos, listar las variantes existentes, obtener o actualizar la configuración de una variante, calcular impuestos para el checkout y eliminar las variantes que ya no deban ofrecerse.

Endpoints

Atributos

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 habilitados para esta variante. Configuración sin procesar: no comprueba la compatibilidad del 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 habilitarlo. Cuando es false, los checkouts, carritos y facturas rechazan una cantidad superior a 1.
object | null
requerido
Valores de atributos 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 alcance 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 alcance 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.
boolean
requerido
Si se cobran impuestos en las compras de esta variante, según la configuración fiscal 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 divisa propia de la variante, o la presentment_currency que pidió la lectura cuando la variante se puede convertir a ella.
object[]
requerido
Campos de entrada personalizados recopilados en el formulario del 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 del checkout.
string | null
requerido
Texto de marcador de posición que se muestra en el campo vacío. null si no se ha establecido ninguno.
boolean
requerido
Si el cliente debe completar este campo para finalizar la compra.
boolean | null
requerido
Si la variante se puede eliminar (no tiene membresías ni entradas en la lista de espera). null a menos que el actor tenga el alcance plan:basic:read en la cuenta de la variante.
string | null
requerido
Descripción de la variante visible para el cliente. Máximo 1000 caracteres. null si no se ha establecido ninguna descripción.
object | null
requerido
La configuración que rige un checkout para esta variante, resuelta a través de todas las capas (la de la propia variante y la de la cuenta): la forma que tiene el payment_method_configuration de una sesión. Aplícala sobre el catálogo de tipos de métodos de pago para obtener el conjunto ofrecible. null significa los valores predeterminados de la plataforma; payment_method_configuration sigue siendo la anulación editable propia de la variante.

Propiedades

string[]
requerido
Métodos de pago que este checkout excluye, incluso cuando los valores predeterminados los ofrecerían.
string[]
requerido
Métodos de pago que este checkout ofrece además de los que proporcionan los valores predeterminados.
boolean
requerido
Si el conjunto predeterminado de Whop es el punto de partida. Cuando es false, solo se ofrece enabled.
number | null
requerido
Duración del acceso en días para variantes con caducidad, como 365 para un pase de un año. null para variantes sin caducidad.
string
requerido
Precio legible para mostrar (divisa + intervalo) en currency, p. ej. “$10 / month”.
object | null
requerido
Imagen del nivel de precios (url, blurhash) que se muestra en la página del producto; null cuando no se ha establecido ninguna imagen.
number
requerido
Precio de la 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 ve 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 alcance 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 alcance 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 webhook de los eventos de pagos y membresías. Máximo 50 claves, 100 caracteres por clave y 500 caracteres por valor. Las claves reservadas custom_cta y custom_cta_url, cuando se establecen, 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 alcance 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
Adónde se envía al cliente después de pagar esta variante. null cuando no se ha establecido ninguna, o a menos que el actor tenga el alcance 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 periodo de facturación, en currency.
string | null
requerido
Stock keeping unit (SKU), texto libre establecido por el vendedor (p. ej. TSHIRT-LARGE-BLUE). No se exige que sea único. null cuando no está establecido.
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 alcance plan:basic:read en la cuenta de la variante.
number | null
requerido
Precio inicial original mostrado tachado, en currency. null cuando no se ha establecido un precio tachado.
number | null
requerido
Precio de renovación original mostrado tachado, en currency. null cuando no se ha establecido un precio tachado.
string
requerido
Cómo se gestionan los impuestos para esta variante, incluido si el impuesto está incluido en el precio, se añade en el checkout o no está configurado.Opciones disponibles: inclusive, exclusive, unspecified
string | null
requerido
Comportamiento de 3D Secure para pagos con tarjeta compatibles en sesión. 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 establecido ningún título.
number | null
requerido
Días de prueba gratuita antes del primer cargo de renovación. null si no hay prueba configurada o el usuario ya ha usado una prueba para esta variante.
boolean
requerido
Si la variante tiene stock ilimitado. Cuando es true, se ignora el campo stock; las variantes de lista de espera siempre informan true.
integer | null
requerido
Número de facturas emitidas para esta variante que no están pagadas ni anuladas. Mientras sea mayor que 0, no puedes cambiar los precios, el periodo de facturación, la prueba, el número de pagos, la divisa ni el tipo de facturación de la variante. null a menos que el actor tenga el alcance plan:basic:read en la cuenta de la variante.
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
Variant