Cupones

Crear

Crea un nuevo objeto Coupon.

post/coupons

Request

  • Base URL
    https://api.ventipay.com/v1
  • URL
    https://api.ventipay.com/v1/coupons
  • Auth
    HTTP bearer

Request body

namestring required

Nombre del cupón.

promotion_codestring required

Código del cupón. Debe ser único para toda la cuenta.

type'amount_off' | 'percent_off' required

Indica el tipo de cupón.

activeboolean

Indica si el objeto está activo o no.

amount_offinteger

Monto a descontar en caso de cupón de monto fijo.

applies_tostring[]

Tipo de objetos aplicables: checkout, subscription.

currencystring

Código de moneda ISO de tres letras.

duration'forever' | 'once' | 'repeating'

Duración del descuento una vez aplicado el cupón.

duration_cyclesinteger

Cantidad de ciclos para duración repetible.

expires_atstring date

Fecha de expiración.

max_redemptionsinteger

Número máximo de aplicaciones.

metadataobject

Conjunto de pares llave-valor asociado al objeto.

percent_offnumber float

Porcentaje a descontar.

reedemable_by_customerboolean

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

Changes

No recorded changes to this operation across all 2 revisions of this API.