---
title: "List the change history for a commitment"
method: GET
path: "/commitments/{commitmentKey}/commitmentChanges"
tags: ["Commitments"]
---

# List the change history for a commitment

`GET /commitments/{commitmentKey}/commitmentChanges`

Lists the historical changes made to a specific commitment, ordered by the most recent changes first.

## Path parameters

- `commitmentKey` string, required

## Query parameters

- `page` integer
- `pageSize` integer

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string
- `Zuora-Version` string

## Response `200`

OK

- ListCommitmentHistoricalChangesResponse
  - `commitmentChanges` CommitmentOrderChangeOutput[] — A list of commitment change objects.
    - `commitmentNumber` string — The unique identifier of the commitment.
    - `orderNumber` string — The number of the order that changed the commitment.
    - `version` integer — The commitment version by this order.
    - `changeDate` string, date-time — The date and time when the change was made.
    - `changes` Change — The change of the value of the field.
    - `scheduleChanges` CommitmentScheduleChanges[] — The changes in the schedules of the commitment in this order.
      - `scheduleId` string — The ID of the commitment schedule.
      - `version` integer — The version number of the commitment schedule.
      - `changes` Change — The change of the value of the field.
      - `periodChanges` CommitmentPeriodChanges[] — The changes in the period of the schedule in this order.
        - `periodId` string — The ID of the commitment period.
        - `version` integer — The version number of the commitment period.
        - `changes` Change — The change of the value of the field.
  - `total` integer — Total number of commitments in current page.
  - `page` integer — Current page number.
  - `pageSize` integer — Number of commitments per page.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d2e622aeaf30/schema)