Skip to main content

/plan/{plan_id}/suspension/{suspension_id}

Query a Suspension​

(GET /plan/<plan_id>/suspension/<suspension_id>)

Query the configuration of the specified suspension period.

URL Parameters​

  • plan_id (string, required): Identifier of the plan provided at the time of creation.
  • suspension_id (string, required): Identifier of the suspension period provided at the time of creation.

Response - success​

{
  "request_id": null,
  "type": "success",
  "code": "0",
  "uuid": "46ec9a89-79c4-4c15-b876-35a3f0206879",
  "detail": "suspension_found",
  "description": "suspension has been retrieved",
  "payload": {
    "suspension_id": "c0535e4be2b79ffd93291305436bf889314e4a3faec05ecffcbb7df31ad9e51a",
    "description": "suspension by client",
    "suspended_at": "2016-08-22",
    "resumed_at": "2016-10-22",
    "active": false
  }
}