跳转到内容
/
设置期间

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。

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

响应

OK.

正文application/json
idinteger
periodsArray of objects

日期/时间范围。

响应
application/json
{
  "id": 17840,
  "periods": [
    { … }
  ]
}

设置期间

请求

获取促销有效的日期/时间范围。设置促销有效的日期/时间范围。 如果促销是只读的(read_only=true)，则不能编辑现有时段，但可以添加新时段。

注意

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

安全
basicAuth
路径
merchant_idinteger必需

商户ID。

promotion_idinteger必需

促销活动 ID。

正文application/json必需
periodsArray of objects

日期/时间范围。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

响应

No content.

检查促销活动

请求

您需要在激活促销之前查看促销。 此方法返回错误列表（如果有）。

注意

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

安全
basicAuth
路径
merchant_idinteger必需

商户ID。

promotion_idinteger必需

促销活动 ID。

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

响应

OK.

正文application/jsonArray [
componentstring
messagestring
]
响应
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

优惠券

操作

Subscription management

操作