获取订阅

Subscriptions API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

概览

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/

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

计划
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

产品
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

列示所有订阅

请求

列出所有经常订阅。

注意

这种API方法不能在高负载下使用。最大负载为每分钟20个请求。

注意

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

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

查询

offsetinteger

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

limitinteger必需

页面上元素数量的限制。

user_idstring

用户ID。

project_id[]Array of integers

项目ID列表。

plan_id[]Array of integers

订阅计划ID列表。

product_id[]Array of integers

计划关联的产品ID列表。

group_id[]Array of strings

计划关联的组ID列表。

status[]Array of strings

状态。

项枚举"active""canceled""non_renewing"

datetime_fromstring(datetime)

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

datetime_tostring(datetime)

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

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'

响应

OK.

正文application/jsonArray [

charge_amountnumber(float)

支付金额。

commentstring

更改订阅状态的原因

currencystring

交易使用的币种。符合ISO 4217标准的三字母货币代码。

date_createstring(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的订阅创建日期。

date_endstring(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的订阅结束日期。

date_last_chargestring or null(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的上次订阅扣费日期。

date_next_chargestring or null(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的下次订阅扣费日期。

idinteger

订阅ID

planobject

productobject or null

statusstring

状态

枚举"new""active""canceled""non_renewing""freeze"

userobject

]

响应

application/json

[
  {
    "charge_amount": 0.03,
    "currency": "USD",
    "date_create": "2013-09-05T15:27:47+04:00",
    "date_end": "2014-02-06T11:32:48+04:00",
    "date_last_charge": null,
    "date_next_charge": null,
    "id": 45,
    "plan": { … },
    "product": { … },
    "status": "canceled",
    "user": { … }
  }
]

获取订阅

请求

通过ID获取特定订阅的详细信息。

安全

basicAuth

路径

project_idinteger必需

项目ID。

subscription_idinteger必需

订阅ID。

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

响应

OK.

正文application/json

charge_amountnumber(float)

支付金额。

commentstring

更改订阅状态的原因

currencystring

交易使用的币种。符合ISO 4217标准的三字母货币代码。

date_createstring(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的订阅创建日期。

date_endstring(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的订阅结束日期。

date_last_chargestring or null(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的上次订阅扣费日期。

date_next_chargestring or null(datetime)

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的下次订阅扣费日期。

idinteger

订阅ID

planobject

productobject or null

statusstring

状态

枚举"new""active""canceled""non_renewing""freeze"

userobject

响应

application/json

{
  "charge_amount": 0.03,
  "comment": "The subscription was not extended in due time",
  "currency": "USD",
  "date_create": "2018-09-21T16:54:59+03:00",
  "date_end": "2019-02-06T12:43:04+03:00",
  "date_last_charge": "2018-09-21T16:55:05+03:00",
  "date_next_charge": "2018-09-21T16:55:05+03:00",
  "id": 249579,
  "plan": {
    "external_id": "lowcost",
    "id": 601
  },
  "product": {
    "id": 123456
  },
  "status": "canceled",
  "user": {
    "id": "user1",
    "name": "John Smith"
  }
}

更新订阅

请求

更新重复性订阅。可以更新订阅的状态（active、canceled或non_renewing）以及推迟当前订阅的下一次收费日期。

安全

basicAuth

路径

project_idinteger必需

项目ID。

user_idstring必需

用户ID。

subscription_idinteger必需

订阅ID。

正文application/json必需

cancel_subscription_paymentboolean

如果设为true，此订阅的最后一次付款将被退回。只有状态更改为canceled，此选项才会有效。

statusstring

状态。

枚举"active""canceled""non_renewing"

timeshiftobject

账单推迟。

xsolla_networkobject

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active"
  }'

响应

OK.

正文application/json

响应

application/json

{
  "charge_amount": 0.03,
  "currency": "USD",
  "date_create": "2018-09-21T16:54:59+03:00",
  "date_end": null,
  "date_last_charge": "2018-09-21T16:55:05+03:00",
  "date_next_charge": "2018-09-21T16:55:05+03:00",
  "id": 24953579,
  "plan": {
    "billing_retry": { … },
    "charge": { … },
    "description": null,
    "expiration": { … },
    "external_id": "lowcost",
    "grace_period": { … },
    "group_id": "newPlans",
    "id": 66001,
    "localized_name": null,
    "name": null,
    "project_id": 18404,
    "refund_period": null,
    "status": { … },
    "tags": null,
    "trial": { … },
    "type": "all"
  },
  "product": null,
  "status": "active",
  "user": {
    "id": "jb1",
    "name": "J.Black"
  }
}

支付
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

促销活动
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

优惠券
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

Subscriptions API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

概览

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

计划
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

产品
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

列示所有订阅

请求

响应

这篇文章有帮助吗？

获取订阅

请求

响应

这篇文章有帮助吗？

更新订阅

请求

响应

这篇文章有帮助吗？

支付
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

促销活动
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

优惠券
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Subscriptions API (2.0)复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

概览

令牌复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

计划复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

产品复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

Subscription management复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

列示所有订阅

请求

响应

这篇文章有帮助吗？

获取订阅

请求

响应

这篇文章有帮助吗？

更新订阅

请求全部展开

响应

这篇文章有帮助吗？

支付复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

促销活动复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

优惠券复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

Subscription management复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

Subscriptions API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

计划
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

产品
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

请求

支付
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

促销活动
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

优惠券
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Subscription management
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解