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

# List schedules for a commitment

`GET /commitments/{commitmentKey}/schedules`

Retrieves all the schedules for a specific commitment.

## 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

- GetCommitmentScheduleResponse
  - `schedules` ListCommitmentScheduleOutput[] — A list of commitment schedule objects.
    - `id` string — ID of the commitment schedule.
    - `commitmentId` string — ID of the commitment.
    - `commitmentNumber` string — The number of the commitment.
    - `version` integer — Version of the commitment schedule.
    - `startDate` string, date — Ths start date of the commitment schedule.
    - `endDate` string, date — The end date of the commitment schedule.
    - `prepaymentDefinition` PrepaymentDefinition — The prepayment definition for the commitment schedule.
      - `prepaymentFrequency` 'Month' | 'Quarter' | 'Semi_Annual' | 'Annual' | 'Eighteen_Months' | 'Two_Years' | 'Three_Years' | 'Five_Years' | 'Specific_Months' | 'Week' | 'Specific_Weeks' | 'Specific_Days' — The prepayment frequency for the prepayment definition. If the value is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`, use the `specificFrequency` field to specify the duration.
      - `specificFrequency` integer — The specific frequency length. This field is required when `prepaymentFrequency` is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`.
      - `customFields` object — Container for custom fields of a prepayment definition object.
    - `totalAmount` number, double — The total amount of the commitment schedule.
    - `amount` number, double — The non-prorated actual amount of the commitment schedule.
    - `amountBase` 'CommitmentPeriod' — The level for which the committed amount applies to.
    - `periodType` 'Month' | 'Quarter' | 'SemiAnnual' | 'Year' | 'SpecificMonths' | 'SinglePeriod' — The frequency type of the period of the commitment schedule.
    - `specificPeriodLength` integer — The specific length of the period, required if `periodType` is `SpecificMonths`.
    - `status` 'Active' | 'Cancelled' | 'Evaluated' | 'CancelledPendingEvaluation' — Status of the commitment schedule.
  - `total` integer — Total number of schedules available for the given commitment.
  - `page` integer — The current page number.
  - `pageSize` integer — The number of results returned 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/702f3caf3985/schema)