取消订阅计划
- Endpoint:
POST /aggregate-pay/api/gateway/subscriptionCancel - Tags: 收单/订阅计划管理
Description
商户创建订阅计划后,可以主动取消订阅计划。但如果出现下面情况,则商户不能取消订阅计划: (1)该订阅计划处于激活中。 (2)该订阅计划的某一期扣款处于支付中。
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.subscriptionNo | string | Yes | PMMAX订阅计划号。 |
Responses
200
| Field | Type | Required | Description |
|---|
code | string | Yes | 返回码,’APPLY_SUCCESS’代表成功 |
msg | string | Yes | 返回描述,’Success.’ |
data | object | Yes | |
data.subscriptionRequestId | string | Yes | 商户创建订阅计划的单号。 |
data.userId | string | Yes | 用户号。 |
data.subscriptionPlan | object | Yes | |
data.subscriptionPlan.subscriptionNo | string | Yes | PMMAX订阅号。 |
data.subscriptionPlan.subscriptionStatus | string | Yes | 订阅计划状态。 |