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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The customer (tenant) the contract is created for.

Body Params

Contract create/update payload. Full field-level validation is applied server-side.

string
required
date-time
required
date-time | null
string
enum
required
Allowed:
boolean
Defaults to true

Whether DoiT generates invoices for this contract. Disabling suppresses invoice generation from that point forward while billing calculations and pipeline outputs continue. Omitting the field leaves invoicing enabled.

string

Required for an end-customer contract with doitInvoicingEnabled set to true; optional otherwise.

string

Required for an end-customer contract with doitInvoicingEnabled set to true; optional otherwise.

billingProfile
object

The billing profile (name, country, state, city, address, zip). Required for an end-customer contract with doitInvoicingEnabled set to true; optional otherwise.

managementAccounts
array of strings
managementAccounts
billingRules
array of objects
billingRules
priceBooks
array of objects
priceBooks
customLineItems
array of objects
customLineItems
string

ID of a contract template owned by the authenticated tenant. When specified, the template's billing rules, price books, and custom line items are copied onto the new contract. Mutually exclusive with billingRules, priceBooks, and customLineItems in the request body.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json