跳转到主要内容
POST
订阅申请

密钥私钥(生成签名)

相关主题

请求体

application/json
appId
integer
必填

业务ID(后台获取,需要根据参数currency传递对应的业务ID)

subscriptionOrderId
string
必填

商户订单号(必须保证唯一性,长度不超过48)

Maximum string length: 48
amount
string
必填

交易金额(精确到小数点后两位;禁止添加标点符号,例如:",")

Pattern: ^\d+\.\d{2}$
phone
string
必填

真实手机号(格式参考电话号码格式)

subject
string
必填

订阅标题

inBankCode
enum<string>
必填

支付方式编码,与 paymentMethods 二选一

可用选项:
CREDIT_CARD,
GOOGLE_PAY,
APPLE_PAY
payType
enum<string>
必填

支付方式类型

可用选项:
SUBSCRIPTION
callBackUrl
string<uri>
必填

用户支付成功后跳转地址

notifyUrl
string<uri>
必填

异步通知地址

country
string
必填

国家

currency
enum<string>
必填

币种,目前支持:USD

可用选项:
USD
partnerUserId
string
必填

用户唯一标识(如用户ID userId),用于风控系统,必须真实有效,否则会影响交易。格式要求:数字、大小写字母或常用符号-~!@#$%&*()_。

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
recurringInterval
enum<string>
必填

循环周期类型 D(天),W(周),M(月),Y(年)

可用选项:
D,
W,
M,
Y
recurringIntervalCount
integer
必填

循环周期间隔

必填范围: x >= 1
recurringMaxNumber
integer
必填

最大循环次数,无论循环周期是哪个,最长时间不能超过三年,到期订阅自动取消

必填范围: x >= 1
website
string<uri>
必填

交易网站

retryTimes
integer
默认值:3
必填

定期扣款失败重试次数,默认为3

必填范围: x >= 0
sign
string
必填

签名

name
string

用户姓名,推荐使用真实姓名,格式:包含firstName和lastName,以空格分割的,示例:John Doe

email
string<email>

真实电子邮件

body
string

备注详情

cancelUrl
string<uri>

用户取消支付URL,如果传递,用户可在支付页面点击返回到此页面

couponPeriod
integer

优惠期数(暂时只支持首期优惠与全期优惠,即couponPeriod只能等于1或者等于recurringMaxNumber)

couponAmountPerPeriod
string

每期优惠金额

Pattern: ^\d+\.\d{2}$
paymentMethods
string

支持的支付方式列表,英文逗号分隔,如 CREDIT_CARD,GOOGLE_PAY,APPLE_PAY,与 inBankCode 二选一,暂时仅支持前置组件组合模式使用

响应

200 - application/json
status
string
默认值:1
必填

1: 正常, 0: 异常

error
string
默认值:00000000
必填

错误代码

msg
string
默认值:""
必填

错误描述

data
object
必填
最后修改于 2026年7月16日