update-contract

dci update-contract customerID contractID

Creates a new version of the contract. The contract type is immutable and cannot be changed by an update.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "description": "Contract create/update payload. Full field-level validation is applied server-side.",
  "required": [
    "name",
    "startDate",
    "renewalPolicy",
    "invoicesEmail",
    "contractUpdatesEmail",
    "billingProfile"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "renewalPolicy": {
      "type": "string",
      "enum": [
        "auto",
        "manual",
        "fixed"
      ]
    },
    "invoicesEmail": {
      "type": "string",
      "format": "email"
    },
    "contractUpdatesEmail": {
      "type": "string",
      "format": "email"
    },
    "billingProfile": {
      "type": "object",
      "description": "The billing profile (name, country, state, city, address, zip)."
    },
    "managementAccounts": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "billingRules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "priceBooks": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "customLineItems": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Responses

200 (application/json)

OK - New contract version created.

{
  "type": "object",
  "description": "The result of creating a contract or contract version.",
  "properties": {
    "contractId": {
      "type": "string"
    },
    "version": {
      "type": "integer"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  }
}

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: update-contract, updatecontract