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."
    }
  }
}

Output

OK - Contract cancelled.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
contractId	string	The contract identifier.
status	string	The contract status after the operation (active, scheduled, or cancelled). One of: "active", "scheduled", "cancelled".

Raw JSON schema

{
  "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"
      ]
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.

Aliases: cancelcontract