Погашение кода купона

post/v2/project/{project_id}/coupon/redeem

Погашает код купона. Пользователь получает бонус после погашения купона.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056

Request Body schema: application/json

coupon_code

string [ 1 .. 128 ] characters

Default: "WINTER2021"

Уникальный код купона. Содержит буквы и цифры.

object

Награда, выбранная пользователем. Ключ объекта — это артикул юнита, а значение — артикул одного из товаров в юните.

property name*

additional property

string

Responses

200

Купон успешно погашен.

401

Данные для аутентификации не переданы или ошибочны.

403

Заголовок Authorization не отправлен.

404

Введите действительный код купона.

422

Неверный запрос.

Request samples

application/json

{"coupon_code": "WINTER2021",
"selected_unit_items": {"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}

Response samples

application/json

{"items": [{"attributes": [ ],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [{"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": null
},
"is_free": true,
"name": "Xsolla Booster Mega",
"price": null,
"quantity": 1,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [ ]
}
]
}