Saltar al contenido principal
GET
Obtener plan
Promociones asociadasLa respuesta incluye una lista promotions con las promociones asociadas al plan, cada una con el número de cycles que cubre, su comportamiento on_pause, su type (AUTOMATIC o CODE) y su status. El status es ENABLED o DISABLED, leído del motor de promociones. Si el motor no responde, el estado es UNKNOWN. Asocia y elimina promociones con Attach Promotion to Plan y Remove Promotion from Plan. Consulta Promociones en planes de suscripción.

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.

Respuesta

200

id
string
account_id
string
name
string
description
string | null
merchant_reference
string
status
string
base_amount
object
frequency
object
country_prices
object[]
allowed_payment_methods
string[]
metadata
object[]
phases
object[]
created_at
string
updated_at
string
account_ids
string[]

Todas las cuentas en las que está disponible el plan. Siempre se devuelve; contiene account_id cuando el plan está limitado a una sola cuenta.

retries
object | null

La configuración de reintentos que heredan las suscripciones creadas a partir de este plan. null cuando el plan no define ninguna.

retry_split
object | null

La configuración de la división A/B de Smart Retries asociada a este plan. null cuando no hay ninguna definida.

meters
object[]

Los precios medidos asociados a este plan. Vacío cuando el plan no tiene precios basados en el uso; consulta Attach Meter to Plan.

promotions
object[]

Las promociones asociadas a este plan. Vacío cuando no hay ninguna asociada. Consulta Promociones en planes de suscripción.