Created.
Subscriptions API (2.0)
下载 OpenAPI 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/subscriptions/
正文application/json必需
您可以在令牌的custom_parameters对象中传递其他参数以配置反欺诈筛选器。推荐参数在下拉列表中显示。请参阅支付中心文档。
带有购买相关数据的对象。
示例: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
带有结账参数相关数据的对象。
示例: {"amount":10,"currency":"USD"}
带有订阅相关数据的对象。
示例: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
赠礼订阅的详细信息。
示例: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
此操作的类型应用于用户订阅计划。要更改订阅计划，请传入change_plan值。需在purchase.subscription.plan_id参数中指定新计划的ID。
自定义项目设置。
示例: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
支付小部件。可以是 paybycash 或 giftcard。如果参数已设置，用户将分别重定向到 Pay by Cash 或 Gift Cards 小部件。
枚举"paybycash""giftcard"
重定向政策设置（对象）。
由用户点击关闭按钮或返回游戏按钮触发的支付中心行为。可以是redirect（默认）或postmessage。如果设置为redirect，则用户将被重定向至令牌中传入的URL或发布商帐户中指定的URL。如果设置为postmessage，则用户留在原页面。点击关闭按钮发起发送close事件，点击返回游戏则发起发送return事件。
枚举"redirect""postmessage"
将用户重定向至返回URL的支付状态。可以是none, successful, successful_or_canсeled或any。
枚举"none""successful""successful_or_canceled""any"
带有界面设置相关数据的对象。
示例: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
带有模块菜单设置相关数据的对象。
示例: {"virtual_currency":{"custom_amount":true}}
带有订阅模块设置相关数据的对象。
带有虚拟货币模块设置相关数据的对象。
示例: {"custom_amount":true}
带有虚拟物品模块设置相关数据的对象。
settings.ui.components.virtual_items.hiddenboolean
在菜单中显示还是隐藏“管理订阅”页面。
带有对桌面版本有效的界面设置相关数据的对象。
示例: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
带有标题设置相关数据的对象。
是否在支付中心桌面端显示关闭按钮。该按钮将关闭支付中心并将用户重定向到settings.return_url参数中指定的URL。默认为false。
如何显示标题。不能为compact（隐藏项目名称和用户ID）或normal（默认）。
枚举"compact""normal"
带有订阅列表设置相关数据的对象。
如为true且如果用户的当地货币与订阅计划的货币不同，则用户将看到两种价格：以当地货币和基础货币标价的价格。
带有虚拟货币列表设置相关数据的对象。
带有虚拟物品列表设置相关数据的对象。
示例: {"button_with_price":true,"layout":"list"}
如果为true，则价格会显示在按钮里。如果为false，则价格会显示在按钮左侧。默认值为false。
示例: true
订阅列表模式。可以是list（默认值）或grid。
枚举"list""grid"
示例: "list"
是否禁用将链接重定向至外部资源。默认为true。点击外部链接时，将通过postMessage机制发送external-link-open事件。重定向链接的地址在url参数中传递。
支付中心的界面模式。可能的值为user_account。请注意，页眉仅包含用户帐户的导航菜单，而没有用于选择产品或进行付款的任何选项。“用户帐户”仅在桌面模式下可用。
支付UI的大小。此参数可拥有以下值之一，具体取决于支付UI的所需大小：
枚举"small""medium""large"
示例: "medium"
对象以及有关用户账号的数据。
历史记录子菜单。
我的账户页面。
保存的付款方法子菜单。
带用户相关数据的对象。
示例: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
示例: {"allow_modify":true,"value":"US"}
user.email对象是反欺诈模型的必要部分，有助于提高接受率。同时它也是艾克索拉和支付系统的要求。如果未传入该参数，支付页面将显示输入邮箱必填字段。购买凭证将发送至在该参数中传入的或在支付页面上输入的邮箱地址。
示例: {"value":"john.smith@mail.com"}
包含法律实体详细信息的对象。
公司所在国家/地区。参照ISO 3166-1 alpha-2标准的两个大写字母表示的国家/地区代码。
对象包含描述流量特性的数据。
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/zh/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"checkout": {
"amount": 10,
"currency": "USD"
},
"subscription": {
"gift": {
"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"components": {
"virtual_currency": {
"custom_amount": true
}
},
"desktop": {
"virtual_item_list": {
"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {
"age": 19,
"country": {
"allow_modify": true,
"value": "US"
},
"email": {
"value": "john.smith@mail.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'