For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Guías (Español)Guides (English)Referencia API
  • Referencia API
      • GETListar cupones
      • POSTCrear un cupón
      • GETObtener un cupón
      • PUTActualizar un cupón
      • DELArchivar un cupón
LogoLogo
Referencia APICoupons

Listar cupones

GET
https://app.recurrente.com/api/coupons
GET
/api/coupons
$curl https://app.recurrente.com/api/coupons \
> -H "X-SECRET-KEY: <apiKey>"
200Retrieved
1[
2 {
3 "id": "coup_ugwoxcp4",
4 "name": "VERANO25",
5 "discount_mode": "code",
6 "display_name": "string",
7 "amount_off_in_cents": 1500,
8 "percent_off": 1.1,
9 "automatically_applies": false,
10 "max_redemptions": 1,
11 "times_redeemed": 0,
12 "currency": "GTQ",
13 "duration": "once",
14 "expires_at": "2024-01-15T09:30:00Z",
15 "status": "active"
16 }
17]

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

Was this page helpful?
Previous

Crear un cupón

Next
Built with

Authentication

X-SECRET-KEYstring
Tu llave secreta de API

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
idstring

ID único del cupón

namestring

Nombre o código del cupón

discount_modeenum
Tipo de descuento
Allowed values:
display_namestring or null

Nombre visible para el cliente (usado en modo custom_bins)

amount_off_in_centsinteger or null
Descuento fijo en centavos
percent_offdouble or null
Porcentaje de descuento
automatically_appliesboolean

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

max_redemptionsinteger or null

Número máximo de usos

times_redeemedintegerRead-only

Número de veces que se ha redimido el descuento

currencystring or null
Moneda del descuento fijo
durationenum

Duración del descuento para suscripciones

Allowed values:
expires_atdatetime or null

Fecha de expiración

statusstring

Estado del cupón