Coupons

How It Works

Coupon promotions are a marketing tool for getting new clients and increasing sales. A player who uses a coupon gets a reward linked to this coupon (a virtual currency package, game key, or virtual item). Players enter the coupon code on the website, directly in the game, or in the mobile application.

Main features:

  • Set up coupons as a part of a campaign.
  • Decide the number of times the coupon can be used in a campaign.
  • Determine the number of times one player can use the same coupon.
  • Select the number of coupons one player can use in a campaign.

Restrictions:

  • If you linked a game key to a coupon and there are extra keys in a campaign that don’t get sold, one of them will be emailed to a player who has a coupon. If there are no keys left in the campaign, the player’s request to use a coupon will be declined.
  • You can generate coupons only when you create a coupon campaign.
  • You can’t link an item that has regional sale restrictions to a coupon.

User flow:

  1. The player uses a coupon.
  2. The item that is linked to a coupon is granted to the player in one of the following ways: directly to the inventory (a virtual item or virtual currency package), by email, or by game entitlement system (a game key).

Note: Partners can receive a coupon redemption data in a webhook. When they get it, they can give game ownership rights to the user on their own.

Who Can Use It

  • Partners who have already integrated the In-Game Store solution and want to use coupon promotions.
  • Partners who want to increase sales with the help of coupon promotions.

How to Get It

Prerequisites

  1. Connect Store to your project.
  2. Set up the Promotions module.

Integration Flow

  1. Create a promotion.
  2. Specify the required parameters:
    • Enter a promotion name.
    • Choose the type: Coupons.
  3. Configure coupons.
  4. Implement the Redeem a coupon code method.
  5. Implement methods for getting a list of items linked to a coupon.

Coupon Configuration

Info: The functionality described in this paragraph isn’t fully implemented yet. Fill in a feedback form to integrate a service.

To configure coupons, choose:

  1. A reward type the player gets after using a coupon from these available options:
  2. Coupon generation method.
  3. The campaign start and end date and the number of available coupons.

Coupon with a Virtual Currency Package

You should specify the currency package for a virtual currency package coupon. To create a virtual currency package:

  1. Go to the Virtual currency module settings and specify the following parameters:
    • Image
    • SKU
    • Currency name
    • Price of one unit of virtual currency
    • Default currency
  2. Create a required number of currency packages and specify the following parameters for every one of them:
    • Image
    • SKU
    • Name
    • Description
    • Used currency
    • Amount of currency in a package
    • Price
    • Default currency
  3. Enable the currency packages display in Store.

Coupon with a Game Key

You should specify a game key SKU and DRM info for a game key coupon. There are 2 options:

  1. Coupons are generated for the already set DRM. The parameter is set when generating coupons.
  2. The player has the ability to choose a DRM when using a coupon.

Coupon with Virtual Items

You should specify the virtual item SKU and its quantity for a virtual items coupon. You can choose one or several items with different SKUs for one coupon including bundles and non-renewing subscriptions.

Generating Coupons

A campaign may include one or several coupons. The coupon format has 2 options:

  1. Manually entered line — suitable for a campaign with only one coupon that can be used many times (maximum is 128 characters).
  2. Generated line — line of numerals and Latin symbols (10 characters).
You can generate coupons when creating a coupon promotion. Additional coupon generation or uploading your codes are made on demand.

Note: Coupon code depends on the letter case. For example, winter2021 and WINTER2021 — are 2 different coupons.

Redeeming a Coupon by Code

Implement the Redeem a coupon code method callback to redeem a coupon.

EXAMPLE

{
    "coupon_code": "kjsdhsiu234"
}

Getting a List of Items in a Coupon

Implement the callback of a method for getting a list of items in a coupon.

EXAMPLE

{
   "items": [
       {
           "type": "virtual_currency",
           "sku": "crystal",
           "name": "Orcish crystal",
           "description": "Magic orcish crystal",
           "image_url": "https://crystal.png",
           "quantity": 5000
       },
       {
           "type": "virtual_good",
           "sku": "sword",
           "name": "Orcish sword",
           "description": "Magic orcish sword",
           "image_url": "https://sword.png",
           "quantity": 1
       }
            ]
}