Skip to navigation

Obtener un cupón

Obtén los detalles de un cupón específico.

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.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

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.

Path parameters

idstringRequired

ID del cupón

Response

Detalles del cupón

idstringOptional

ID único del cupón

namestringOptional

Nombre o código del cupón

discount_modeenumOptional
Tipo de descuento
Allowed values:
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

Allowed values:
duration_in_paymentsinteger or nullOptional

Cuántos pagos de la suscripción llevan el descuento (solo con duration = repeating)

minimum_amount_in_centsinteger or nullOptional

Compra mínima en centavos, sobre los productos a los que aplica (sin envío)

once_per_customerbooleanOptional

Si cada cliente puede usar el cupón una sola vez

product_idslist of stringsOptional

IDs de los productos a los que aplica. Vacío si aplica a todos.

starts_atdatetime or nullOptional

Desde cuándo se puede usar el cupón

expires_atdatetime or nullOptional

Fecha de expiración

statusstringOptional

Estado del cupón