Skip to main content

/plan/{plan_id}

Remove Plan​

(DELETE /plan/<plan_id>)

Remove the plan, preventing its resumption; however, operations associated with it can still be queried.

Request Body​

  • plan_id (string, required): Identifier of the plan to be deleted 5976f935c928580001cc5dd7

Example

{
  "key": "{{api-key}}",
  "resource": "{{resource-key}}",
  "nonce": "1234567890",
  "mode": "sha256",
  "payload": {
    "plan_id": "5976f935c928580001cc5dd7"
  }
}

Response - success​

{
  "type": "success",
  "detail": "plan_deleted",
  "description": "Plan was deleted successfully",
  "request_id": null,
  "payload": {
    "customer": {
      "taxid": "1254447895Q",
      "name": "Jhon Doe Sullivan",
      "reference": "client-123465"
    },
    "plan_id": "59841504cc3ac117c53cf4d8",
    "name": "12654-plystation-subscription",
    "external_id": "external-refrernce-123456",
    "method": {
      "type": "card",
      "token": "card-token-123456"
    },
    "fees": 12,
    "expired_at": null,
    "resource": "resource-example-key",
    "description": "Annual playstation subscription",
    "currency": "EUR",
    "deleted_at": "2016-08-04",
    "custom_data": {
      "dummy": "foo"
    },
    "periodicity": "1m",
    "start_date": "2016-08-04",
    "amount": 100
  },
  "uuid": "42f0cc5d-2c67-4cc4-b393-aa0434e438bd",
  "code": "0"
}