取消订阅
入参
subscriptionRequestId String
商户为识别订阅请求而分配的专属 ID。
注意:需至少指定 subscriptionId 和 subscriptionRequestId 之一。paymentId 与 paymentRequestId 之间存在一一对应关系。
更多信息:
- 最大长度:64 字符
cancellationType String REQUIRED
订阅的取消类型。有效值为:
CANCEL
: 表示取消订阅。在当前订阅期结束后,不再向用户提供订阅服务。TERMINATE
: 表示终止订阅。订阅服务立即停止。
更多信息:
- 最大长度:32 字符
出参
result Result REQUIRED
指示此接口是否调用成功。如果接口调用成功,订阅将成功取消。
API Explorer
示例代码沙箱运行
请求
URL
Case
Cancel a subscription
请求体
响应
响应体
结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | 成功 |
接口调用成功。 |
PARAM_ILLEGAL | F | 缺少必需的参数,或者存在非法参数。例如,非数字输入、无效的日期,或者参数的长度和类型错误。 |
检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 |
PROCESS_FAIL | F | 发生了常见的业务失败。 | 获取 Antom 技术支持前请勿重试。 |
UNKNOWN_EXCEPTION | U | 由于未知原因,接口调用失败。 | 再次调用接口以解决问题。如果问题未解决,请联系 Antom 技术支持。 |