Sign in
Changes

Retrieve change

Changed on

Retrieve details of a specific contract change using its unique identifier. This endpoint allows you to access information about the change, including its status, type, and any associated line item changes. It is useful for tracking the progress and details of contract modifications.

get/commerce/contracts/2027-03-beta/changes/{changeId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/{changeId}
  • Auth: none required

Path parameters

changeIdstring required

The unique identifier of the contract change to retrieve.

Response

successful operation

contractIdstring required

The unique identifier of the contract associated with this change.

createdAtstring date-time

The date and time when the contract change was created, in ISO 8601 format.

effectiveDatestring date

The date when the contract change becomes effective, in YYYY-MM-DD format.

idstring required

The unique identifier for the contract change.

namestring

The name of the contract change.

proratingboolean required

A boolean indicating whether the contract change involves prorating.

quoteIdstring

The unique identifier of the quote associated with this contract change.

status'ACCEPTED' | 'CANCELED' | 'DRAFT' | 'EXPIRED' | 'FAILED' | 'PROPOSED' required

The current status of the contract change. Valid values include 'DRAFT', 'PROPOSED', 'ACCEPTED', 'CANCELED', 'FAILED', and 'EXPIRED'.

type'DIRECT' | 'QUOTE' required

The type of contract change. Valid values include 'DIRECT' and 'QUOTE'.

updatedAtstring date-time

The date and time when the contract change was last updated, in ISO 8601 format.

Changes