Planes

Crea planes reutilizables con precio, frecuencia, prueba gratis y precios introductorios. Para un plan de un solo uso, defínelo al crear la suscripción.

¿Primera vez con este módulo? Sigue la guía Cobrar suscripciones.

Métodos

Plan

Así se ve el objeto que devuelven los métodos de este módulo.

Campo	Tipo	Descripción
`id`	string	Identificador, empieza por `plan_`
`url`	string	Checkout público del plan
`name`	string	Nombre visible
`slug`	string	Identificador legible, único en el proyecto
`description`	string \| null	Descripción opcional
`currency`	"COP" \| "USD"	Moneda de los cobros
`interval`	PlanInterval	`weekly`, `quincenal`, `monthly`, `quarterly`, `semiannual` o `annual`
`termCycleCount`	number \| null	Cobros antes de terminar; `null` es sin fin
`phases`	PlanPhase[]	Fases de precio: `type`, `amount`, `discountPercent` y `duration`
`metadata`	Record<string, string>	Tus datos propios
`source`	"manual" \| "api"	Origen
`livemode`	boolean	`true` si se creó con una llave live
`createdAt`	string	Fecha de creación
`updatedAt`	string	Fecha de la última edición

Crear un plan

landapay.plans.create(params, options?)

Para un precio simple usa amount y, si quieres, trialDays. Para precios por etapas usa phases: cada fase lleva su duration salvo la última, que se repite hasta el final.

Parámetros

Campo	Tipo	Descripción
`name`obligatorio	string	Nombre visible
`interval`obligatorio	PlanInterval	Frecuencia de cobro
`amount`	number	Precio por ciclo en centavos
`trialDays`	number	Días de prueba gratis; requiere `amount`
`phases`	PlanPhaseParams[]	Alternativa a `amount`: fases `trial` o `priced` con `amount` o `discountPercent`
`currency`	"COP" \| "USD"	`COP` por defecto
`termCycleCount`	number \| null	Cobros antes de terminar; sin enviarlo es sin fin
`description`	string \| null	Descripción opcional
`slug`	string \| null	Se genera del nombre si no lo envías
`metadata`	Record<string, string \| number \| boolean \| null>	Hasta 50 pares llave/valor. Al actualizar se combina con la actual; `null` en una llave la borra
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<Plan>

EjemploTypeScript

1// Precio simple con 14 días gratis2const pro = await landapay.plans.create({3  name: "Plan Pro",4  interval: "monthly",5  amount: 4_990_000,6  trialDays: 14,7});8 9// Dos meses al 50 % y luego precio completo10const promo = await landapay.plans.create({11  name: "Plan Pro promo",12  interval: "monthly",13  phases: [14    { type: "priced", discountPercent: 50, duration: { unit: "month", count: 2 } },15    { type: "priced", amount: 4_990_000 },16  ],17});

Obtener un plan

landapay.plans.retrieve(id, options?)

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del plan (`plan_...`)
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<Plan>

EjemploTypeScript

const plan = await landapay.plans.retrieve("plan_PLANCODE23456789");

Actualizar un plan

landapay.plans.update(id, params, options?)

Acepta los campos de create, todos opcionales. Enviar amount o phases reemplaza todas las fases. Las suscripciones existentes conservan el precio con el que se suscribieron.

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del plan (`plan_...`)
`params`obligatorio	PlanUpdateParams	Campos a cambiar
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<Plan>

EjemploTypeScript

1await landapay.plans.update("plan_PLANCODE23456789", {2  amount: 5_990_000,3});

Eliminar un plan

landapay.plans.delete(id, options?)

Solo se puede eliminar un plan sin suscripciones vigentes.

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del plan (`plan_...`)
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<{ id: string; object: "plan"; deleted: true }>

EjemploTypeScript

await landapay.plans.delete("plan_PLANCODE23456789");