Commitments

Retrieve a commitment

Changed on

Retrieves the details of a specific commitment using its ID or number.

get/commitments/{commitmentKey}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commitments/{commitmentKey}
  • Auth: HTTP bearer

Path parameters

commitmentKeystring required

The unique identifier (ID or number) of the commitment.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

ID of the commitment.

status'Active' | 'Cancelled' | 'Evaluated' | 'CancelledPendingEvaluation'

Status of the commitment.

versioninteger

Version of the commitment.

startDatestring date

The start date of the commitment.

endDatestring date

The end date of the commitment.

totalAmountnumber double

The commitment amount.

currencystring

Currency of the commitment.

orderNumberstring

The number of the order.

orderIdstring

The ID of the order.

accountIdstring

The ID of the commitment owner account.

accountNumberstring

Use this field to assign an existing account as the owner of an Commitment.

commitmentNumberstring

The number of the commitment.

namestring

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.

descriptionstring

The description about this commitment.

priorityinteger

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.

customFieldsCommitmentCustomFields

Container for custom fields of a Commitment object.

aceIdinteger

The account code entity ID.

accountReceivableAccountingCodestring

The accounting code on the Commitment object for customers

adjustmentLiabilityAccountingCodestring

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.

adjustmentRevenueAccountingCodestring

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.

cancellationEffectiveDatestring date

The effective date when the commitment cancellation takes effect.

childCommitmentsstring[]

The commitment numbers of the child commitments that are nested under this parent commitment.

contractAssetAccountingCodestring

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.

contractLiabilityAccountingCodestring

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.

contractRecognizedRevenueAccountingCodestring

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.

deferredRevenueAccountingCodestring

The deferred revenue accounting code for the commitment.

excludeItemBookingFromRevenueAccountingboolean

The flag to exclude commitment related booking items from revenue accounting.

excludeItemBillingFromRevenueAccountingboolean

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.

revenueModel'BillingBased' | 'ExcludeCommit'

Revenue accounting model for the commitment.

periodAlignmentOption'CommitmentStartDate' | 'SpecificDate'

Options for aligning the commitment periods within a commitment.

specificPeriodAlignmentDatestring date

The specific date for period alignment, required if periodAlignmentOption is SpecificDate.

isAllocationEligibleboolean

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.

isUnbilledboolean

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.

recognizedRevenueAccountingCodestring

The recognized revenue accounting code for the commitment.

revenueAmortizationMethodstring

This field is used to dictate the type of revenue amortization method.

revenueRecognitionRulestring

The revenue recognition rule for the commitment.

revenueRecognitionTimingstring

This field is used to dictate the type of revenue recognition timing.

unbilledReceivablesAccountingCodestring

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.

taxableboolean

Determines whether the true-up invoice of a commitment is taxable. If the value is true, the tax code and tax mode are required.

taxCodestring

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.

Example response

{
  "childCommitments": [
    "CMT-CHILD-001",
    "CMT-CHILD-002"
  ],
  "revenueModel": "BillingBased"
}

Changes