List the change history for a commitment
Lists the historical changes made to a specific commitment, ordered by the most recent changes first.
Notes:
- Owner Transfer on Commitment accounts will transfer the associated subscription charges from source to destination account. If the destination account has commitments with matching charge filters, the charges get associated with the commitment in the destination account.
- Multi-attribute pricing (MAP) charges are prorated based on overlapping days when the Billing Rule for Usage Drawdown Mode is By Day.
Path parameters
The unique identifier (ID or number) of the commitment.
Query parameters
Page number for pagination.
Page size for commitment.
Headers
Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.
Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.
Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.
The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.
The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').
The minor API version.
For a list of available minor versions, see API upgrades.
Response
OK
Example response
{
"commitmentChanges": [
{
"commitmentNumber": "CMT-00083518",
"orderNumber": "O-00007435",
"version": 1,
"changeDate": "2020-10-01T12:00:00Z",
"scheduleChanges": [
{
"scheduleId": "0df89cf12e650006ac13624398764f1b",
"version": 2,
"changes": {
"amount": {
"oldValue": 100,
"newValue": 150
}
},
"periodChanges": [
{
"periodId": "8ad08ca797ef6ca50197f3cce6267991",
"version": 2,
"changes": {
"status": {
"oldValue": "Active",
"newValue": "Closed"
}
}
}
]
},
{
"scheduleId": "0df89cf12e650006ac13624398764f1b",
"version": 1,
"changes": {
"startDate": {
"oldValue": null,
"newValue": "2021-01-01"
},
"endDate": {
"oldValue": null,
"newValue": "2021-06-30"
},
"amount": {
"oldValue": null,
"newValue": 100
},
"status": {
"oldValue": null,
"newValue": "Active"
}
},
"periodChanges": [
{
"periodId": "8ad08ca797ef6ca50197f3cce6267991",
"version": 1,
"changes": {
"startDate": {
"oldValue": null,
"newValue": "2021-01-01"
},
"endDate": {
"oldValue": null,
"newValue": "2021-06-30"
},
"status": {
"oldValue": null,
"newValue": "Active"
}
}
}
]
}
],
"associatedItemChanges": [
{
"itemId": "1873a10929b9f39b944f39e7ac640006",
"version": 1,
"changes": {
"itemId": {
"oldValue": null,
"newValue": "1873a10929b9f39b944f39e7ac640006"
},
"status": {
"oldValue": null,
"newValue": "ACTIVE"
},
"itemType": {
"oldValue": null,
"newValue": "SUBSCRIPTION_CHARGE"
},
"itemNumber": {
"oldValue": null,
"newValue": "C-00000238"
},
"invoiceOwnerId": {
"oldValue": null,
"newValue": "8a90ff929f35bc19019f39ae5136225f"
},
"subscriptionNumber": {
"oldValue": null,
"newValue": "A-S00000162"
},
"subscriptionVersion": {
"oldValue": null,
"newValue": 1
}
}
}
]
}
]
}