Skip to main content
PATCH
Update a contract

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Input for the contract's terms. Contract-wide: applied across every line item, which is where the period, currency and payment terms are stored.

activationStartDate
string<date-time>

Start of the contract period

activationEndDate
string<date-time>

End of the contract period

currency
string

Contract currency

Maximum string length: 255
netTerms
number

Payment terms in days, e.g. 30 for net 30

Response

The contract's recomputed totals.

Response object

data
ContractSummary · object
required

A contract's pre-publish totals, with a per line item breakdown — read this before publishing, since after publishing these are the figures the customer is invoiced.