Referencia APICoupons

Listar cupones

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

Authentication

X-SECRET-KEYstring
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`.

Query parameters

pageintegerOptional>=1Defaults to 1

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

itemsintegerOptional1-100Defaults to 10

Elementos por página

Response

Lista de cupones
idstringOptional

ID único del cupón

namestringOptional

Nombre o código del cupón

discount_modeenumOptional
Tipo de descuento
display_namestring or nullOptional

Nombre visible para el cliente (usado en modo custom_bins)

amount_off_in_centsinteger or nullOptional
Descuento fijo en centavos
percent_offdouble or nullOptional
Porcentaje de descuento
automatically_appliesbooleanOptional

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

max_redemptionsinteger or nullOptional

Número máximo de usos

times_redeemedintegerOptionalRead-only

Número de veces que se ha redimido el descuento

currencystring or nullOptional
Moneda del descuento fijo
durationenumOptional

Duración del descuento para suscripciones

expires_atdatetime or nullOptional

Fecha de expiración

statusstringOptional

Estado del cupón