Coupons

How it works

Coupon campaigns are a marketing tool designed to attract potential users to your product and drive sales. When a user redeems a coupon, they receive one or more bonus items. The following items can be used as rewards:

• virtual currency packages
• game keys
• virtual items
• bundles

A coupon contains a unique code. To redeem a coupon, the user should enter the code within the game client or a game’s store, including the Web Shop.

Key features:

• Setting the total number of redemptions within a campaign.
• Setting the number of redemptions per user within a campaign.
• Multiple generation of codes for coupons.
• Applying regional restrictions for campaigns and items linked to a coupon.

Limitations:

• If game keys are used as a bonus item, the key will be sent to the user via email or to the entitlement system after redemption. If the campaign runs out of keys, the user will not be able to redeem the coupon.
• If regional restrictions are applied to a coupon campaign, users from those regions won’t be able to redeem the coupon.
• If a coupon includes at least one bonus item with a regional restriction, a user from that region won’t be able to receive the item using this coupon.

1. Example: A shield and sword are offered as a bonus with the coupon. The shield has a regional restriction and is available for purchase only in the US. If a user outside the US enters the coupon code, an error will be returned in the response to the Verify promotion code or Redeem coupon code calls. The user will not be able to obtain any of the items from the coupon.

User flow:

1. An authorized user goes to the store.
2. The user enters the coupon code.
3. Xsolla returns a list of available bonus items for the coupon (optional).
4. The user selects bonuses (optional).
5. The user redeems the coupon.
6. The items linked to the coupon are credited to the user in the same way as a regular purchase.

Set up coupon campaign

Prerequisites

Before setting up a coupon campaign, you must configure the items that will be issued as bonuses.

To create items manually in your project in Publisher Account, go to the Items catalog > All items section. Detailed information about this and other methods for creating items is available in the Items catalog section of documentation.

Set up in Publisher Account

To create a new coupon campaign:

1. In your project in Publisher Account, go to the LiveOps > Promotions section.
2. On the Promotions tab, click Create promotion.

3. Specify main promotion parameters:

1. 1. Specify Promotion name.

1. 2. In the Promotion type drop-down list, select Coupon.

1. 3. In the External ID field, specify a promotion ID used for managing promotions via API calls.

1. 4. In the Select bonus items drop-down list, select the type of an item to be granted to a user upon coupon redemption.

1. 5. Select the items to be granted to a user upon coupon redemption.

1. 1. For virtual items, specify the quantity for each item.

1. 1. For game keys, specify when the platform will be determined:
      • To pre-assign a specific platform (e.g., Steam), select Select DRM during code generation from the Type of DRM selection drop-down list. Then, select the platform from the DRM drop-down list.
      • To let the user choose, select Player selects DRM at redemption from the Type of DRM selection drop-down list.

Note

You can select different types of items as bonuses. To switch between different item types, use the Select bonus items field. Information about all selected items is displayed in the List of bonus items area.

1. 6. Click Next.

4. Configure coupon redemption limits:

1. 1. To limit the total number of coupon redemptions across all users within a campaign, set the Limit total number of coupon redemptions toggle to On and specify the maximum number of redemptions.

1. 2. To limit the number of coupons a single user can redeem within a campaign, set the Limit total number of redemptions per user toggle to On and specify the maximum number of redemptions per user.

1. 3. To limit the number of times any unique coupon code can be redeemed across all users, set the Limit number of unique coupon code redemptions toggle to On and specify the maximum number of redemptions for the coupon.

1. 4. Click Next.

5. Specify the campaign’s validity period: a time zone, start date, and end date. To create a campaign without an end date, check the No end date box.
6. Click Next.
7. Review the campaign settings.
8. Click Save and exit.

To add coupon codes to a campaign:

1. In your project in Publisher Account, go to the LiveOps > Promotions section.
2. In the row with coupon promotion, click ••• and choose Edit promotion in the drop-down list.

3. Go to the Codes tab.
4. To generate codes automatically:

1. 1. In the Code string format drop-down list, select Auto-generated.

1. 2. Specify the number of codes to generate and click Generate.

5. To add codes manually:

1. 1. In the Code string format drop-down list, select Manually entered.

1. 2. Enter the coupon code and click Create.

1. 2. Repeat the previous step to add the required number of codes.

6. Download a CSV file with the codes (optional).

To make the campaign available to users, you must activate it. To do this:

1. In your project in Publisher Account, go to the LiveOps > Promotions section.
2. In the row with coupon promotion, click ••• and choose Edit promotion in the drop-down list.
3. In the drop-down list in the upper-right corner, select Activate promotion.

Set up via API

To set up and manage coupon campaigns via API, use the following calls:

Set up coupon redemption in your application or website

Coupon redemption in your own UI

To allow users to redeem coupons in your application or website:

3. Ensure that items are correctly granted to the user upon coupon redemption.

1. If you have already implemented an in-game store in your application or on your website, no additional setup is required. Items linked to a coupon are granted to the user in the same way as a standard purchase.

Coupon redemption on website created with Xsolla

To display the code entry field on your website:

1. Open your project in Publisher Account and go to the Storefronts > Websites section.
2. In the Sites section, select your site and click Open Site Builder.
3. In the main area of the builder, choose a place where you want to add a new block and click Add block.
4. Select the Promo codes block.
5. Customize the block appearance (optional):
   • Edit the block’s header and description text.
   • Set a custom background for the block.
   • Change the button style.
   • Edit the text for the coupon redemption button.
6. To apply changes, publish the website:

1. 1. In the upper-right corner of the site builder, click Publish.

1. 2. Check the boxes next to the pages you want to publish.

1. 3. Click Publish.