API · Crear plan recurrente
API v1POST /api/v1/createPlanRepeatQué hace#
Crea un plan de suscripción: frecuencia de cobro, moneda, periodo de prueba, modalidades y webhooks.
Autenticación#
Requiere el token bearer del API en el header Authorization — ver autenticación.
Parámetros#
Key de la integración Tilopay.
Título del plan recurrente.
Descripción del plan.
Frecuencia de cobro.
| Código | Valor |
|---|---|
| 1 | Diario |
| 2 | Semanal |
| 3 | Mensual |
| 4 | Anual |
| 5 | Quincenal |
| 6 | Bimestral |
| 7 | Trimestral |
| 8 | Cuatrimestral |
| 9 | Semestral |
Código de moneda en formato ISO 4217.
Monto por pago inicial.
Activa el periodo de prueba gratis: 0 no, 1 sí.
Días del periodo de prueba gratis.
Cantidad de reintentos para cobros fallidos.
Array de modalidades del plan.
Campo opcional. URL de agradecimiento propia del comercio; debe soportar el método GET.
Campo opcional. URL del webhook, por método POST, que recibe el callback en el cuerpo de la solicitud cuando un cliente adquiere una suscripción de forma exitosa. Ejemplo de los datos enviados: {'id_plan' : 1, 'email' : 'email@email.com', 'modality' : 'ModalityName', 'amount' : 25, 'frequency' : '', 'coupon' : '5HT5W8YT', 'free_trial' : 1, 'next_payment_date' : '2023-02-25'}
Campo opcional. URL del webhook, por método POST, que recibe el callback en el cuerpo de la solicitud cuando el cargo al cliente se realiza con éxito. Ejemplo de los datos enviados: {'id_plan' : 1, 'email' : 'email@email.com', 'amount' : 25, 'auth' : '123456', 'orderNumber' : 'PRE123456'}
Campo opcional. URL del webhook, por método POST, que recibe el callback en el cuerpo de la solicitud cuando un pago falla. Ejemplo de los datos enviados: {'id_plan' : 1, 'email' : 'email@email.com', 'amount' : 25}
Campo opcional. URL del webhook, por método POST, que recibe el callback en el cuerpo de la solicitud cuando un cliente cancela la suscripción a uno de sus planes. Ejemplo de los datos enviados: {'id_plan' : 1, 'email' : 'email@email.com', 'expire' : '2023-02-25'}
Campo opcional. URL del webhook, por método POST, que recibe el callback en el cuerpo de la solicitud cuando un cliente reactiva la suscripción a uno de sus planes. Ejemplo de los datos enviados: {'id_plan' : 1, 'email' : 'email@email.com', 'next_payment_date' : '2023-02-25'}
Fecha de finalización del plan recurrente, formato d-m-Y (por ejemplo 25-09-2022). Si el plan no tiene fecha de fin, se envía vacío.
En 1 agrega al correo de notificación el texto de notify_detail y notify_note. En 0 no agrega ninguno de los dos.
Texto del detalle en español. Opcional si notify es 0.
Texto del detalle en inglés. Opcional si notify es 0.
Texto de las notas en español. Opcional si notify es 0.
Texto de las notas en inglés. Opcional si notify es 0.
Ejemplo de request#
Los valores <...> son marcadores: reemplazalos por tus credenciales y datos.
{
"key": "<api_key>",
"title": "Plan title",
"description": "Plan description",
"frecuency": 1,
"currency": "USD",
"first_amount": 0,
"trial": 0,
"trial_days": 0,
"attempts": 1,
"modality": [
{
"title": "Basic",
"amount": 10
},
{
"title": "Premium",
"amount": 30
}
],
"thanks_url": "",
"webhook_subscribe": "",
"webhook_payment": "",
"webhook_rejected": "",
"webhook_unsubscribe": "",
"webhook_reactive": "",
"end_at": "25-10-2023",
"notify": 0,
"notify_detail_es": "",
"notify_detail_en": "",
"notify_note_es": "",
"notify_note_en": ""
}Respuesta#
{
"type": "200",
"status": 1,
"message": "Success",
"id": 624,
"url": "https://app.tilopay.com/link/TmpJMHwx"
}Para interpretar una respuesta que no es de éxito, ver cómo leer una respuesta de error.
Última verificación: 2026-08-29 · Responsable: equipo-integraciones