---
title: "Preview the balance for a commitment"
method: GET
path: "/commitments/{commitmentId}/balancepreview"
tags: ["Commitments"]
---

# Preview the balance for a commitment

`GET /commitments/{commitmentId}/balancepreview`

Preview the balance for a commitment for current and past periods.
Future periods are not covered.

**Note**: This API will not work for tenants that are configured to skip commitment evaluation in Zuora Billing, and calls to this API are rejected.

## Path parameters

- `commitmentId` 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

- GetCommitmentBalanceResponse
  - `total` integer — Total commitments for the given account.
  - `page` integer — The current page number.
  - `pageSize` integer — The number of results returned per page.
  - `periods` PeriodBalance[] — A list of commitment period objects.
    - `id` string — ID of the commitment period.
    - `committedAmount` 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.
    - `totalSpend` number, double — The total amount 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' | 'EVALUATED' | 'ACTIVE_WITH_DRAWDOWN' | 'CANCELLED_PENDING_EVALUATION' — A subset of the Period status. Periods in the 'Cancelled' status will not be included.
    - `startDate` string, date — Ths 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/702f3caf3985/schema)