Sign in
coupons

Listar cupones

Lista todos los cupones activos de tu cuenta con paginación.

get/coupons

Query parameters

pageinteger

Número de página (empezando en 1)

itemsinteger

Elementos por página

Headers

X-SECRET-KEYstring required

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Response

Lista de cupones

idstring

ID único del cupón

namestring

Nombre o código del cupón

discount_mode'code' | 'bank' | 'custom_bins'

Tipo de descuento

display_namestring nullable

Nombre visible para el cliente (usado en modo custom_bins)

amount_off_in_centsinteger nullable

Descuento fijo en centavos

percent_offnumber double nullable

Porcentaje de descuento

automatically_appliesboolean

Si el descuento se aplica automáticamente en checkouts de tienda

max_redemptionsinteger nullable

Número máximo de usos

times_redeemedinteger

Número de veces que se ha redimido el descuento

currencystring nullable

Moneda del descuento fijo

duration'once' | 'forever'

Duración del descuento para suscripciones

expires_atstring date-time nullable

Fecha de expiración

statusstring

Estado del cupón

Changes