Antes de comenzar
Asegúrate de tener:Credenciales de API
Credenciales API válidas y token de acceso para la autenticación.
Configuración de la cuenta
Configuración adecuada de la cuenta para el país de destino y verificación de la empresa.
Lista blanca de IP
Incluye en la lista blanca las direcciones IP de tus servidores para el acceso a la API.
Endpoint del webhook
Configura una URL de webhook para recibir notificaciones de pago.
Paso 1: Crea un plan de suscripción
Para crear un nuevo plan de suscripción, envía una solicitudPOST al endpoint Crear un plan de suscripción.
Parámetros clave de la solicitud
La solicitud requiere varios objetos clave:Frecuencias de facturación admitidas
A diario
Factura a los clientes todos los días. Ideal para servicios con uso diario o suscripciones
a corto plazo.Envía la propiedad
autoRecurring.type con el valor: dayMensual
Facturación mensual recurrente para la mayoría de los productos SaaS, servicios de membresía y
cajas de suscripción.Envía la propiedad
autoRecurring.type con el valor: monthPersonalizado (bajo demanda)
Facturación bajo demanda para escenarios de uso variable. Ideal para servicios de pago por uso o
basados en el uso.Envía la propiedad
autoRecurring.type con el valor: customEjemplo de solicitud
A continuación se muestra un ejemplo que utilizacurl:
curl
Paso 2: Gestionar la respuesta
Respuesta exitosa
Un plan de suscripción creado correctamente devuelve todos los detalles del plan:Campos de respuesta clave
Respuesta de error
Cuando falle la creación del plan de suscripción, recibirás información detallada sobre el error:Paso 3: Seguimiento del estado de la transacción
Tras crear un plan de suscripción, supervisa su estado mediante estos métodos:Webhooks (recomendado)
Recibe notificaciones en tiempo real cuando cambie el estado de la transacción. Más eficiente para entornos de producción.
Endpoint de la API de estado
Consulta el estado de las transacciones mediante programación. Útil para sondear o recuperar notificaciones de webhook perdidas.
Vista del Business Portal
Interfaz visual para el seguimiento de transacciones. Ideal para la supervisión manual y el análisis detallado de las transacciones.
Códigos de estado comunes
Referencia completaConsulta todos los códigos de estado en nuestra documentación sobre el estado de las transacciones.
Probando tu integración
Escenarios de prueba
Verifica que tu integración gestione estos escenarios:- Creación de plan exitosa: Creación de plan estándar con parámetros válidos.
- Estructura de precios escalonada: Creación de múltiples planes con diferentes precios.
- Diversas frecuencias de facturación: Pruebas con planes diarios, mensuales y personalizados bajo demanda.
- Errores de validación: Faltan campos obligatorios, importes no válidos, países no admitidos.
- Asociación de Suscripciones: Probando que los planes se puedan vincular correctamente a las suscripciones.
Próximos pasos
Tras crear un plan de suscripción, es posible que debas realizar acciones adicionales:Crear suscripción con plan
Utiliza el internalId del plan como parámetro planId para crear suscripciones de clientes
con tu nuevo plan.
Actualizar plan de suscripción
Modifica los detalles de un plan existente manteniendo las asociaciones con las suscripciones
activas.

