Skip to main content

cancel-contract 

dci cancel-contract customerID contractID

Cancels (deactivates) a contract. Active contracts cannot be deleted; cancel is the terminal operation.

Request​

Content-Type: application/json

Schema​

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Optional cancellation reason."
    }
  }
}

Responses​

200 (application/json)​

OK - Contract cancelled.

{
  "type": "object",
  "description": "Result of an activate or cancel operation.",
  "properties": {
    "contractId": {
      "type": "string",
      "description": "The contract identifier."
    },
    "status": {
      "type": "string",
      "description": "The contract status after the operation (`active`, `scheduled`, or `cancelled`).",
      "enum": [
        "active",
        "scheduled",
        "cancelled"
      ]
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: cancel-contract, cancelcontract