跳转到内容
/
添加优惠券至优惠券活动

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。

正文application/json必需
campaign_codestring必需

优惠券活动名称。

campaign_namesobject必需

包含优惠券活动本地化名称的对象。

campaign_names.​arstring

阿拉伯语。

campaign_names.​bgstring

保加利亚语。

campaign_names.​cnstring

中文（简体）。

campaign_names.​csstring

捷克语。

campaign_names.​destring

德语。

campaign_names.​enstring

英语。

campaign_names.​esstring

西班牙语。

campaign_names.​frstring

法语。

campaign_names.​hestring

希伯来语。

campaign_names.​itstring

意大利语。

campaign_names.​jastring

日语。

campaign_names.​kostring

韩语。

campaign_names.​plstring

波兰语。

campaign_names.​ptstring

葡萄牙语。

campaign_names.​rostring

罗马尼亚语。

campaign_names.​rustring

俄语。

campaign_names.​thstring

泰语。

campaign_names.​trstring

土耳其语。

campaign_names.​twstring

中文（繁体）。

campaign_names.​vistring

越南语。

campaign_redeems_count_for_userinteger

每个用户在一个优惠券活动中最多可兑换的优惠券数量。如传入null，则可兑换数量不限。

expiration_datestring(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的活动到期日。

project_idinteger必需

项目ID。

redeems_countinteger

可兑换优惠券的最大数量。如传入null，则数量不限。

redeems_count_for_userinteger

每个用户最多可兑换的优惠券数量。如传入null，则可兑换数量不限。

subscription_couponobject

奖励中包含订阅参数的对象。

virtual_currency_amountnumber(float)

奖励中的虚拟货币数。

virtual_itemsobject

奖励中的虚拟物品参数数组。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

响应

Created.

正文application/json
idinteger
示例: 9134
响应
application/json
{
  "id": 9134
}

添加优惠券至优惠券活动

请求

将优惠券代码添加到优惠券活动中。

注意

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

安全
basicAuth
路径
merchant_idinteger必需

商户ID。

campaign_idinteger必需

优惠券活动ID。

正文application/json必需
coupon_codestring必需

优惠券代码。

示例: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

响应

No content.

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

请求

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

注意

此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.

Subscription management

操作