Free game keys

How it works

Free game keys are a type of item that the user can get without spending virtual or real currency.

Examples of usage:

1. You can give away free DLC to users who already own the main game to reward their loyalty.
2. You can gift games for a limited time to attract new users.

How to get it

1. Create a free game key in one the following ways:
   • via Publisher Account
   • via API calls
2. Set up delivery of free game keys.

Create via Publisher Account

To create a free game key:

1. Open your project in Publisher Account.
2. Click Store in the side menu.
3. In the Game key pane, click:
   • Connect – if you don’t have game keys
   • Configure – if you previously connected game keys
4. On the Game keys tab, click New game key package > Create manually.
5. Set the basic package settings:
   • SKU
   • Game title
   • Attributes (optional)
6. Click Save and continue.
7. Select the game distribution platforms and upload a CSV or TXT file with keys.
8. If you want to sell the game before its official release, set the Pre-orders toggle to On. You can specify the release date when the game keys will be delivered to users when creating the keys or later.
9. Click Save and continue.
10. Toggle Free game key.
If the game is published on the Steam platform, you can import pricing settings from that platform. To do this, click Import via link and specify the link to your game on Steam.
11. You can set a limit for purchasing a game key. To do this, switch the Limit the number of times one user can buy game key toggle to On and specify the number of keys a user can purchase.

12. Click Save and continue.

To make changes to the created game keys package, select the key on the Game Keys tab, make changes, and save.

Create via API calls

1. To create free game keys, use API calls from the Admin subsection in the Game keys method group. When creating or editing an item, pass is_free = true in the request body. This setting is located in an array of unit_items objects in the request body.
2. To create an order with free items, call the Create order with specified free item API.
3. Get a user’s order status.

Set up delivery of free game keys

Fast purchase

If a user uses fast purchase (a user doesn’t use a cart), then call the Create order with specified free item AP to allow them to receive free keys. The delivery of free game keys to the user’s inventory occurs immediately after a successful request to this method (without the need to open the Pay Station payment form).

Cart purchase

If the user uses cart purchase:

• If the user’s cart contains both paid and free items, call the standard Create order with all items from particular cart and Create order with all items from current cart API for creating orders. Users will make a payment for the order through the Pay Station payment form.
• If the user’s cart contains only free items, call the Create order with free cart and Create order with particular free cart API to get a free cart. In this case, the payment interface will not be used, and payments are processed automatically. A form will open asking the user to provide an email address. After that, the order will be placed, and the user is redirected to the page with the order status.

Last updated: November 11, 2024