API · Listar planes recurrentes

API v1

POST /api/v1/getPlansRepeat

Qué hace#

Devuelve los planes recurrentes del comercio.

Autenticación#

Requiere el token bearer del API en el header Authorization — ver autenticación.

Parámetros#

keystringrequerido#

Key de la integración Tilopay.

Ejemplo de request#

Los valores <...> son marcadores: reemplazalos por tus credenciales y datos.

{
  "key": "<api_key>"
}

Respuesta#

{
  "type": "200",
  "message": "Success",
  "data": [
    {
      "id": 276,
      "title": "Plan test 1",
      "description": "Plan",
      "frequency": 1,
      "currency": "USD",
      "first_amount": "0.00",
      "trial": 0,
      "trial_days": 0,
      "attempts": 1,
      "status": 1,
      "thanks_url": "",
      "return_url": null,
      "webhook_subscribe": "",
      "webhook_payment": "",
      "webhook_rejected": "",
      "webhook_unsubscribe": "",
      "webhook_reactive": "",
      "modality": [
        {
          "id": 131,
          "title": "Basic",
          "amount": "10.00"
        }
      ],
      "end_at": "2022-10-25"
    }
  ]
}

Los montos (first_amount, amount) vienen como cadena. Cuando un webhook no está configurado, su campo viene como cadena vacía, mientras que return_url viene como null: dos representaciones del mismo "no configurado" en el mismo objeto — ver convenciones de las respuestas.

Para interpretar una respuesta que no es de éxito, ver cómo leer una respuesta de error.

Última verificación: 2026-09-02 · Responsable: equipo-integraciones

Ver como Markdown crudo