Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

取消订阅

POST /v1/subscriptions/cancel

使用此接口来取消或终止订阅。取消订阅表示在当前订阅期结束后不再向用户提供服务，而终止订阅意味着服务立即停止。 

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：


注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

  • 如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
  • 如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

入参

subscriptionId String  

Antom 为识别订阅而分配的订阅 ID。此参数的值与首次订阅时 支付通知（订阅）接口和 订阅结果通知 接口返回的同名参数的值相同。

注意：需至少指定 subscriptionId 和 subscriptionRequestId 之一。paymentId 与 paymentRequestId 之间存在一一对应关系。

更多信息：

  • 最大长度：64 字符

subscriptionRequestId String  

商户为识别订阅请求而分配的专属 ID。

注意：需至少指定 subscriptionId 和 subscriptionRequestId 之一。paymentId 与 paymentRequestId 之间存在一一对应关系。

更多信息：

  • 最大长度：64 字符

cancellationType String  REQUIRED

订阅的取消类型。有效值为：

  • CANCEL: 表示取消订阅。在当前订阅期结束后，不再向用户提供订阅服务。
  • TERMINATE: 表示终止订阅。订阅服务立即停止。 

更多信息：

  • 最大长度：32 字符

出参

result Result object REQUIRED

指示此接口是否调用成功。如果接口调用成功，订阅将成功取消。 

Show child parameters
API Explorer
示例代码沙箱运行

请求

URL

Case
Cancel a subscription
请求体

响应

响应体

结果码

结果码值结果码信息行动建议
SUCCESSS成功

接口调用成功。 

PARAM_ILLEGALF缺少必需的参数，或者存在非法参数。例如，非数字输入、无效的日期，或者参数的长度和类型错误。

检查并验证当前接口所需的请求字段（包括头部字段和正文字段）是否正确传递并有效。 

PROCESS_FAILF发生了常见的业务失败。

获取 Antom 技术支持前请勿重试。

UNKNOWN_EXCEPTIONU由于未知原因，接口调用失败。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。