Get coupon rewards

Gets coupons rewards by its code. Can be used to allow users to choose one of many items as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus (type=unit).

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id required	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056
coupon_code required	string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: WINTER2021

Responses

200

List of coupon rewards was successfully received.

401

Authentication not passed or wrong.

403

Authorization header not sent.

404

Enter valid coupon code.

422

Invalid request.

Request samples

Response samples

application/json

{"bonus": [{"item": {"sku": "game_1",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [{"sku": "game_key_01",
"name": "Game name",
"type": "game_key",
"is_free": false,
"drm_name": "Steam",
"drm_sku": "steam"
},
{"sku": "game_key_02",
"name": "Game name",
"type": "game_key",
"drm_name": "Origin",
"drm_sku": "origin"
}
]
},
"quantity": 1
},
{"item": {"sku": "game_2",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [{"sku": "game_key_01",
"type": "game_key",
"name": "Game name",
"drm_name": "Steam",
"drm_sku": "steam"
}
]
},
"quantity": 2
}
],
"discount": {"percent": "10.00"
},
"is_selectable": true
}