Suscripción actual

Este endpoint permite obtener información detallada sobre la suscripción actual del usuario en la API de Factus. Es útil para conocer el estado de la suscripción, la cantidad de documentos disponibles y la fecha de vencimiento.

Método: GET

Endpoint

Pruebas

https://api-sandbox.factus.com.co/v1/subscriptions/current

Producción

https://api.factus.com.co/v1/subscriptions/current

Nota

Es necesario el envío del token de acceso <access_token> para hacer uso de este endpoint. Para ver cómo generar el token, vea Cómo generar un token de acceso .
Recuerde: El token de acceso caduca cada hora.

Encabezados de la Solicitud

Para realizar la solicitud es necesario incluir los siguientes encabezados:

Encabezado	Valor	Descripción
Content-Type	application/json	Indica que los datos se envían en formato JSON.
Authorization	Bearer <token_de_acceso>	Token de autenticación necesario para acceder al recurso. Ver Cómo generar token
Accept	application/json	Indica que la respuesta debe estar en formato JSON.

Nota: Reemplaza <token_de_acceso> con el token proporcionado tras autenticarte.

Response

Campo	tipo	Descripción
total_documents	int	Cantidad total de documentos adquiridos en la suscripción.
documents_used	int	Número de documentos que ya han sido utilizados.
documents_remaining	int	Cantidad de documentos aún disponibles para su uso.
subscription_start_date	string (ISO 8601)	Fecha de inicio de la suscripción (YYYY-MM-DDTHH:MM:SSZ).
subscription_expiration_date	string (ISO 8601)	Fecha de vencimiento de la suscripción (YYYY-MM-DDTHH:MM:SSZ).
subscription_is_expired	boolean	Indica si la suscripción ha expirado (true o false).

---

Ejemplo de respuesta

status 200

{
  "status": "OK",
  "message": "Solicitud exitosa",
  "data": {
    "total_documents": 3000,
    "documents_used": 0,
    "documents_remaining": 3000,
    "subscription_days_to_expires": 349,
    "subscription_start_date": "2025-03-01T00:00:00Z",
    "subscription_expiration_date": "2026-03-01T00:00:00Z",
    "subscription_is_expired": false
  }
}