Skip to main content

Manage promotion codes

Zuora

Manage promotion codes

Introduces the basic operations on promotion codes, including importing, exporting, copying, moving, updating, and deleting promotion codes, and setting up callouts.

This article introduces the common operations that you are likely to use in the UI after child campaigns are set up.

For alternative API operations, see API Docs for more information.

Create a new promo code

New promo codes are introduced for customers to utilize one single discount when valid. 

Complete the following steps to create a new promo code:

  1. Launch the Promo Codes app instance and click the Campaigns tab on the home page.

  2. Find the campaign for which you want to create a promo code, and click icon_details to enter the detailed page of the campaign.

  3. Scroll to the bottom and select Actions > New Promo Code. The New Promo window displays.

  4. Specify the new promo code details.

    1. In the Promo Details section, complete the following fields: 

  • Effective From - Start date of the new promo code. This is the first day that the promo can be redeemed and be considered valid
  • Effective To - End date of the new promo code. This is the last day that the promo can be redeemed and be considered valid
  • Child Campaign - The name of the child campaign that consists of one or a group of promotion codes
  • Code Type - Select the applicable code type from the drop-down list.
    • 1 mutli-use code - A single promo code that you can use as many times as you want.

    • Many single-use codes - Zuora will auto-generate as many codes as specified with a prefix or suffix (if provided) with as many characters as specified.

    • Many Multi-use codes - Zuora will auto-generate as many codes as specified with a prefix or suffix (if provided) with as many characters as specified.
  • If you select 1 Multi-Use Code for the Code Type field, complete the following fields:
    • Initial Quantity - The number of promo codes that are initially issued. The value of this field cannot be changed after the initial configuration for single use

    • Available Quantity - The amount of the remaining codes that can be redeemed. This number will change as promo codes are redeemed

    • Code - Identify code value to be linked to the child campaign that will be used by customers.
    • Many single-use codes - Zuora will auto-generate as many codes as specified with a prefix or suffix (if provided) with as many characters as specified.
  • If you select Many single-use codes for the Code Type field, complete the following fields:
    • Prefix - Characters or numbers that are placed before the app generated code. 
    • Suffix - Characters or numbers that are placed after the app generated code.
    • # Autogenerated Characters - The number of characters for each generated code.
    • # Codes to Generate - The amount of the generated codes. An error message will be prompted if the number of auto-generated characters is insufficient to support the number of codes to be generated. 
  • If you select Many Multi-use codes for the Code Type field. Complete the following fields:
    • Prefix - Characters or numbers that are placed before the app generated code. 
      • Suffix - Characters or numbers that are placed after the app generated code.
    • Number of Autogenerated Characters - The number of characters for each generated code.
    • Number of Codes to Generate - The amount of the generated codes. An error message will be prompted if the number of auto-generated characters is insufficient to support the number of codes to be generated. 
    • Redemptions Per Code - The number of times each code can be used. 
  1. In the Eligible Rate Plans section, select the applicable rate plans.
  • Apply to all: All rate plans in tenant are eligible for promo code thus no specific selection of one or many rate plans is necessary

  • Apply to select: User must manually specify which rate plans can have the promo codes used against the

  1. In the Discount Rate Plans to Add section, select the applicable option from the Choose a discount type field for the discount to be automatically added when the promo code is redeemed.

  • None - No discount.
  • Percent Discount Rate Plan - A percentage-based discount rate plan.
  • Fixed Amount Discount Rate Plan - A fixed amount discount rate plan.
  1. If you select Percent Discount Rate Plan for the Choose a discount type field. Complete the following fields:
  • Discount Rate Plan - The rate plan of the specified discount type. Only the active product rate plans that contain only one discount charge of the selected discount type will be displayed. The information of the selected rate plan will be automatically populated as default.
  • (Optional) Discount Percentage - Optionally enter a the percentage (without %) or amount to override the original discount. The default value is automatically populated based on the discount rate plan you selected.
  • (Optional) End Date (Default: Subscription_End) - The end date for the promotion code. It can be one of the following values:
    • Do Not Override - With this option selected, the discount rate plan end date is used.
    • Align to Subscription End Date - The default value. The promotion end date aligns with the end date of the subscription to which it is applied.
    • Fixed Period after the Charge is Triggered - With this option selected, the promotion codes expire when the charge reaches a certain amount. You also need to configure the Amount and Unit of Time fields to determine the charge amount that triggers to end the promotion code.
  • (Optional) Billing Period (Default: Month) - The invoicing billing period. The default value is Month
  1. If you select Fixed Amount Discount Rate Plan for the Choose a discount type field. Complete the following fields:

  • Discount Rate Plan - The rate plan of the specified discount type. Only the active product rate plans that contain only one discount charge of the selected discount type will be displayed. The information of the selected rate plan will be automatically populated as default.
  • (Optional) Discount Amount - Optionally enter a the percentage (without %) or amount to override the original discount. The default value is automatically populated based on the discount rate plan you selected.
  • (Optional) End Date (Default: Subscription_End) - The end date for the promotion code. It can be one of the following values:
    • Do Not Override - With this option selected, the discount rate plan end date is used.
    • Align to Subscription End Date - The default value. The promotion end date aligns with the end date of the subscription to which it is applied.
    • Fixed Period after the Charge is Triggered - With this option selected, the promotion codes expire when the charge reaches a certain amount. You also need to configure the Amount and Unit of Time fields to determine the charge amount that triggers to end the promotion code.
  • (Optional) Billing Period (Default: Month) - The invoicing billing period. The default value is Month
  1. (Optional) In the Custom Fields section, add custom fields based on your business needs:

  • Click the Add Field button, and select the type of the custom field from one of the following options: 
    • String Field

    • DateTime Field 

  • Enter the key-value pair in the corresponding field. For example, enter the country in the Key field and United States in the Value field or enter the applicable date in the Date field.

  • Select the Validation check box if you want to enable the validation for the specified custom field.

  1. Click Create.

