跳转到内容

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

操作

支付

操作

列示所有货币

请求

列示所有重复性货币。

安全
basicAuth
路径
project_idinteger必需

项目ID。

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

响应

OK.

正文application/json
响应
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

列示所有支付

请求

列示所有重复性支付。

安全
basicAuth
路径
project_idinteger必需

项目ID。

查询
offsetinteger

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

limitinteger必需

页面上元素数量的限制。

user_idstring

用户ID。

statusstring

交易状态。

枚举 值描述
done

支付处理成功。

fail

支付未成功处理或发起了退款。

datetime_fromstring(datetime)

日期范围的开始时间。

datetime_tostring(datetime)

日期范围的结束时间。

subscription_idinteger

订阅ID。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

响应

OK.

正文application/json
响应
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

获取用户付款

请求

按用户列示所有重复性支付。

安全
basicAuth
路径
project_idinteger必需

项目ID。

user_idstring必需

用户ID。

查询
statusstring

交易状态。

枚举 值描述
done

支付处理成功。

fail

支付未成功处理或发起了退款。

offsetinteger

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

limitinteger必需

页面上元素数量的限制。

datetime_fromstring(datetime)

示例日期。查找在请求日期之后创建的订阅。

datetime_tostring(datetime)

示例日期。查找在请求日期之后创建的订阅。

subscription_idinteger

订阅ID。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

响应

OK.

正文application/json
响应
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

促销活动

操作

优惠券

操作

Subscription management

操作