API de suscripciones

La aplicación cliente dispone de tres endpoints para trabajar con suscripciones: uno para suscribirse, otro para cancelar una suscripción y otro para obtener las suscripciones activas del usuario actual.

Todos los endpoints actúan en nombre del usuario autorizado: la suscripción siempre queda vinculada al token con el que se hizo la solicitud.

Suscripción

Crea una nueva suscripción del usuario actual al marcador indicado.

El comportamiento depende del tipo de cuenta de pago vinculada a la suscripción en la configuración del módulo (se abre en una pestaña nueva):

• stripe, midtrans: se crea un registro de la suscripción y se devuelve un enlace de pago. La suscripción se activa cuando el proveedor completa el cobro correctamente.
• custom: la suscripción se crea y se considera activa de inmediato. No se devuelve ningún enlace de pago; el administrador registra el pago manualmente desde la tarjeta del usuario (se abre en una pestaña nueva).

Cancelación de suscripción

Cancela de inmediato la suscripción activa del usuario.

El comportamiento depende del tipo de cuenta de pago:

• stripe, midtrans: la suscripción se cancela a través de la API del proveedor. Los cobros automáticos se detienen y el estado de la suscripción pasa a canceled.
• custom: la cancelación a través de la API no está disponible. Solo el administrador puede cancelar estas suscripciones, desde la tarjeta del usuario (se abre en una pestaña nueva).

info

Si intenta cancelar una suscripción custom a través de la API, obtendrá un error. Es intencionado: las suscripciones manuales las gestiona el administrador, porque sus pagos se realizan fuera del sistema.

Obtención de suscripciones activas

Devuelve un array con los marcadores de las suscripciones activas del usuario actual.

Una suscripción se considera activa si:

• Se creó correctamente.
• Su período actual aún no ha vencido.
• No se ha cancelado (canceled).

Cuando una suscripción vence o se cancela, su marcador desaparece automáticamente de la lista. En el cliente, este endpoint sirve para comprobar el acceso al contenido: si el array contiene el marcador de la suscripción necesaria, se concede el acceso.