Configuring Minimum Commitment

Configure notifications

1. Navigate to Platform > Events & Notifications in the left navigation menu in the Zuora UI.

2. Locate the Completed Status notification defined on the Billing Run Completion event and click the Edit icon .

3. Complete notification details. 

Basic Information:

• Name - Can be changed for easier tracking
• Description - Can be changed for easier tracking
• Active - Must be enabled

Event Parameters:

• Bill Run Status - Completed

Delivery Options:

• Email - System alert that Zuora has finished generating invoices
  • Once invoices are created, Minimum Commitment app will run
• Callout - Must be enabled
• Base URL - Enter Endpoint URL from app installation into tenant
• Select Add Parameter to add new field
  • Parameter Name - BillRunID
  • Parameter Value - BillRun.ID from Legacy Fields
• HTTP Method - GET
• Retry - Set to 0 (zero)
• Callout Authentication - Must be enabled
  • Username - Enter Zuora Connect username
  • Password - Enter unique API Token from Connect profile

Click Save.

 

Configure custom fields

1. Navigate to Platform > Object Manager in the left navigation menu.
2. Custom fields for Minimum Commitment will need to be added by selecting the Customizable Object (Account, Subscription, and Product Rate Plan Charge Fields) and then adding the new custom fields. Added fields will require the following template to be completed. A description can be added for each of the labels if needed, the Required checkbox should not be checked. For more information about how to add custom fields, see Manage custom fields.
   1. Add the following custom fields for the Account object:

      Name	API Name	Field Type	Additional Information
      Minimum Commitment Next True Up Date	MinimumCommitmentNextTrueUpDate__c	Date	None
      Minimum Commitment Billing Period	MinimumCommitmentBillingPeriod__c	Picklist	Picklist options: Monthly (default) Quarterly Annually
      Minimum Commitment Amount	MinimumCommitmentAmount__c	Text	Max length 225
      Minimum Commitment Type	MinimumCommitmentType__c	Picklist	Picklist options: Currency (default) Quantity

   2. Add the following custom fields for the Subscription object:

      Name	API Name	Field Type	Additional Information
      Minimum Commitment Next True Up Date	MinimumCommitmentNextTrueUpDate__c	Date	None
      Minimum Commitment Billing Period	MinimumCommitmentBillingPeriod__c	Picklist	Picklist options: Monthly (default) Quarterly Annually
      Minimum Commitment Amount	MinimumCommitmentAmount__c	Text	Max length 225
      Minimum Commitment Type	MinimumCommitmentType__c	Picklist	Picklist options: Currency (default) Quantity

   3. Add the following custom fields for the Product Rate Plan Charge object:

      Name	API Name	Field Type	Picklist Options
      True Up Charge	TrueUpCharge__c	Picklist	FALSE (default) TRUE
      Include Towards Minimum Commitment Amount	IncludeTowardsMinimumCommitmentAmount__c	Picklist	FALSE (default) TRUE

   4. Add the following custom fields for the Invoice object:

      Name	API Name	Field Type	Picklist Options
      Minimum Commitment Processed	MinimumCommitmentProcessed__c	Picklist	FALSE (default) TRUE

What's next

See Using Minimum Commitment for more information.