Skip to main content
Esta guía explica cómo implementar y gestionar suscripciones utilizando la API de Confío.

Descripción general

La API de Suscripciones te permite crear planes de facturación recurrente y asignarlos a tus clientes. El sistema maneja:
  • Gestión de planes (creación, actualización, archivado)
  • Asignaciones a clientes
  • Procesamiento de cobros recurrentes
  • Reintentos de pago
  • Gestión de estados

Conceptos Clave

Planes de Suscripción

Un plan define los términos de facturación:
  • Monto: Cuánto cobrar
  • Frecuencia: Con qué frecuencia cobrar (Semanal/Mensual/Anual)
  • Intervalo: Número de períodos entre cobros (ej. cada 2 meses)
  • Período de Prueba: Días gratuitos opcionales antes del primer cobro

Asignaciones de Plan

Una asignación vincula a un cliente con un plan. Rastrea:
  • Estado actual (Activo, Atrasado, etc.)
  • Próxima fecha de cobro
  • Método de pago
  • Historial de cobros

Pasos de Integración

1. Crear un Plan de Suscripción

Primero, define tu oferta creando un plan.
curl -X POST "https://api.confiopagos.com/v1/stores/{storeId}/subscription-plans" \
  -H "Authorization: Bearer CONFIO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Premium Mensual",
    "description": "Acceso a funciones premium",
    "amountCents": 5000000,
    "currencyCode": "COP",
    "billingCycleFrequency": "MONTHLY",
    "billingCycleInterval": 1,
    "trialPeriodDays": 7
  }'

2. Asignar Plan a un Cliente

Crea una asignación para un cliente. Esto genera un enlace de aceptación.
curl -X POST "https://api.confiopagos.com/v1/stores/{storeId}/subscription-plans/{planId}/assignments" \
  -H "Authorization: Bearer CONFIO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriptionPlan": "organizations/{org}/stores/{store}/subscription-plans/{planId}",
    "buyer": {
      "email": "[email protected]",
      "phoneNumber": "+573001234567",
      "firstName": "Juan",
      "lastName": "Perez"
    }
  }'

3. Aceptación del Cliente

El cliente recibe un enlace para:
  1. Validar su identidad (OTP)
  2. Registrar su método de pago (Tarjeta)
  3. Aceptar los términos de la suscripción
Una vez aceptado, la suscripción pasa a estado ACTIVE.

4. Gestionar Suscripciones

Puedes listar y filtrar asignaciones para rastrear a tus suscriptores.
curl -X GET "https://api.confiopagos.com/v1/stores/{storeId}/assignments?status=ACTIVE" \
  -H "Authorization: Bearer CONFIO_ACCESS_TOKEN"