API de Planes - FlowPlans

La clase FlowPlans permite crear planes de suscripción, obtener información de planes, eliminar planes, editar planes y listar planes.

Inicialización

import Flow from '@nicotordev/flowcl-pagos';

const flow = new Flow('tu_api_key', 'tu_secret_key', 'sandbox'); // o 'production'
const plans = flow.plans;

Métodos Disponibles

Crear un plan

plans.create(data: FlowCreatePlanRequest): Promise<FlowCreatePlanResponse>

• Request (FlowCreatePlanRequest):

  • planId: string
  • name: string
  • currency: string (opcional)
  • amount: number
  • interval: 1 | 2 | 3 | 4
  • interval_count: number (opcional)
  • trial_period_days: number (opcional)
  • days_until_due: number (opcional)
  • periods_number``: number (opcional)
  • urlCallback: string (opcional)
  • charges_retries_number``: number (opcional)
  • currency_convert_option: 1 | 2 (opcional)

• Response (FlowCreatePlanResponse):

  • planId: string
  • name: string
  • currency: string
  • amount: number
  • interval: number
  • interval_count: number
  • created: string
  • trial_period_days: number
  • days_until_due: number
  • periods_number``: number
  • urlCallback: string
  • charges_retries_number``: number
  • currency_convert_option: number
  • status: 0 | 1
  • public: 0 | 1

Obtener un plan

plans.get(planId: `string`): Promise<FlowGetPlanResponse>

• Request:

  • planId: string

• Response: FlowGetPlanResponse

Editar un plan

plans.edit(data: FlowEditPlanRequest): Promise<FlowEditPlanResponse>

• Request: FlowEditPlanRequest incluye:

  • planId: string
  • name: string (opcional)
  • currency: string (opcional)
  • amount: number (opcional)
  • interval: 1 | 2 | 3 | 4 (opcional)
  • interval_count: number (opcional)
  • trial_period_days: number (opcional)
  • days_until_due: number (opcional)
  • periods_number``: number (opcional)
  • urlCallback: string (opcional)
  • charges_retries_number``: number (opcional)
  • currency_convert_option: 1 | 2 (opcional)

• Response: FlowEditPlanResponse

Eliminar un plan

plans.delete(planId: `string`): Promise<FlowDeletePlanResponse>

• Request:

  • planId: string

• Response: FlowDeletePlanResponse

Listar planes

plans.list(data: FlowListPlansRequest): Promise<FlowListPlansResponse>

• Request: FlowListPlansRequest incluye:

  • start: number (opcional)
  • limit: number (opcional)
  • filter: string (opcional)
  • status: 0 | 1 (opcional)

• Response: FlowListPlansResponse

Manejo de Errores

Error	Descripción
FlowAPIError	Error general de API de Flow.
FlowAuthenticationError	Error de autenticación.
FlowCreatePlanError	Error al crear un plan.
FlowEditPlanError	Error al editar un plan.
FlowListPlansError	Error al listar los planes.

---

Para información adicional, visita la documentación oficial: Flow.cl API Docs - Payments.

Nota: Implementa siempre control de errores robusto en tu aplicación.