Saltar al contenido principal
Migo Docs

Visión general de Pagos Recurrentes

El motor de recurrencia de Migo se construye alrededor de tres entidades:

┌─────────┐ subscribes ┌──────────────┐ charges ┌──────────┐
│ Plan │─────────────►│ Subscription │──────────►│ Charge │
│ │ │ │ │ │
│ amount │ │ client │ │ amount │
│ period │ │ cardId │ │ state │
│ trial │ │ status │ │ │
└─────────┘ └──────────────┘ └──────────┘
  • Un Plan define el dinero: cuánto, cada cuánto, con o sin prueba.
  • Una Subscription asocia un plan con un cliente (tarjetahabiente) y un método de pago por defecto.
  • Un Charge es un evento de facturación individual — automático (programado) o manual (bajo demanda).

Qué se cobra y cuándo

EventoDisparado porEndpoint
Creación de suscripciónPOST /v1/subscriptions/verify-card con shouldCreateSubscription: true (ligado a una transacción existente)Interno
Cobro programadoCrons de Migo según la cadencia del planAutomático
Cobro bajo demandaTú llamas POST /v1/subscriptions/charges (ingesta por lote)Manual, asíncrono
Cobros masivosTú llamas POST /v1/subscriptions/charges/upload-csvManual, asíncrono

Todos los endpoints de la Middleware API

EndpointPropósito
POST /v1/plansCrea un plan
PUT /v1/plansActualiza un plan
GET /v1/plans/listLista planes
GET /v1/plans/{planId}/client/{client}/detailDetalle del plan para un cliente específico
PUT /v1/subscriptionsActualiza el email de notificación de una suscripción
GET /v1/subscriptionsLista suscripciones (requiere userId + clientId)
GET /v1/subscriptions/detail/{subUid}Detalle por id de suscripción
DELETE /v1/subscriptions/{subUid}Cancela una suscripción
POST /v1/subscriptions/payment-methodsAgrega un método de pago
DELETE /v1/subscriptions/payment-methodsElimina un método de pago
PUT /v1/subscriptions/payment-methods/set-defaultCambia la tarjeta por defecto
POST /v1/subscriptions/verify-cardVerifica una tarjeta (y opcionalmente crea una suscripción)
GET /v1/subscriptions/payment-historyHistorial de cobros
POST /v1/subscriptions/chargesCobro bajo demanda (ingesta por lote)
POST /v1/subscriptions/charges/upload-csvCobros masivos

Todas las llamadas requieren Authorization: Bearer <middleware-jwt> — consulta Autenticación.