Saltar al contenido principal

/plan/{plan_id}/suspension

Creación de un periodo de suspensión​

(POST /plan/<plan_id>/suspension)

Permite la creación de un periodo de suspensión para un plan existente. También permite poder programar periodos de suspensión a futuro.

Si no se especifica ninguna fecha de finalización del periodo, se creará un periodo de suspensión indefinido el cual entrará en vigor según la fecha de inicio especificada y finalizará mediante una desactivación manual del periodo de suspensión.

Si se especifica el numero de cuotas que se debe suspender, se creara un periodo de suspensión con limitación de cuotas, el cual se suspenderá el numero de cuotas indicado y volverá a activarse el plan cuando el numero de cuotas suspendidas sea superado. Cabe destacar que cada plan puede tener una periodicidad distinta, por lo tanto, cuando se crea un periodo de suspensión con limitación de cuotas el tiempo por el que el plan quedará suspendido variará depediendo de la periodicidad del plan. Ejemplo: si el plan tiene una periodicidad mensual y se supende por dos cutotas,este quedara suspendido por un periodo de dos meses, en cambio si un plan tiene priodicidad trimestral y se suspende por dos cuotas, su suspensión total sera de seis meses.

La creación de suspensiones no tiene limitaciones salvo el crear periodos de suspensión con fecha de inicio anterior a la fecha actual.

Cuerpo de la petición​

  • suspended_at(string): Fecha en la cual el periodo de suspensión entrará en vigor. 2016-01-01
    • restricciones:
      • formato: yyyy-mm-dd
      • valor por defecto: día actual
      • valor mínimo: mayor o igual al día actual
  • resumed_at(string): Fecha en la cual finalizará el periodo de suspensión. 2016-03-01
    • restricciones:
      • formato: yyyy-mm-dd
      • valor mínimo: mayor que el campo suspended_at
  • fees(integer): Número de cuotas a suspender.
    • restricciones:
      • valor por defecto: ""
      • valor mínimo: 1
  • description(string): Breve descripción del motivo de la suspensión. Suspensión por petición del cliente
    • restricciones:
      • valor por defecto: ""
      • patrón: [\w-\s]
      • longitud mínima: 6
      • longitud máxima: 256

Ej. periodo de suspensión indefinido​

{
  "key": "{{api-key}}",
  "resource": "{{resource-key}}",
  "nonce": "1234567890",
  "mode": "sha256",
  "payload": {
    "suspended_at": "2016-01-01"
  }
}

Ej. periodo de suspensión con fecha fin​

{
  "key": "{{api-key}}",
  "resource": "{{resource-key}}",
  "nonce": "1234567890",
  "mode": "sha256",
  "payload": {
    "suspended_at": "2016-01-01",
    "resumed_at": "2016-03-01"
  }
}

Ej. periodo de suspensión con limitación de cuotas​

{
  "key": "{{api-key}}",
  "resource": "{{resource-key}}",
  "nonce": "1234567890",
  "mode": "sha256",
  "payload": {
    "suspended_at": "2016-01-01",
    "fees": 3
  }
}

Respuesta - success​

  • suspension_id(string): Identificador de la suspensión necesario para realizar acciones sobre él.
  • active(bool): Indica si la suspensión se encuentra activa ,es decir , si el plan está suspendido o no.
{
  "uuid": "134b493f-b267-43c7-a674-a33b2f2b2cf3",
  "payload": {
    "suspension_id": "c0535e4be2b79ffd93291305436bf889314e4a3faec05ecffcbb7df31ad9e51a",
    "description": "suspension by client",
    "suspended_at": "2016-08-22",
    "resumed_at": "2016-10-22",
    "active": false
  },
  "description": "suspension added successfully",
  "code": "0",
  "type": "success",
  "detail": "suspension_added",
  "request_id": null
}