Saltar al contenido
Facturador

Cambiar estado de la suscripción

POST /api/subscriptions/{subscription_id}/status

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Activa, pausa o cancela la suscripción.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor). Los registros de suscripciones son de toda la empresa: un vendedor ve y gestiona los mismos que el administrador.

Formato de respuesta: estándar {success, data, message?} (registro único).

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
subscription_id integer Sí Id de la suscripción.

Cuerpo (JSON):

Campo Tipo Obligatorio Descripción / valores permitidos
status string Sí authorized (activar/reanudar), paused (pausar) o cancelled (cancelar).

Reglas:

  • paused: la suscripción sigue generando órdenes de cobro. Para dejar de cobrar, cancélala.
  • cancelled: deja de generar órdenes. Es definitivo: una suscripción cancelada o finalizada ya no cambia de estado.
  • Las órdenes ya creadas no cambian: si no se van a cobrar, recházalas.
  • Enviar el estado actual no hace cambios y responde 200.

Errores:

  • 404 si el registro no existe.
  • 422 {success: false, message: {campo: [errores]}} si falla la validación de campos. (estado no permitido; finished lo asigna solo el sistema).
  • 409 si la suscripción está cancelada o finalizada.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
subscription_id ruta sí 48

Cuerpo

Content-Type: application/json

{
  "status": "paused"
}

Respuestas

200 — Actualizado

{
  "success": true,
  "data": {
    "id": 48,
    "status": "paused",
    "status_description": "Pausada",
    "plan_id": 3,
    "plan_name": "Plan Mensual Gold",
    "customer_id": 1520,
    "customer": {
      "id": 1520,
      "name": "MARÍA FERNANDA QUISPE ROJAS",
      "number": "45879632",
      "identity_document_type_id": "1",
      "email": "maria.quispe@correo.pe"
    },
    "cat_period_id": 1,
    "period_name": "Mensual",
    "unlimited": false,
    "quantity_period": 12,
    "orders_created": 1,
    "start_date": "2026-11-14",
    "end_date": "2027-10-14",
    "trial_start_date": "2026-11-07",
    "trial_days": 7,
    "currency_type_id": "PEN",
    "total": 118.0,
    "created_at": "2026-11-07 10:15:32"
  },
  "message": "Estado de suscripción actualizado con éxito"
}

409 — Cancelada

{
  "success": false,
  "message": "La suscripción está cancelada y ya no cambia de estado."
}

404 — No existe

{
  "success": false,
  "message": "Registro no encontrado."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.