View and track commitments
Learn how to view commitment details, track utilization and balances, configure threshold notifications, and retrieve commitment data.
The commitment detail page is the primary place to view commitment information, including commitment status, schedules, utilization, balances, child commitments, and current contribution items.
You can open a commitment from the commitment list, or open a related commitment from a subscription.
View commitment details
To open a commitment from the commitment list:
-
In the navigation menu, under Customers, click Commitments.
-
Search for and select the commitment that you want to view.
Commitment name and status
The top of the page displays the commitment name and current status.
Commitments are progressively locked as they are processed.
|
Status |
Allowed Changes |
|---|---|
|
Active — No contributions in any period |
|
|
Active — At least one period has contributions. No period has been evaluated. |
|
|
At least one period evaluated for true-up |
|
|
All periods are evaluated, or commitment is cancelled |
Considered as completed. No change can be made. |
Basic and additional information
The page displays basic commitment information and additional attributes. Expand Additional Fields to view additional commitment information, such as tax code, accounting codes, revenue fields, and other configured fields. For cancelled commitments, the commitment detail page also displays Cancellation Date and Settlement Type.
Schedules and periods
The Commitment Schedules section displays schedule-level information, such as:
-
Commitment start date
-
Period alignment
-
Prepayment type
-
Schedule name and number of periods
-
Period start date and end date
-
Period type
-
Period amount
-
Prepayment frequency, when applicable
Expand the Commitment Schedules section to view each commitment period. For each period, Zuora displays balance and usage information.
-
Period: The period start and end dates.
-
Amount: The commitment period amount. A PRORATED indicator can appear when the amount is prorated.
-
Total Spend: The billed spend and usage percentage for the period.
-
% of Usage: The current usage percentage based on the as-of-today consumed amount.
-
Forecasted % of Usage: The forecasted usage percentage through the end of the period.
-
Balance: The current consumed amount for the period.
Depending on the commitment type, one of the following columns is also displayed:
-
True-up for postpaid commitments.
-
Expired for prepaid commitments.
Child commitments
On the commitment details page, you can view whether a commitment is part of an overlapping commitment hierarchy in nested mode. For nested commitments, the detail page shows the related parent commitment or child commitments so that you can understand how the hierarchy is configured. In a nested hierarchy, a child commitment is evaluated before its parent commitment. Any child commitment true-up amount rolls up to the parent commitment.
Current Contribution Items
Expand the Current Contribution Items section to view the items currently contributing to the commitment.
-
Subscription Rate Plan Charges, including one-time, recurring, and usage charges.
-
Dynamic Usage Charges.
To view the filter conditions used for the commitment, click View Filter Rules in the section header.
Reapply applicable accounts and charges
After you create a commitment, new accounts or changes to existing accounts can make additional accounts eligible for the commitment. To include the eligible accounts and their new charges, open the commitment detail page and click Reapply Applicable Items in the Current Contribution Items section.
Zuora re-evaluates the commitment's current account and charge filter conditions and associates eligible accounts and charges with the commitment. After the reapply process, new eligible charges created under those accounts contribute to the commitment automatically.
Charges created before the reapply process are not associated retroactively. Existing accounts and charges that are already associated with the commitment remain associated, even if they no longer satisfy the current filter conditions.
The updated associations take effect in the current commitment period in which you reapply the applicable items. After the process completes, the Current Contribution Items section shows the latest associations.
Example: Refresh associations after eligibility changes
Suppose commitment CMT001 uses the following filter conditions:
Include accounts whose
commitNumber__ccustom field isCMT001.Include charges whose
commitNumber__ccustom field isCMT001.
When the commitment is created, the accounts and charges that satisfy these conditions are associated with the commitment.
After the commitment is created, assume that the following changes occur:
A new account is created, and its
commitNumber__cvalue is set toCMT001. The account and its applicable charges become eligible for the commitment.An existing account has its
commitNumber__cvalue changed fromCMT000toCMT001. The account and its applicable charges become eligible for the commitment.When you create a new subscription with a charge whose custom field
commitNumber__cis set toCMT001, the charge is eligible for and is included in the commitment.When you add a product to an existing subscription and set the new charge's custom field
commitNumber__ctoCMT001, the charge is eligible for and is included in the commitment.
These changes do not automatically refresh the commitment's existing associations. When you click Reapply Applicable Items, Zuora re-evaluates the commitment's filter conditions and associates newly eligible accounts and charges with the commitment for the current commitment period. Charges created before the reapply process are not associated retroactively. Existing associated accounts and charges remain associated, even if they no longer satisfy the current filter conditions
Example: A new child account becomes eligible
Suppose the commitment's account filter includes account A and all its direct child accounts. When the commitment is created, direct child accounts B, C, and D meet the condition and are included.
After the commitment is created, a new direct child account, E, is added under account A. Account E now meets the commitment's account filter condition. Once the Reapply Applicable Items button is clicked, the associations are refreshed and account E is included. Any charges under account E are included only when they also satisfy the commitment's charge and account eligibility conditions.
Before and after subscription or invoice owner transfer
Before a subscription or invoice owner transfer, contribution eligibility is based on the owner relationship in effect for the subscription.
After an owner transfer is completed, the Current Contribution Items section reflects the current contribution eligibility for the transferred subscription.
-
If the subscription charges are no longer eligible for the commitment, they no longer appear in the list.
-
If the subscription charges are now eligible for the commitment, they appear in the list.
Historical commitment activity remains available through commitment balances and contribution history.
View linked commitments on a subscription detail page
You can view which commitments a subscription charge contributes to from the subscription detail page.
-
On the subscription page, go to the Included products / Charges section.
-
Hover over the icon that displays Click to view commitments.
-
Click the icon to view the related commitment information.
This bidirectional navigation lets you move between a commitment and the subscription charges that contribute to it without running a Data Query or report.
Notifications
You can trigger standard and custom event notifications to proactively alert customers or internal teams when commitment thresholds are met.
Examples include:
-
The commitment balance for a period falls below a configured monetary threshold, such as remaining balance less than or equal to $100.
-
The percentage of the remaining balance falls below a configured threshold, such as remaining balance divided by committed amount less than or equal to 10%.
-
The number of remaining days in the current commitment period falls below a configured threshold, such as 7 days.
The following Commitment objects are available under the Related Events dropdown when creating an Email Template or Callout Template:
-
Commitment
-
Commitment Period
-
Commitment Schedule
-
Commitment Transaction
-
Commitment Associated Account
-
Commitment Associated Item
Reporting
You can pull Commitment Period data using Data Source Export and Reporting. Use these sources to analyze period balance, billed spend, usage, and true-up data.
You can also retrieve period balance, total billed spend, and true-up amount programmatically using the List periods for a commitment API.
Data Query
Use Data Query to retrieve Commitment Period data for analysis and reporting. Commitment Period data includes period-level balance, billed spend, usage, and true-up information.
To preview the period balance with unbilled spend as of a date or through the end of the commitment, use the Preview the balance for a commitment API.