Skip to main content

Configuring Minimum Commitment

Zuora

Configuring Minimum Commitment

The Minimum Commitment app is not available for purchase anymore and is in maintenance mode. The information in this documentation is intended to be used by customers who have purchased the app. 

After purchasing and installing the Minimum Commitment app, you need to perform the following steps to set up the app:

  • Configure the Minimum Commitment app notifications
  • Configure the Minimum Commitment app custom fields 

Configure notifications

1. In your Zuora tenant, navigate to Settings > Billing > Setup Profiles, Notifications and Email Templates.

2. Select Edit on Bill Run Completion │Completed Status.

Notification-1.png

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. In your  Zuora tenant, navigate to Settings > Billing > Manage Custom Fields.

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 and UI Read Only boxes should not be checked.

3. Add custom account field: Customizable Objects: Account Fields > Account Custom Fields and Relationships (Non-Indexed) > Add New Field.

Field Type:  

Field Label:

API Name: (FieldLabel_c)

 Additional Information:   

Date

Minimum Commitment Next True Up Date  

MinimumCommitmentNextTrueUpDate_c 

None

Picklist

Minimum Commitment Billing Period

MinimumCommitmentBillingPeriod_c

Picklist Values:

  • Monthly (default)
  • Quarterly
  • Annually

Text

Minimum Commitment Amount

MinimumCommitmentAmount_c

Text length 225

Picklist

Minimum Commitment Type

MinimumCommitmentType_c

Picklist Values:

  • Currency (default)*
  • Quantity

4. Add custom subscription field: Customizable Objects: Subscription Fields > Subscription Custom Fields and Relationships (Non-Indexed) > Add New Field.

Field Type:  

Field Label:

API Name: (FieldLabel_c)

 Additional Information:   

Date

Minimum Commitment Next True Up Date  

MinimumCommitmentNextTrueUpDate_c  

None

Picklist

Minimum Commitment Billing Period

MinimumCommitmentBillingPeriod_c

Picklist Values:

  • Monthly (default)
  • Quarterly
  • Annually

Text

Minimum Commitment Amount

MinimumCommitmentAmount_c

Text length 225

Picklist

Minimum Commitment Type

MinimumCommitmentType_c

Picklist Values:

  • Currency (default)
  • Quantity

5. Add custom product rate plan charge fields: Customizable Objects: Product Rate Plan Charge Fields > Product Rate Plan Charge Custom Fields and Relationships (Non-Indexed) > Add New Field.

Field Type:  

Field Label:

API Name:

Picklist Values:   

Picklist

True Up Charge

TrueUpCharge_c

FALSE (default)

TRUE

Picklist

Include Towards Minimum Commitment Amount  

IncludeTowardsMinimumCommitmentAmount_c  

FALSE (default)

TRUE

6. Add custom product rate plan charge fields: Customizable Objects: Invoice Fields > Invoice Custom Fields and Relationships (Non-Indexed) > Add New Field.

Field Type:  

Field Label:

API Name:

Picklist Values:   

Picklist

Minimum Commitment Processed  

MinimumCommitmentProcessed_c  

FALSE (default)

TRUE

What's next

See Using Minimum Commitment for more information.