Skip to main content
Pertenece a una cuenta, puede limitarse a un producto y controla quién puede canjearlo, cuántas veces, hasta cuándo y durante cuántos períodos de facturación dura el descuento. Usa la API de Promo Codes para crear códigos para una cuenta, listarlos y obtenerlos, desactivar un código para pausar los canjes o volver a activarlo, y archivar los códigos que ya no ofreces.

Endpoints

Atributos

string
requerido
ID del código promocional, con el prefijo promo_.
object
requerido
Cuenta propietaria del código promocional.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string
requerido
Nombre visible de la cuenta.
object | null
requerido
Afiliado al que se le acreditan los referidos que usan el código promocional, o null cuando no hay ningún afiliado asociado.

Propiedades

string
requerido
ID del afiliado, con el prefijo aff_.
object
requerido
Usuario que es el afiliado.

Propiedades

string
requerido
ID de usuario del afiliado, con el prefijo user_.
string | null
requerido
Nombre visible del afiliado.
string
requerido
URL del avatar del afiliado, incluida la alternativa generada cuando no se ha definido ningún avatar.
string | null
requerido
Nombre de usuario público del afiliado.
number
requerido
Importe del descuento. Los descuentos porcentuales se representan como una fracción decimal.
boolean
requerido
Si el código promocional está restringido a clientes que se dieron de baja.
string | null
requerido
Código que se introduce en el checkout.
string
requerido
Cuándo se creó el código promocional, como marca de tiempo ISO 8601.
string
requerido
Divisa usada para un descuento de importe fijo.Opciones disponibles: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau, hnl
string
requerido
Cuánto tiempo se aplica el descuento.Opciones disponibles: forever, once, repeating
boolean
requerido
Si el código promocional se aplica solo a membresías existentes.
string | null
requerido
Cuándo vence el código promocional, como marca de tiempo ISO 8601.
object
requerido
Metadatos clave-valor personalizados almacenados en el código promocional.
boolean
requerido
Si el código promocional está restringido a clientes nuevos.
boolean
requerido
Si cada cliente puede canjear el código promocional solo una vez.
object | null
requerido
Producto al que está restringido el código promocional, o null cuando no está limitado a un producto.

Propiedades

string
requerido
ID del producto, con el prefijo prod_.
string
requerido
Nombre visible del producto.
integer | null
requerido
Intervalos de facturación a los que se aplica el descuento.
string
requerido
Si el descuento es porcentual o de importe fijo.Opciones disponibles: percentage, flat_amount
string
requerido
Estado del ciclo de vida del código promocional.Opciones disponibles: active, inactive, archived
integer
requerido
Usos máximos cuando el stock es limitado.
boolean
requerido
Si el código promocional no tiene límite de canjes.
string
requerido
Cuándo se actualizó el código promocional, como marca de tiempo ISO 8601.
integer
requerido
Membresías que usaron el código promocional.
PromoCode