Contracts

Create contract

Creates a draft contract for the specified customer. Requires the caller to be the direct parent (T1 for a T2-level contract, T2 for a T3-level contract). Write access requires a role without contractsReadOnly; user API tokens must include the matching permission in their scope.

post/customers/{customerID}/contracts

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/customers/{customerID}/contracts
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

customerIDstring required

The customer (tenant) the contract is created for.

Request body

namestring required
startDatestring date-time required
endDatestring date-time nullable
renewalPolicy'auto' | 'manual' | 'fixed' required
invoicesEmailstring email required
contractUpdatesEmailstring email required
billingProfileobject required

The billing profile (name, country, state, city, address, zip).

managementAccountsstring[]
billingRulesobject[]
priceBooksobject[]
customLineItemsobject[]

Response

Created - The contract draft was created.

contractIdstring
versioninteger
statusstring
messagestring
timestampstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.