---
title: "List periods for a commitment"
method: GET
path: "/commitments/periods"
tags: ["Commitments"]
---

# List periods for a commitment

`GET /commitments/periods`

Lists periods of the commitment. You can paginate the results using `page` and `pageSize` query parameters.

## Query parameters

- `commitmentKey` string
- `startDate` string, date
- `endDate` string, date
- `accountNumber` string
- `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

- ListCommitmentPeriodsResponse
  - `total` integer — Total number of periods available for the given commitment/Total commitments for given account.
  - `page` integer — The current page number.
  - `pageSize` integer — The number of results returned per page.
  - `periods` CommitmentPeriod[] — A list of commitment period objects.
    - `id` string — ID of the commitment period.
    - `commitmentId` string — ID of the commitment.
    - `commitmentNumber` string — The number of the commitment.
    - `version` integer — Version of the commitment period.
    - `type` 'MinCommitment' | 'MaxCommitment' — The type of the commitment.
    - `priority` integer — Priority of the commitment.
    - `currency` string — Currency of the commitment.
    - `isProrated` boolean — Indicates if the period is prorated.
    - `amount` number, double — The total amount of the commitment within the current period.
    - `balance` number, double — The balance amount to be spent within the current period.
    - `trueUpAmount` number, double, nullable — Total true-up amount for this commitment period. It will be null if it is a prepaid commitment or if it is not evaluated yet. This will be a non-negative number.
    - `expiredAmount` number, double, nullable — Total expired amount for this commitment period. It will be null if it is a postpaid commitment or if the period is not evaluated yet. This will be a non-negative number.
    - `billedTotalSpending` number, double — Sum of charge contribution amount.
    - `status` 'Active' | 'Cancelled' | 'Evaluated' | 'ActiveWithDrawdown' | 'CancelledPendingEvaluation' — Status of the commitment period.
    - `startDate` string, date — The start date of the commitment period.
    - `endDate` string, date — The end date of the commitment period.

## 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/d11e237f3e54/schema)