Skip to content
/
Get Rewards

Subscriptions API (2.0)

Overview

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

This API reference describes endpoints for managing subscriptions, coupons, and promotions. To get more information about Subscriptions, see the product guide and the glossary.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/subscriptions/

Token

Operations

Plans

Operations

Products

Operations

Subscription management

Operations

Payments

Operations

Promotions

Operations

Set Rewards

Request

Sets the rewards for a promotion. If the promotion is read-only (read_only = true), you cannot update the rewards.

Notice

This API call does not contain the project_id path-parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

Security
basicAuth
Path
merchant_idintegerrequired

Merchant ID.

promotion_idintegerrequired

Promotion ID.

Bodyapplication/jsonrequired
purchaseobject

Set the reward for the whole purchase.

packageobject

Set the reward for a virtual currency package.

itemobject

Set the reward for specific virtual items.

subscriptionobject

Sets the reward for a subscription.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Responses

No content.

Get Rewards

Request

Gets the list of rewards associated with a promotion.

Notice

This API call does not contain the project_id path-parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

Security
basicAuth
Path
merchant_idintegerrequired

Merchant ID.

promotion_idintegerrequired

Promotion ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards'

Responses

OK.

Bodyapplication/json
idinteger
purchaseobject

Set the reward for the whole purchase.

packageobject

Set the reward for a virtual currency package.

itemobject

Set the reward for specific virtual items.

subscriptionobject

Sets the reward for a subscription.

Response
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Toggle Promotion

Request

Toggles the status of a promotion from enabled to disabled and vice versa.

Notice

This API call does not contain the project_id path-parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

Security
basicAuth
Path
merchant_idintegerrequired

Merchant ID.

promotion_idintegerrequired

Promotion ID.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/toggle'

Responses

No content.

Coupons

Operations

Subscription management

Operations