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

Referencia API Coupons

Actualizar un cupón

PUT

https://app.recurrente.com/api/coupons/:id

PUT

/api/coupons/:id

$ curl -X PUT https://app.recurrente.com/api/coupons/id \
>      -H "X-SECRET-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "coupon": {}
> }'

1 {
2   "id": "coup_ugwoxcp4",
3   "name": "VERANO25",
4   "discount_mode": "code",
5   "display_name": "string",
6   "amount_off_in_cents": 1500,
7   "percent_off": 1.1,
8   "automatically_applies": false,
9   "max_redemptions": 1,
10   "times_redeemed": 0,
11   "currency": "GTQ",
12   "duration": "once",
13   "expires_at": "2024-01-15T09:30:00Z",
14   "status": "active"
15 }

Actualiza un cupón existente.

Was this page helpful?

Archivar un cupón

Authentication

X-SECRET-KEYstring

Tu llave secreta de API

Path parameters

idstringRequired

ID del cupón

Request

This endpoint expects an object.

couponobjectRequired

Response

Cupón actualizado

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

Errors

400

Bad Request Error