创建订阅计划

• Endpoint: POST /aggregate-pay/api/gateway/subscriptionCreate
• Tags: 收单/订阅计划管理

Description

PayerMax提供多种类型的订阅计划：普通订阅、n天试用、前n期优惠；可以通过创建订阅计划的入参来控制订阅计划的类型。

Parameters

Field	Type	Required	Description
Content-Type (header)	string	Yes
sign (header)	string	Yes	签名信息请参考技术文档

Request Body

Field	Type	Required	Description
version	string	Yes	接口版本 当前值为：1.5
keyVersion	string	Yes	密钥版本 当前值为：1
requestTime	string	Yes	请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appId	string	Yes	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	No	商户号，商户与PayerMax业务签约时生成的唯一标识
data	object	Yes
data.subscriptionRequestId	string	Yes	商户创建订阅计划的单号。
data.userId	string	Yes	用户id。
data.callbackUrl	string	Yes	订阅结果和扣款结果的通知地址。
data.subscriptionPlan	object	Yes	订阅计划信息。
data.subscriptionPlan.subject	string	Yes	标题。
data.subscriptionPlan.description	string	No	描述。
data.subscriptionPlan.totalPeriods	number	Yes	总期数。
data.subscriptionPlan.firstPeriodStartDate	string	No	第一期扣款开始时间。如：2025-02-26T12:00:00+00:00
data.subscriptionPlan.advanceDays	number	No	后续的每期扣款提前发起的天数。如advanceDays=2表示提前2天开始发起扣款。
data.subscriptionPlan.periodRule	object	Yes	扣款规则。
data.subscriptionPlan.periodRule.periodUnit	string	Yes	按M（月），D(日)，W（周），Y（年）扣款。
data.subscriptionPlan.periodRule.periodCount	number	Yes	扣款频次。如periodUnit=M、periodCount=1表示每1个月扣款一次。
data.subscriptionPlan.periodAmount	object	Yes	每期扣款金额。
data.subscriptionPlan.periodAmount.amount	number	Yes	金额。
data.subscriptionPlan.periodAmount.currency	string	Yes	币种。
data.subscriptionPlan.trialPeriodConfig	object	No	优惠期配置。
data.subscriptionPlan.trialPeriodConfig.trialPeriodCount	number	Yes	优惠期数。
data.subscriptionPlan.trialPeriodConfig.trialPeriodAmount	object	Yes	优惠期扣款金额。
data.subscriptionPlan.trialPeriodConfig.trialPeriodAmount.amount	number	No	金额。
data.subscriptionPlan.trialPeriodConfig.trialPeriodAmount.currency	string	No	币种。
data.subscriptionPlan.trialConfig	object	No	试用期配置
data.subscriptionPlan.trialConfig.trialAmount	object	Yes	试用期金额信息
data.subscriptionPlan.trialConfig.trialAmount.amount	number	Yes	试用期金额
data.subscriptionPlan.trialConfig.trialAmount.currency	string	Yes	试用期币种
data.subscriptionPlan.trialConfig.trialDays	number	Yes	试用天数

Responses

200

Field	Type	Required	Description
code	string	Yes	返回码，’APPLY_SUCCESS’代表成功
msg	string	Yes	返回描述，’Success.’
data	object	Yes
data.subscriptionRequestId	string	Yes	商户创建订阅计划的单号。
data.subscriptionPlan	object	Yes
data.subscriptionPlan.subscriptionNo	string	Yes	PMMAX订阅号
data.subscriptionPlan.subscriptionStatus	string	Yes	订阅计划状态。 INACTIVE：未激活 ACTIVE_FAILED：激活失败 ACTIVE：激活成功 EXPIRED：过期未激活 FINISH：订阅完成 CANCEL：订阅取消 TERMINATE：订阅终止