跳转到内容
/
删除计划

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。

正文application/json必需
billing_retryobject

账单扣费重试详情。

chargeobject

账单详情。

descriptionobject

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

expirationobject

订阅到期详情。

external_idstring

外部计划标识符。

grace_periodobject

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

group_idstring

计划关联的组ID。

nameobject

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

refund_periodinteger or null

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

statusobject
tagsArray of strings

计划标签。

trialobject

试用期限详细信息。如未传入此参数，则使用默认值（0天）。

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

响应

OK.

正文application/json
响应
application/json
{
  "billing_retry": {
    "value": 1
  },
  "charge": {
    "amount": 20,
    "currency": "USD",
    "period": { … },
    "prices": [ … ]
  },
  "description": {
    "en": "3x more experience!"
  },
  "expiration": {
    "type": "day",
    "value": 0
  },
  "external_id": "exp",
  "grace_period": {
    "type": "day",
    "value": 2
  },
  "group_id": null,
  "id": 241082,
  "localized_name": "Experience boost",
  "name": {
    "en": "Experience boost"
  },
  "project_id": 40797,
  "refund_period": null,
  "status": {
    "value": "active"
  },
  "tags": [],
  "trial": {
    "type": "day",
    "value": 7
  },
  "type": "all"
}

删除计划

请求

删除重复性计划。

安全
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}/delete'

响应

No content.

产品

操作

Subscription management

操作

支付

操作

促销活动

操作

优惠券

操作

Subscription management

操作