Xsolla-logo

Get redeemable promotion by code

get/v2/project/{project_id}/admin/promotion/redeemable/code/{code}

Gets the promotion by a promo code or coupon code.

SecuritybasicAuth
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
code
required
string [ 1 .. 128 ] characters

Unique case-sensitive code. Contains letters and numbers.

Example: WINTER2021
Responses
200

Promotion was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

404

Redeemable code not found. Make sure the provided code value is correct.

405

Incorrect redeemable code format. The code can contain only letters and numerals.

Request samples
Response samples
application/json
{
  • "date_start": "2023-05-01T01:00:00+05:00",
  • "date_end": "2023-05-31T23:59:59+05:00",
  • "bonus": [ ],
  • "is_enabled": true,
  • "external_id": "falls2023",
  • "name": {
    },
  • "redeem_total_limit": 2,
  • "redeem_user_limit": 3,
  • "redeem_code_limit": null,
  • "total_limit_state": {
    },
  • "discount": {
    },
  • "discounted_items": [
    ]
}