Xsolla-logo

Set coupon limit for specified user

put/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}

Sets the number of times the specified user can use a coupon after it was increased or decreased.

User limit API allows you to limit the number of times users can use a coupon. For configuring the user limit itself, go to the Admin section:

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
external_id
required
integer

Promotion external ID. Unique promotion identifier within the project.

Example: coupon_44056_1
Request Body schema: application/json
required
object
user_external_id
required
string non-empty ^\S+$

User external ID.

available
required
integer

Remaining number of the coupon uses available to the user within the limit applied.

Responses
200

Successfully received coupon limits for a user.

401

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

404
422
Request samples
application/json
{
  • "user": {
    },
  • "available": 0
}
Response samples
application/json
{
  • "per_user": {
    }
}