Reply
This is an open group. Sign in and click the "Join Group" button to become a group member and start posting.
Highlighted
Lana Community Manager

Community Manager

Community Manager
Posts: 642
Registered: ‎12-18-2015
[Documentation] Minimum Commitment Extension
[ Edited ]

Minimum Commitment

Charge based on a minimum-commit model

Installation and Configuration

Prerequisites

  • Active Connect license
  • A Zuora API Sandbox tenant, Performance Test Environment tenant or Production tenant. For more information see Zuora Environments in the Knowledge Center.
  • Administrative rights for the Zuora tenant
  • Configured Product Catalog. See Product Catalog in the Knowledge Center for more information.
  • Note: Production Copy Environment tenant is not currently supported

Installation

Minimum Commitment Extension app is an integrated service that must be installed directly into your Zuora tenant(s) after purchase. Once installed, the Minimum Commitment Extension app must be configured, as outlined below.

 

Configuration

After purchasing the Minimum Commitment Extension app, you must use the following steps to set up the app:

  1. Install the Minimum Commitment Extension app into Zuora tenant
  2. Configure the Minimum Commitment Extension app Notifications
  3. Configure the Minimum Commitment Extension app Custom Fields

 

Install Minimum Commitment Extension app into Zuora tenant

  1. Navigate to tenant in Zuora Connect and select Minimum Commitment Application from the New dropdown menu.

    MC1.png

  2. Complete the login configuration details. 
      • General
        • Name - Used to describe the app, enter a name that will help identify this app later on
        • Run Mode - Standard (default)
        • Execution - Select Callout from the drop down menu
        • Build Name - Universal (default)
        • Target - Select the credentials to the desired Zuora Environment
      • Advanced
        • Workflow Token, Endpoint and Username are advanced features for the Billing Post Processor. Please contact your Engagement Manager for more details.
        • There is no configuration needed for Workflow Token, Endpoint or Username
        • Select the Require Bill Run

    Click Create.

    MC2a.pngMC2b.png

  3. Minimum Extension app should appear in tenant. Hover over app in tenant to show the Actions menu. Select the magnifying glass to review Task Details.

    MC3.png

  4. In Task Details, copy the Endpoint URL to configure Zuora environment in later steps.  

    MC4.png

  5. Navigate to Connect profile, by selecting Profile from the drop down menu next to username in the upper right hand corner of your Connect account. Make note of your unique API Token to be used when setting up app in Zuora environment.

    MC5.png

Configure the Minimum Commitment Extension app Notifications

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

    MC6a.pngMC6b.png

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

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

Select Save

 

MC8.png

 

Configure the Minimum Commitment Extension app Custom Fields

  1. In Zuora environment, navigate to Settings > Billing > Manage Custom Fields.

    MC9a.pngMC9b.png

  2. Custom fields for Minimum Commitment Extension will need to be added by selecting the Customizable Object (Account, Subscription and Product Rate Plan Charge Fields) and and then adding the new custom field. 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.

    MC10.png

  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

Using Minimum Commitment Extension

After installation, the Minimum Commitment Extension app is ready to be used as follows::

  1. Identify product to use Minimum Commitment Extension app
  2. Configure Minimum Commitment Charge within the Product Rate Plan
  3. Configure the Minimum Commitment True Up Charge

Identify product within the product catalog that will use the Minimum Commitment Extension app

  1. In Zuora environment, navigate to Products > Product Catalog in the left hand navigation section.

    MC11.png

  2. Select the product catalog you want to use the Minimum Commitment Extension app.

Configure the Minimum Commitment Charge(s) within the Product Rate Plan

  1. On the product detail page, select an existing rate plan or create a new rate plan for Prepaid Drawdown configuration.
  2. Edit product by hovering the mouse over the product title, the edit menu will appear on the right. Click Edit.
    MC12.png
  3. Identify which charge(s) of the rate plan will be included towards the Minimum Commitment Extension app by selecting TRUE in the ‘Include Towards Minimum Commitment Amount’ drop down menu.
    • All charges default to FALSE

      MC13.png

Configure the Minimum Commitment True Up Charge with the Product Rate Plan Charges

  1. Identify which charge in the rate plan will be the True Up Charge by selecting TRUE in the ‘True Up Charge’ drop down menu.
    • All charges default to FALSE
    • There can only be 1 True Up Charge against an invoice
      MC14.png
  2. The True Up Charge must complete the ‘Charge Amount’ details.
    • List Price: Select the list price
    • UOM (Units of Measure)
      • Dollar
      • Each
      • License
      • Minute

MC15.png

Minimum Commitment Extension App Logic

Bill Runs automatically create invoices on a set schedule, and upon completion, will send a callout to the Minimum Commitment Extension app on Connect. The app will then run against those created invoices and calculate any needed True Up charges that must be added to the invoices.

 

For any invoices that need a True Up charge, because they do not meet the minimum commitment, the app will cancel the invoice, add usage for the appropriate amount and regenerate the invoice. This process will be shown by the created invoice being cancelled and in the customer account under ‘Transactions’ the regenerated invoice with the True Up charge will be displayed. Review of the new (minimum commitment regenerated) invoice, will show one invoice item for the original invoice amount and one invoice item for the True Up charge.

 

Example: The Bill Run generated an invoice of $75, but the minimum commitment amount is $100

  • The original invoice (INV...930) of $75 is created by the Bill Run and then cancelled by the Minimum Commitment Extension app. The app will then create a new invoice (INV...931) for the minimum amount of $100.

    MC16.png
  • Invoice details will show one invoice line item of the original charge of $75 and one line item of the True up charge of $25 to reach the minimum commitment amount.

    MC17.png

 

Notes

  • The service will not execute if an invoice in the bill run does not contain one charge where “IncludeTowardsMinimumCommitmentAmount__c” field set to TRUE and 1 charge that has the “TrueUpCharge__c” field set to TRUE.
  • The service looks to the Subscription object to determine the minimum commitment amount. If this value is blank the service will look to the Account. If both values are blank the service will skip the true-up process on the Invoice.
  • If the total sum of the charges is more than the commitment amount the service will not load any additional data. 

Support

  • Ask questions and connect with users just like you here in the Community!
  • Have a Question? Get answers to your questions from other app users and our SMEs.
  • Find a Bug? Let us know! Add "[BUG]" in the subject line and our team will look into it.
  • Got Feedback? Share your ideas on helping us make the app better with Connect Ideas.
  • See the Zuora Knowledge Center for information related to this app:

Lana Lee | Zuora Community Manager
"The greatest danger for most of us is not that our aim is too high and we miss it, but that it is too low and we reach it." - Michaelangelo