Skip to main content

Create Intelli codes

Zuora

Create Intelli codes

  1. Last updated
  2. Save as PDF

Intelli Code Overview

The regular promotion codes only apply to scenarios where your business logic can be determined upfront. If you have emerging requirements after the creation of child campaigns, you must create new promotion codes to accommodate your needs.

To provide more flexibility and simplify your integration process with Promo Codes, we have introduced Intelli codes that can be validated or consumed based on configured rules. The number of promotion codes can also be reduced because one code can be applied to multiple scenarios.

Benefits of Intelli codes

  • Decrease the number of Promo Codes created, which leads to:
    • Overall performance improvement.
    • Increase in operational efficiency through less configuration time.
    • Faster campaign rollouts.
  • Less upfront business logic when integrating that will provide:
    • Faster implementation for each new promotion by decoupling the front-end UI and business logic from promotion code processing.
    • Increase market share through more configuration options and customization.

Rules

Rules are associated with the Intelli Code object. When an Intelli code is validated, all rules associated with this Intelli code are checked. If the rule is validated, the configured rules will become effective and override the existing configuration of the Intelli code.

Rules are sorted by creation date by default. 

Work with Intelli codes

To leverage Intelli codes to meet your business requirements, you need to:

  1. Create an Intelli promotion that contains one or multiple promotion codes.
  2. Add rules to the created Intelli promotion to determine which conditions must be met for the promotion codes to be validated or redeemed.

See the following sections for instructions.

Create Intelli promotion

Take the following steps to create an Intelli 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 promotion codes, and click icon_details to enter the detailed page of this campaign.
  3. Scroll to the bottom and select Actions > Intelli Promotion to create a new child campaign. The New Promotion window opens.
  4. Specify the child campaign details.
    1. In the IntelliPromo Fields section, complete the following fields:
      • Child Campaign - The name of the child campaign that consists of a group of promotion codes.
      • Effective From - Activation date of the child campaign.
      • Effective To - Expiration date of the child campaign.
    2. In the Code Details section, select promotion code type from the Code Type dropdown list.
      • 1 Multi-Use Code - A single code specific for one promotion, but can be used by multiple customers. 
      • Child Codes - Numerous codes generated for one promotion. Each code is specific to one customer or can be used by multiple customers.
    3. If you select 1 Multi-Use Code for the Code Type field, complete the following fields: 
      • Initial Quantity - The amount of the codes that are initially issued. The value of this field cannot be changed after the initial configuration.
      • Available Quantity - The amount of the remaining codes that can be redeemed. 
      • Code - Identify code value to be linked to the child campaign and will be used by customers
    4. If you select Child 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.
      • # Auto-generated 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.
      • Redemptions per code - The number of times each code can be used. 
    5. In the Discounts section, select the discount type from the Discount Type dropdown list. 
      • None - No discount.
      • Percent Discount Rate Plan - A percentage-based discount rate plan.
      • Fixed Amount Discount Rate Plan - A fixed amount discount rate plan.
    6. Complete the discount rate plan configuration.
      • 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/Amount for USD (Default: <auto_populated_value>) - 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. 
    7. (Optional) In the Custom Attributes section, add custom fields based on your business needs:
      1. Click the Add Field button, and select the type of the custom field from one of the following options: 
        • String Field
        • DateTime Field 
      2. Enter the key-value pair in the corresponding field. For example, enter country in the Key field and United States in the Value field.
      3. Select the Validation check box if you want to enable the validation for the specified custom field. 
  5. Click Create. The new child campaign is then created and displayed in the child campaign table on the detailed page of the campaign.

Add rules to Intelli promotion

After an Intelli promotion is created, you can add rules that determine which conditions must be met for the promotion codes to be redeemed.

Take the following steps to create a rule for Intelli promotion codes:

  1. On the detailed page of this campaign, find the Intelli promotion codes you created, click icon_config, and select Rules for this promotion. The Rules for your Intelli codes window opens.
  2. Click New Rule in the window. 
  3. In the Requirements tab, configure the basic settings of the new rule.
    1. In the Name field, enter the name of the rule.
    2. In the Rateplan Rules section, select the rate plan where the promotion codes can be applied from the Rate Plan dropdown list, then click Add RatePlan. The selected product and the product rate plan ID are then added to the table below. You can also click the icon_delete to remove a selected product rate plan.
    3. (Optional) In the Custom Attributes Rules section, add custom fields based on your business needs:
      1. Click the Add Field button, and select the type of the custom field from one of the following options: 
        • String Field
        • DateTime Field 
      2. Enter the key-value pair in the corresponding field. For example, enter promotionChannel in the Key field and Web in the Value field.
      3. Select the Validation check box if you want to enable the validation for the custom field and value. With this check box selected, the rules can become effective only when the request contains the specified custom fields and values.
  4. Click the Overrides tab.
  5. In the Overrides tab, complete the settings of the promotion you want to override.
    1. In the Discount Rateplan section, select the discount type from the Discount Type dropdown list. 
      • None - No discount.
      • Percent Discount Rate Plan - A percentage-based discount rate plan.
      • Fixed Amount Discount Rate Plan - A fixed amount discount rate plan.
    2. Complete the discount rate plan configuration. The discount rate plan details you configure in this tab will override the ones you configure for the Intelli promotion.
      • 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/Amount for USD (Default: <auto_populated_value>) - 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. 
    3. (Optional) In the Custom Attributes section, add custom fields based on your business needs. The custom fields and values you configure in this tab will override the ones you configure for the Intelli promotion. 
      1. Click the Add Field button, and select the type of the custom field from one of the following options: 
        • String Field
        • DateTime Field 
      2. Enter the key-value pair in the corresponding field. For example, enter country in the Key field and Singapore in the Value field.
      3. Select the Validation check box if you want to enable the validation for the specified custom field. 
    4. (Optional) In the Valid section, select the When requirements are met, would you like for the code to be valid? check box. With this check box selected, the promotion codes are still valid and can be redeemed after the rule conditions are met.
  6. Click Create. The new rule is then displayed in the Promo Details tab in the Rules for your Intelli promotion window. If you want to update or remove a rule for an Intelli promotion, you can click icon_edit or icon_delete2.png to update or remove the corresponding rule.

Later, when anyone wants to use the Intelli codes you distributed, the selected product rate plan and custom fields data are passed in the request, and only the users who are validated based on the configured rules can get the correct discount rate plan.

Limitations

  • It is possible that rules override each other. If two rules are satisfied, the rule that is created later will override the previous one. 
  • Apart from the creation order, rules do not have any priority.
  • Rules can have multiple conditions for product rate plans and custom attributes, but the override action can take place only once when the rule becomes effective.
  • The following conditions must be met for a rule to take effect:
    • At least one rate plan condition is satisfied.
    • All custom attributes conditions are satisfied.
  • An Intelli code returns only one discount rate plan.