Saltar al contenido principal
POST
Asociar promoción al plan
Asocia una promoción existente a un plan. Después, las suscripciones del plan pueden recibir la promoción cuando se crean o se actualizan. La asociación define cuántos cobros cubre el descuento (cycles) y qué efecto tiene una pausa sobre él (on_pause). Consulta Promociones en planes de suscripción. La respuesta, y cada elemento de la lista promotions del plan, muestra los campos promotion_id, name, type, status, cycles, on_pause y attached_at de la asociación. type es el modo de canje de la promoción: AUTOMATIC (se aplica sola cuando se crea una suscripción en el plan) o CODE (se aplica solo cuando el comercio envía su código).
Las asociaciones no se editanPara cambiar cycles o on_pause, elimina la asociación con Eliminar promoción de un plan y vuelve a asociar la promoción. Eliminar una asociación no cambia las suscripciones que ya tienen la promoción.

Errores

Consulta Códigos de error de promociones de suscripción para ver todos los motivos.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Encabezados

X-Account-Code
string
requerido

El account_id que se encuentra en tu Yuno Dashboard (UUID). Obligatorio: si lo omites, se devuelve 400 BAD_REQUEST ("Invalid x-account-code header.").

Parámetros de ruta

plan_id
string
requerido

El identificador único del plan.

Cuerpo

application/json
promotion_id
string
requerido

El ID de una promoción existente (UUID).

cycles
integer
requerido

El número de cobros que cubre el descuento. Mínimo 1.

Rango requerido: x >= 1
on_pause
enum<string>
predeterminado:KEEP

Qué hace una pausa con la promoción una vez que se aplica a una suscripción. KEEP (predeterminado) conserva sus ciclos restantes para cuando la suscripción se reanude. END termina la promoción con end_reason PAUSE.

Opciones disponibles:
KEEP,
END

Respuesta

  1. La promoción se asocia al plan.
promotion_id
string
name
string
type
enum<string>

El modo de canje de la promoción. Las promociones AUTOMATIC se aplican solas cuando se crea una suscripción en el plan. Las promociones CODE se aplican cuando el comercio envía el código.

Opciones disponibles:
AUTOMATIC,
CODE
status
string

ENABLED cuando se crea la asociación.

cycles
integer
attached_at
string<date-time>
on_pause
enum<string>

Qué hace una pausa con la promoción una vez que se aplica a una suscripción.

Opciones disponibles:
KEEP,
END