Redeem promo code

Redeem promo codeClient-side

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

Redeems a code of promo code promotion. After redeeming a promo code, the user will get free items and/or the price of the cart and/or particular items will be decreased.

SecurityAuthForCart

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

Request Body schema: application/json

coupon_code

string [ 1 .. 128 ] characters

Default: "SUMMER2021"

Unique code of promo code. Contains letters and numbers.

object or null

required

string

Default: "current"

Cart ID.

object

The reward that is selected by a user. Object key is an SKU of a unit, and value is an SKU of one of the items in a unit.

property name*

additional property

string

Responses

200

Promo code was successfully redeemed.

401

Authentication not passed or wrong.

403

Authorization header not sent.

404

Enter valid promo code.

422

Invalid request.

Request samples

Response samples

application/json

{"cart_id": "cart_id",
"is_free": false,
"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",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [ ],
"promotions": [{"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"bonus": [{"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [{"item_id": 175232,
"sku": "value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": false
},
{"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{"attributes": [ ],
"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"groups": [ ],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"name": "Sword Xsolla Skin",
"price": [ ],
"quantity": 1,
"sku": "swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable",
"virtual_prices": [ ],
"promotions": [{"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"bonus": [{"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [{"item_id": 175232,
"sku": "value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {"amount": "6150.0000000000000000",
"amount_without_discount": "12300.0000000000000000",
"currency": "USD"
},
"rewards": {"bonus": [{"item": {"name": "Sword Xsolla Skin",
"sku": "swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable",
"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png"
},
"quantity": 1
}
],
"discount": {"percent": null
},
"discounted_items": [{"sku": "booster_mega_1",
"discount": {"percent": "50.00"
}
}
],
"is_selectable": false
}
}