跳转到内容
/
创建计划

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/

令牌

操作

计划

操作

列示所有计划

请求

列示所有重复性计划。

安全
basicAuth
路径
project_idinteger必需

项目ID。

查询
plan_idinteger

订阅计划ID。

limitinteger必需

页面上元素数量的限制。

offsetinteger

元素编号，从该元素开始生成列表（从0开始数）。

external_idstring

外部计划标识符。

group_idstring

这些计划与之连接的组的 ID。

product_idinteger

这些计划与之连接的产品的 ID。

querystring

搜索查询（搜索name.en（默认区域位置））。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/subscriptions/plans?plan_id=0&limit=0&offset=0&external_id=string&group_id=string&product_id=0&query=string'

响应

OK.

正文application/jsonArray [
billing_retryobject

账单扣费重试详情。

chargeobject

账单详情。

descriptionobject

计划描述。由"localization":"plan description"组成的键值对。

expirationobject

订阅到期详情。

external_idstring

外部计划标识符。

grace_periodobject

带有宽限期相关数据的对象。

group_idstring or null

计划关联的组ID。

idinteger

订阅计划ID。

nameobject

计划名称。值包含 "localization":"plan name" 对。

project_idinteger

项目ID。

refund_periodinteger or null

订阅计划可退款的时间期限（单位为天）。

statusobject
tagsArray of strings

计划标签。

trialobject

试用期详情。

localized_namestring

计划名称（使用默认语言英文），复制name.en值。

]
响应
application/json
[
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "3b355320",
    "grace_period": { … },
    "group_id": null,
    "id": 241037,
    "localized_name": "Platinum VIP",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  },
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "0fe1b6fc",
    "grace_period": { … },
    "group_id": null,
    "id": 241038,
    "localized_name": "Gold Status",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  }
]

创建计划

请求

创建重复性计划

安全
basicAuth
路径
project_idinteger必需

项目ID。

正文application/json必需
billing_retryobject

账单扣费重试详情。

chargeobject必需

账单详情。

charge.​amountnumber(float)

支付金额。

charge.​currencystring

购买币种。参照ISO 4217标准的三字母货币代码。

charge.​periodobject必需

账单周期。

charge.​period.​typestring必需

时间单位。可以是day、month或lifetime。

枚举"day""month""lifetime"
charge.​period.​valueinteger必需

时间单位数。该值取决于类型参数：
- 如果type为day，可以是1-366
- 如果type为month，可以是1-12
- 如果type为lifetime，则为0

charge.​pricesArray of objects

不同货币下的价格列表。

descriptionobject

计划描述。由"localization":"plan description"组成的键值对。

expirationobject

订阅到期详情。

external_idstring

外部计划标识符。

grace_periodobject

带有宽限期相关数据的对象。

group_idstring or null

计划关联的组ID。

idinteger

订阅计划ID。

nameobject必需

计划名称。值包含 "localization":"plan name" 对。

name.​arstring

阿拉伯语。

name.​bgstring

保加利亚语。

name.​cnstring

中文（简体）。

name.​csstring

捷克语。

name.​destring

德语。

name.​enstring

英语。

name.​esstring

西班牙语。

name.​frstring

法语。

name.​hestring

希伯来语。

name.​itstring

意大利语。

name.​jastring

日语。

name.​kostring

韩语。

name.​plstring

波兰语。

name.​ptstring

葡萄牙语。

name.​rostring

罗马尼亚语。

name.​rustring

俄语。

name.​thstring

泰语。

name.​trstring

土耳其语。

name.​twstring

中文（繁体）。

name.​vistring

越南语。

project_idinteger

项目ID。

refund_periodinteger or null

订阅计划可退款的时间期限（单位为天）。

statusobject
tagsArray of strings

计划标签。

trialobject

试用期详情。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/subscriptions/plans' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 10,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 8,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 1000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "2x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "status": {
      "value": "active"
    },
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

响应

已创建。

正文application/json
external_idstring
plan_idinteger
响应
application/json
{
  "external_id": "exp",
  "plan_id": 241082
}

禁用计划

请求

禁用重复性计划。

安全
basicAuth
路径
project_idinteger必需

项目ID。

plan_idinteger必需

计划 ID。

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

响应

No content.

产品

操作

Subscription management

操作

支付

操作

促销活动

操作

优惠券

操作

Subscription management

操作