---
title: "List commitments for an account"
method: GET
path: "/commitments"
tags: ["Commitments"]
---

# List commitments for an account

`GET /commitments`

Retrieves a paginated list of commitments for a commitment owner account.

## Query parameters

- `accountNumber` string, required
- `type` 'MinCommitment' | 'MaxCommitment', CommitmentTypeEnum
- `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

- GetCommitmentsResponse
  - `total` integer — Total number of commitments returned.
  - `page` integer — Current page number.
  - `page_size` integer — Number of commitments per page.
  - `commitments` GetCommitmentResponse[] — List of commitments.
    - `id` string — ID of the commitment.
    - `status` 'Active' | 'Cancelled' | 'Evaluated' | 'CancelledPendingEvaluation' — Status of the commitment.
    - `version` integer — Version of the commitment.
    - `startDate` string, date — The start date of the commitment.
    - `endDate` string, date — The end date of the commitment.
    - `totalAmount` number, double — The commitment amount.
    - `currency` string — Currency of the commitment.
    - `orderNumber` string — The number of the order.
    - `orderId` string — The ID of the order.
    - `accountId` string — The ID of the commitment owner account.
    - `accountNumber` string — Use this field to assign an existing account as the owner of an Commitment.
    - `commitmentNumber` string — The number of the commitment.
    - `name` string — The name of the commitment.
    - `type` 'MinCommitment' | 'MaxCommitment' — The type of the commitment.
    - `prepaymentType` 'FullyPrepaid' | 'NotPrepaid' — The prepayment type of the commitment. **Note**: `FullyPrepaid` commitments will not be considered for true-up during invoice generation.
    - `description` string — The description about this commitment.
    - `priority` integer — The priority of the commitment. It defines the evaluation order of the commitment. The lower the number, the higher the priority. When two commitments have the same priority, the one with the earlier created time will be evaluated first.
    - `customFields` CommitmentCustomFields — Container for custom fields of a Commitment object.
    - `accountReceivableAccountingCode` string — The accounting code on the Commitment object for customers
    - `adjustmentLiabilityAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `adjustmentRevenueAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `cancellationPolicy` CancellationPolicy — Cancellation policy configuration for a commitment. Defines how settlements are handled when a commitment is cancelled.
      - `settlementType` 'NoSettlement' | 'FullMinimum' | 'PeriodMinimum' — Settlement type for commitment cancellation.
    - `cancellationEffectiveDate` string, date — The effective date when the commitment cancellation takes effect.
    - `childCommitments` string[] — The commitment numbers of the child commitments that are nested under this parent commitment.
    - `contractAssetAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `contractLiabilityAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `contractRecognizedRevenueAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `deferredRevenueAccountingCode` string — The deferred revenue accounting code for the commitment.
    - `excludeItemBookingFromRevenueAccounting` boolean — The flag to exclude commitment related booking items from revenue accounting.
    - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `eligibleAccountConditions` EligibleAccountCondition — The conditions for account level filters for the commitment.
      - `field` string — The field name of a single condition.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition. Example: - eq: equal, field = value - neq: not equal, field != value - gt: greater than, field > value - lt: less than, field < value - gte: greater than or equal, field >= value - lte: less than or equal, field <= value - lk: like, field like value - in: in, field in value, multiple values are separated by commas - nl: null, field is null - nnl: not null, field is not null
      - `value` string — The value of a single condition, which can be a list of values separated by commas. **Notes:** Account Condition only contains account related fields. Support is provided only for the indexed custom fields.
      - `conditions` EligibleAccountCondition[] — The conditions will be combined by the relation.
      - `relation` 'and' | 'or' — The relation among the conditions.
    - `eligibleChargeConditions` EligibleChargeCondition — The conditions for charge level filters for the commitment.
      - `field` string — The field name of a single condition.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition. Example: - eq: equal, field = value - neq: not equal, field != value - gt: greater than, field > value - lt: less than, field < value - gte: greater than or equal, field >= value - lte: less than or equal, field <= value - lk: like, field like value - in: in, field in value, multiple values are separated by commas - nl: null, field is null - nnl: not null, field is not null
      - `value` string — The value of a single condition, which can be a list of values separated by commas. **Notes:** - PPDD (PrePaid DrawDown) charge will not be loaded during evaluation. - Charge condition only contains charge related fields. Support is provided only for the indexed custom fields. - Charge types supports only the OneTime, Recurring and Usage values. - Charge models supports only the FlatFee, PerUnit, Overage, Volume Tiered, TieredWithOverage, and Calculated values.
      - `conditions` EligibleChargeCondition[] — The conditions will be combined by the relation.
      - `relation` 'and' | 'or' — The relation among the conditions.
    - `periodAlignmentOption` 'CommitmentStartDate' | 'SpecificDate' — Options for aligning the commitment periods within a commitment.
    - `specificPeriodAlignmentDate` string, date — The specific date for period alignment, required if `periodAlignmentOption` is `SpecificDate`.
    - `isAllocationEligible` boolean — This field is used to identify if the commitment is allocation eligible in revenue recognition. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `recognizedRevenueAccountingCode` string — The recognized revenue accounting code for the commitment.
    - `revenueAmortizationMethod` string — This field is used to dictate the type of revenue amortization method.
    - `revenueRecognitionRule` string — The revenue recognition rule for the commitment.
    - `revenueRecognitionTiming` string — This field is used to dictate the type of revenue recognition timing.
    - `unbilledReceivablesAccountingCode` string — The accounting code on the commitment for customers. **Note**: This field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled.
    - `taxable` boolean — Determines whether the true-up invoice of a commitment is taxable. If the value is `true`, the tax code and tax mode are required.
    - `taxCode` string — Identifies which tax rules and tax rates to apply to the corresponding billing document.
    - `taxMode` 'TaxInclusive' | 'TaxExclusive' — The tax mode that determines whether tax is included or exclueded from the billing document.

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