目录

取消订阅

功能介绍

此接口用于主动取消用户订阅的商品,不影响已经收取费用的收据,只是在订阅到期日不会继续续订。

场景描述

在收到用户申诉不希望对订阅的商品续期后,您的服务器可以调用华为应用内支付服务器提供的取消订阅接口停止续期,商品在有效期内仍然有效,但后续的续期会终止。

接口原型

承载协议

HTTPS POST

接口方向

开发者服务器-> 华为应用内支付服务器

接口URL

{rootUrl}/sub/applications/v2/purchases/stop

说明:

rootUrl在不同站点有不同的url:您应固定选择最近站点的Subscription服务地址访问。具体请参见站点信息和站点选择。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json; charset=UTF-8

Authorization

是

String

认证信息,使用Access Token进行鉴权,这里使用开放平台鉴权提供的服务接口获取Access Token,格式说明参见公共说明,获取方式参见获取应用级AT。

Request Body

参数

是否必选

参数类型

描述

subscriptionId

是

String

订阅ID。

purchaseToken

是

String

商品的购买Token,发起购买和查询订阅信息均会返回。

请求示例

POST /sub/applications/v2/purchases/stop
Content-Type: application/json; charset=UTF-8
Authorization: Basic QVQ6Q1YzQ1NPbVlBaGwrZUtRWExtMTBVV2pyWXZHTVF4MmYvcVMya1B0ZElLY3UwaFJrdFNTMmxwdk1FQkIyYldXWGt0REVaR3I4UjFUTTRLMVlmNXdwWU80RG04THdXQWxjaFhEYjBMUjBNTUJtWnFYcGFtazc3THN3UnFJbkhHK28xekdqRzNSMg==
Accept: application/json
Content-Length: 171
{
  "purchaseToken": "00000173741056a37eef310dff9c6a86fec57efafe318ae478e52d9c4261994d64c8f6fc8ea1abbdx5347.5.3089",
  "subscriptionId": "1581789719266.D40972AC.3089"
}

响应参数

Response Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json; charset=UTF-8

Response Body

参数

是否必选

参数类型

描述

responseCode

是

String

返回码。

  • 0:成功。
  • 其他:失败,具体请参见错误码。

responseMessage

否

String

响应描述。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 27
{
  "responseCode": "0"
}

调用示例

在完成一笔支付后,您的客户端会获取到商品订单详情JSON字符串InAppPurchaseData。更多语言示例代码请参见服务端示例代码,您可直接下载代码工程。相关的库和方法可参见代码工程。

“Java”
public class SubscriptionService {
   // TODO: 将(ip:port)替换为实际值,如果协议使用的是https,您还应该处理证书认证相关的逻辑
    public static final String TOC_SITE_URL = "https://ip:port";

    public static void stopSubscription(String subscriptionId, String purchaseToken)
        throws Exception {
        // 获取应用级AccessToken
        String appAt = AtDemo.getAppAT();
        // 在请求头中构建Authorization
        Map<String, String> headers = AtDemo.buildAuthorization(appAt);

        // 包装request的body信息
        Map<String, String> bodyMap = new HashMap<>();
        bodyMap.put("subscriptionId", subscriptionId);
        bodyMap.put("purchaseToken", purchaseToken);
        String msgBody = JSONObject.toJSONString(bodyMap);
        // demo中使用5000作为超时时间,您可以按照需要调整
        String response = AtDemo.httpPost(TOC_SITE_URL + "/sub/applications/v2/purchases/stop",
            "application/json; charset=UTF-8", msgBody, 5000, 5000, headers, true);
        // TODO: 在console中将response作为字符串打印,您可以根据业务逻辑替换处理方式
        System.out.println(response);
    }
}
“Python”
class SubscriptionService:
    def __init__(self):
        # TODO: 将(ip:port)替换为实际值,如果协议使用的是https,您还应该处理证书认证相关的逻辑
        self.TOC_SITE_URL = "https://ip:port"
        self.stopSubscriptionUrl = "%s/sub/applications/v2/purchases/stop"

    def stopSubscription(self, subscriptionId, purchaseToken):
        # 获取应用级AccessToken
        appAt = AtDemo.getAppAT()
        if appAt is None or appAt == "":
            return
        # 在请求头中构建Authorization
        headers = AtDemo.buildAuthorization(appAt)
        # 包装request的body信息
        bodyDict = {"subscriptionId": subscriptionId, "purchaseToken": purchaseToken}
        data = json.dumps(bodyDict)
        response = AtDemo.httpPost(self.stopSubscriptionUrl % self.TOC_SITE_URL, str.encode(data), headers)
        # TODO: 在console中将response作为字符串打印,您可以根据业务逻辑替换处理方式.
        print(response)
“Go”
type SubscriptionClient struct {
}

// TODO: 将(ip:port)替换为实际值,如果协议使用的是https,您还应该处理证书认证相关的逻辑
const TOC_SITE_URL = "https://ip:port"

var SubscriptionDemo = &SubscriptionClient{}

func (subscriptionDemo *SubscriptionClient) StopSubscription(subscriptionId, purchaseToken string) {
  bodyMap := map[string]string{
    "subscriptionId": subscriptionId,
    "purchaseToken":  purchaseToken,
  }
  url := TOC_SITE_URL + "/sub/applications/v2/purchases/stop"
  bodyBytes, err := SendRequest(url, bodyMap)
  if err != nil {
    log.Printf("err is %s", err)
  }
  // TODO: 在console中将response作为字符串打印,您可以根据业务逻辑替换处理方式.
  log.Printf("%s", bodyBytes)
}

Postman调试

您可以使用Postman在线调试此接口。