Retrieve change
Retrieve details of a specific contract change using its unique identifier. This endpoint is useful for obtaining information about the status and type of a contract change, as well as any associated line item changes. It requires the ‘contracts-read’ scope for access.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the contract change to retrieve.
Response
successful operation
The unique identifier of the contract associated with this change.
The unique identifier for this contract change.
An array of line item changes associated with this contract change.
A boolean indicating whether the contract change involves prorating.
The current status of the contract change. Valid values include 'DRAFT', 'PROPOSED', 'ACCEPTED', 'CANCELED', 'FAILED', and 'EXPIRED'.
ACCEPTED, CANCELED, DRAFT, EXPIRED, FAILED, PROPOSED The type of contract change, which can be either 'DIRECT' or 'QUOTE'.
DIRECT, QUOTE The date and time when this contract change was created, in ISO 8601 format.
The date when the contract change becomes effective, in ISO 8601 date format.
The name of the contract change.
The unique identifier of the quote associated with this contract change, if applicable.
The date and time when this contract change was last updated, in ISO 8601 format.