Import promotion codes

Before importing promotion codes into Zuora, ensure that you have a valid CSV file that contains the promotion codes you need. Download either of the following templates and complete the CSV file with promotion code details as needed:

Subsequently, you can take the following steps to import promotion codes:

  1. Launch Promotion Codes from your Zuora tenant.
  2. Click the Background Jobs tab. All promotion code background jobs for all child campaigns are displayed in this tab.
  3. Expand the Actions dropdown list.
    • To import multi-use promotion codes, select Import - Create Multi Use Promotions.
    • To import single-use promotion codes, select Import - Create Single Use Codes.
  4. Click the Choose Files button and select the CSV file you want to upload.
  5. Click Create. The job is then displayed in the job list.

The Results column indicates whether the job has succeeded. If the import job succeeds, the imported promotion codes then become available for use within the app instance. If it failed, an output file that contains failure reasons will be automatically generated. You can locate the failed import job, click manage_icon on the left, and select Show to find the output file for troubleshooting.

Export promotion codes

Export multi-use codes

Take the following steps to export multi-use promotion codes:

  1. Launch Promotion Codes from your Zuora tenant.
  2. Click the Background Jobs tab. All promotion code background jobs for all child campaigns are displayed in this tab.
  3. Expand the Actions dropdown list, and select Export Multi Use Promotions. Then a new job is displayed in the background job list.
  4. Click manage_icon on the left of the new job, and select Show.
  5. In the job details dialog, click the link to download the attached CSV file that contains all generated promotion codes. 

Export single-use codes

Take the following steps to export signle-use promotion codes:

  1. Launch Promotion Codes from your Zuora tenant.
  2. Click Background Jobs. The promotion code background jobs for all child campaigns are displayed in this tab.
  3. Locate the campaign job that you want to export with the - Export suffix, and click manage_icon on the left.
  4. Select Show.
  5. In the job details dialog, click the link to download the attached CSV file that contains all generated promotion codes. 

Specific to single-use promotion codes, you can also use the "Creates a CSV of the single use campaign" API operations in the API Docs to export CSV files as an alternative. 

Subsequently, you can distribute the generated promotion codes to your customers who are eligible for the campaigns. See assign single-use codes as an example. The percentage and the number of consumed promotion codes will be reflected in the charts in the Dashboard tab of both the campaign and the App instance homepage.

Copy or move child campaigns

Take the following steps to copy or move a child campaign:

  1. Launch Promotion Codes from your Zuora tenant.
  2. In the Campaigns tab, locate the campaign that includes the source child campaign, and click check_icon to enter the homepage of the campaign. 
  3. Scroll to the bottom of the campaign homepage, select the child campaign that you want to copy or move, and click Copy_move_icon. Note that you can select multiple campaigns at one time.
  4. In the dropdown list, select Copy/Move. The Move / Copy Code Group dialog is then displayed.
  5. In the first dropdown list of the dialog, select Copy or Move.
  6. In the section dropdown list, select the target campaign that you want to copy or move the selected child campaigns to.
  7. Click Done.

Then you can find that the selected child campaigns are displayed on the homepage of the target campaign with identical configuration. 

Update child campaign configuration

Take the following steps to update a child campaign configuration:

  1. Launch Promotion Codes from your Zuora tenant.
  2. In the Campaigns tab, locate the campaign that includes the target child campaign, and click check_icon to enter the homepage of the campaign. 
  3. Scroll to the bottom of the campaign homepage, locate the child campaign that you want to update, and click manage_icon on the left.
  4. Select Edit from the expanded menu.
  5. In the Update Promo dialog, make the corresponding changes to the configuration of the selected child campaign.
  6. Click Update to save the changes.

Delete child campaigns

Take the following steps to delete a child campaign:

  1. Launch Promotion Codes from your Zuora tenant.
  2. In the Campaigns tab, locate the campaign that includes the target child campaign, and click check_icon to enter the homepage of the campaign. 
  3. Scroll to the bottom of the campaign homepage, locate the child campaign that you want to delete, and click manage_icon on the left.
  4. Select Delete from the menu.
  5. In the confirmation dialog, click OK. Then this child campaign is deleted from its parent campaign.

Set up callouts 

To get notified when campaign updates occur, you can set up callouts in Promo Codes. Configured callouts will be triggered when a child campaign is created or updated in the app instance. 

Take the following steps to configure a callout:

  1. Launch Promotion Codes from your Zuora tenant.
  2. Click the Advanced tab.
  3. In the Url field, enter the target callout endpoint.
  4. In the Username and Password fields, enter the basic authentication credentials of the target callout endpoint, respectively.
  5. Click Update.