Un objeto coupon representa un cupón de descuento aplicable a una transacción.

El objeto coupon

Atributos


id string

Identificador único del objeto.


object string

Indica el tipo de objeto. Valor siempre será coupon.


active boolean

Indica si el cupón está activo o no. Un cupón que no esté activo no podrá ser aplicado, sin embargo seguirá siendo válido para calcular el monto a descontar sobre los objetos donde ya se aplicó.


amount_off integer

Monto a descontar en caso de que el cupón sea de monto fijo. Se ignora si el tipo de cupón es porcentual.


applies_to array of strings

Listado de objetos al cual el cupón será aplicable.

Posibles valoresDescripción
checkoutAplicable a objetos checkout.
subscriptionAplicable a objetos subscription.

currency string

Código de moneda ISO de tres letras. Corresponde a la moneda aplicable en caso que el cupón sea de monto fijo.


duration enum

Duración del descuento una vez aplicado el cupón. Válido sólo para suscripciones.

Posibles valoresDescripción
foreverEl descuento será aplicado durante toda la suscripción.
onceEl descuento será aplicado sólo en el 1er ciclo de facturación.
repeatingEl descuento será aplicado por una cantidad limitada de ciclos de facturación. Se utiliza en conjunto a duration_cycles.

duration_cycles integer

Cantidad de ciclos a aplicar el descuento en caso de que duration sea igual a repeating.


expires_at datetime

Fecha hasta cuando el cupón podrá ser aplicable en formato ISO 8601. En huso horario UTC.


max_redemptions integer

Número máximo de aplicaciones permitidas. Una vez alcanzado este número, el cupón no podrá ser aplicado a ningún objeto.


name string

Nombre descriptivo del cupón.


percent_off float

Porcentaje a descontar en caso de que el cupón sea porcentual. Se ignora si el tipo de cupón es de monto fijo.


promotion_code string

Código del cupón. Este es el código que debe ser provisto por el cliente para ser aplicado. Debe ser único entre los cupones, tener mínimo 3 caracteres, máximo 100 caracteres, no contener espacios y utilizar sólo números y letras. Será transformado a mayúsculas de forma automática.


reedemable_by_customer boolean

Indica si el cupón puede ser aplicado directamente por un cliente o no.


times_redeemed number

Cantidad de veces que el cupón ha sido aplicado.


type enum

Tipo de cupón.

Posibles valoresDescripción
amount_offEl cupón aplicará un descuento de monto fijo en la moneda del cupón sobre el total del objeto.
percent_offEl cupón aplicará un descuento porcentual sobre el total del objeto.

created_at datetime

Fecha de creación del objeto en formato ISO 8601. En huso horario UTC.


updated_at datetime

Fecha de actualización del objeto en formato ISO 8601. En huso horario UTC.