Crear un cupón

POST

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

Crea un nuevo cupón de descuento. Puedes especificar un descuento fijo (amount_off_in_cents) o un porcentaje (percent_off), pero no ambos.

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.

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`.

Request

This endpoint expects an object.

couponobjectRequired

Response

Cupón creado exitosamente

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

Errors

400

Bad Request Error

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

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	}