Skip to main content

Set Up Prepaid Drawdown

Zuora

Set Up Prepaid Drawdown

  1. Last updated
  2. Save as PDF

After the Prepaid Drawdown app is installed, take the following steps to set up the Prepaid Drawdown app:

  1. Add new extension
  2. Configure custom fields
  3. Add reason code

Add New Extension

An extension enables you to link your Zuora to the Prepaid Drawdown app. Take the following steps to add a new extension in your Zuora tenant:

  1. In your Zuora tenant, navigate to Settings > Platform > Manage My Extensions.
  2. Add &showAddNew=true to the current page's URL and refresh the page. For example, if you are using the API Sandbox environment, change the URL to: https://apisandbox.zuora.com/apps/Extension.do?menu=Z-Platform&showAddNew=true; if you are using the Production environment, change the URL to: https://zuora.com/apps/Extension.do?menu=Z-Platform&showAddNew=true.
  3. Click add new extension. 
  4. Complete the extension details in the New Extension page:
    • Extension Type: Select Charge Model from the drop-down list.
    • Name: Enter the name that will help you identify the extension. For example, Prepaid Drawdown.
    • (Optional) Description: Enter the description to help you identify the extension.
    • Extension Profile: Select Prepaid with drawdown from the drop-down list. 
    • Connect Token: Enter the API Token from your Prepaid Drawdown app instance. You can copy the API-Token from the API tab of the app instance.
    • Connect URL - Enter the URL from your Prepaid Drawdown app instance. You can copy the URL from the API tab of the app instance.
  5. Click save. The extension is then saved and added to the My Extensions list.
  6. Click activate to activate this extension.

Configure Custom Fields

Custom fields will be used in the configuration of prepaid and drawdown charges. 

  1. In your Zuora tenant, navigate to Settings > Billing > Manage Custom Fields. 
  2. Add custom fields for Prepaid Drawdown. See Manage Custom Fields for information on how to create custom fields. Note that when creating a new custom field for Prepaid Drawdown, do not select the Required and UI Read Only checkboxes. 
    1. Navigate to Account Fields > Account Custom Fields and Relationships (Non-Indexed) > add new field and add the following custom field:
      Field Type Field Label Length
      Text PPDD Balance 255
    2. Navigate to Subscription Fields > Subscription Custom Fields and Relationships (Non-Indexed) > add new field and add the following custom field: 
      Field Type Field Label Length
      Text PPDD Balance 255
    3. Navigate to Product Rate Plan Charge Fields > Product Rate Plan Charge Custom Fields and Relationships (Non-Indexed) > add new field and add the following custom Product Rate Plan Charge fields: 
      Field Type Field Label Picklist Values

      Picklist

      PPDD Use Prepayment On Taxes

      Yes
      No
      Picklist PPDD Use Prepayment On Discounts Yes
      No
      Picklist PPDD Ignore Discount For Balance Calculations No
      Yes
      Picklist PPDD Allow Negative Prepaid Balance Yes
      No
      Picklist PPDD Balance Location Account
      Subscription
      Picklist PPDD Type Prepayment
      Drawdown
      Picklist PPDD Ignore Negative Invoice Items No
      Yes
      Text

      PPDD Reason Code

      		 255
      Text (Optional) PPDD Deferred Accounting Code Override 255
      Text (Optional) PPDD Recognized Account Code Override

      255

Add Reason Code

The created reason code will be used in the configuration of prepaid and drawdown charges.

  1. In your Zuora tenant, navigate to Settings > Payments > Configure Reason Codes.
  2. Select Invoice Item Adjustment from the Define Reason Code drop-down list.
  3. Click add new reason code.
  4. Enter Drawdown in the Reason Code Name column for the new line and click save. The reason code is then saved and default to be active. 

What's Next

The Prepaid Drawdown app is ready to be used. See Using Prepaid Drawdown for more information.