跳转到内容
/
更新订阅

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

操作

获取订阅

请求

通过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"
  }
}

支付

操作

促销活动

操作

优惠券

操作

Subscription management

操作