Saltar al contenido
Facturador

Editar plan

PUT /api/subscriptions/plans/{subscription_plan_id}

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

Edita un plan. Edición parcial: los campos que no envías conservan su valor (también acepta PATCH). Si envías items, reemplazan a todos los productos del plan.

Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.

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

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
subscription_plan_id integer Sí Id del plan.

Cuerpo (JSON):

Campo Tipo Obligatorio Descripción / valores permitidos
name string (máx. 255) No Nombre del plan.
description string (máx. 255) No Descripción.
cat_period_id integer No Periodicidad: id de Listar periodos (1 mensual, 2 anual, 3 diario, 4 semanal, 5 quincenal, 6 bimestral, 7 trimestral, 8 semestral).
unlimited boolean No true = plan ilimitado (sin cantidad de periodos). Por defecto false.
quantity_period integer (1 a 1000) No Cantidad de cobros. Se ignora en un plan ilimitado.
trial_days integer (0 a 365) No Días de prueba gratis. 0 o null = sin prueba.
status boolean No Activo. Por defecto true.
currency_type_id string No Moneda (PEN, USD). Por defecto PEN.
items array (1 a 50) No Productos que se cobran cada periodo.
items[].item_id integer No Id del producto o servicio.
items[].quantity number (> 0) No Cantidad.
items[].unit_price number (≥ 0) No Precio de venta unitario. Si es gravado, incluye IGV.
items[].affectation_igv_type_id string No 10 gravado (por defecto, o la afectación de venta del producto), 20 exonerado, 30 inafecto.
items[].apply_in_period string No all = se cobra en todos los periodos (por defecto). first = solo en el primer cobro (solo planes ilimitados).

Reglas:

  • Los importes de cada producto y los totales del plan los calcula el servidor desde quantity, unit_price y la afectación (IGV 18%).
  • Al menos un producto debe tener apply_in_period: all. first solo se admite en planes ilimitados.
  • Los cambios del plan no modifican las suscripciones existentes: cada suscripción guarda el monto y los productos del plan al momento de suscribirse.

Errores:

  • 403 si el usuario no es administrador.
  • 404 si el registro no existe.
  • 422 {success: false, message: {campo: [errores]}} si falla la validación de campos.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
subscription_plan_id ruta sí 3

Cuerpo

Content-Type: application/json

{
  "name": "Plan Mensual Gold Plus",
  "items": [
    {
      "item_id": 845,
      "quantity": 1,
      "unit_price": 129
    },
    {
      "item_id": 912,
      "quantity": 1,
      "unit_price": 30,
      "affectation_igv_type_id": "20",
      "apply_in_period": "all"
    }
  ]
}

Respuestas

200 — Editado

{
  "success": true,
  "data": {
    "id": 3,
    "name": "Plan Mensual Gold Plus",
    "description": "Acceso ilimitado al gimnasio y clases grupales",
    "status": true,
    "cat_period_id": 1,
    "period": {
      "id": 1,
      "code": "M",
      "name": "Mensual"
    },
    "unlimited": false,
    "quantity_period": 12,
    "trial_days": 7,
    "currency_type_id": "PEN",
    "total_taxed": 109.32,
    "total_exonerated": 30.0,
    "total_unaffected": 0.0,
    "total_igv": 19.68,
    "total_value": 139.32,
    "total": 159.0,
    "items": [
      {
        "id": 77,
        "item_id": 845,
        "description": "MEMBRESÍA GIMNASIO",
        "internal_id": "MEM-001",
        "quantity": 1.0,
        "unit_price": 118.0,
        "unit_value": 100.0,
        "affectation_igv_type_id": "10",
        "total_value": 100.0,
        "total_igv": 18.0,
        "total": 118.0,
        "apply_in_period": "all"
      }
    ],
    "subscriptions_count": 24,
    "can_delete": false,
    "checkout_url": "https://empresa.dominio/full_suscription/plans/3"
  },
  "message": "Plan editado con éxito"
}

404 — No existe

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

403 — Usuario no administrador

{
  "success": false,
  "message": "Solo un administrador puede gestionar este recurso."
}

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.