跳转到内容
/
获取优惠券

Subscriptions API (2.0)

概览

  • Version: 2.0
  • 服务器：https://api.xsolla.com/merchant/v2/

本API参考介绍管理订阅、优惠券和促销活动的端点。 如需了解关于订阅的详细信息，请参考产品指南和词汇表。

下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/subscriptions/

令牌

操作

计划

操作

产品

操作

Subscription management

操作

支付

操作

促销活动

操作

优惠券

操作

将优惠券活动添加至促销活动

请求

将优惠券活动附加到特定促销活动。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全
basicAuth
路径
merchant_idinteger必需

商户ID。

promotion_idinteger必需

促销活动 ID。

正文application/json必需
campaignsArray of integers必需

优惠券活动ID数组。

示例: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

响应

No content.

获取优惠券

请求

按代码获取有关优惠券的信息。

安全
basicAuth
路径
project_idinteger必需

项目ID。

codestring必需

优惠券代码。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/coupons/{code}/details'

响应

OK.

正文application/json
keystring

用户属性键值。

list_of_valuesArray of objects

enum 类型可能值的数组。

nameobject

用户属性本地化名称的数组。

skip_condition_on_nonexistent_keyboolean

键值不存在时是否应跳过条件。

typestring

键类型。

枚举"int""string""enum""date"
visibleboolean
响应
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

兑换优惠券

请求

按代码兑换优惠券。

安全
basicAuth
路径
project_idinteger必需

项目ID。

codestring必需

优惠券代码。

正文application/json必需
user_idstring必需

用户ID。

示例: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

响应

OK.

正文application/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
响应
application/json
{
  "campaign_code": "new_campaign",
  "coupon_code": "ddgf5bn4",
  "coupon_id": 89613996,
  "expiration_date": "2019-12-31T00:00:00+00:00",
  "is_active": true,
  "project_id": 12345,
  "redeems_count_for_user": 10,
  "redeems_count_remain": 20,
  "subscription_coupon": null,
  "virtual_currency_amount": 200,
  "virtual_items": []
}

Subscription management

操作