文档首页/ 云商店/ 接入指南/ 商品接入相关接口/ SaaS类商品接入指南 V1.0（已下线）/ 通用和自服务SaaS类商品接入指南 V1.0/ 接口描述/ 商品续费
更新时间：2024-09-30 GMT+08:00
查看PDF
分享

商品续费

接口说明

按周期售卖的商品，商家必须实现续费接口生产开发。

  • 客户续费下单或试用商品转正后，云商店将调用该接口请求商家执行业务延期，商家接口需要执行将到期日进行更新，并返回通知云商店。
  • 商家需要保障续费接口通畅，将业务进行延期，如续费失败，将可能导致用户的业务被释放的风险。
  • 针对续费场景接口调用失败的情况，云商店会持续调用1小时后停止调用，“卖家中心>生产接口消息”中可查询接口“异常信息”，请在修复接口异常后，通知云商店partner@huaweicloud.com对该失败调用进行重新调用或自行在“卖家中心>生产接口消息”页面中查询接口“异常信息”，单击右侧操作栏的“重新启动”进行手动重试。
    • 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。
    • 云商店会对接口异常的情况做监控，如SaaS商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。

商品续费流程如下图所示：

请求消息

请求参数说明请参见下表：

请求方法：GET

参数

是否必选

类型

最大字符长度

说明

activity

M

String

20

接口请求标识，用于区分接口请求场景。

续费场景取值：refreshInstance

authToken

M

String

50

安全校验令牌。

取值请参见authToken取值说明。

orderId

M

String

64

云商店订单ID。

说明：

续费、退续费操作会产生新的订单，与新购时订单ID不一致，请通过instance Id做资源识别。

instanceId

M

String

64

实例ID。

productId

O

String

64

产品标识，租户续费或转正产品实例时，如果订购周期类型发生变化，会传入变化后的产品类型对应的productId。

expireTime

M

String

20

过期时间。

格式：yyyyMMddHHmmss

trialToFormal

O

String

2

是否是试用转正请求

  • 不传参数：不是
  • 1：是（试用转包周期）

默认不是试用转正。

timeStamp

M

String

20

请求发起时的时间戳，取UTC时间。

格式：yyyyMMddHHmmssSSS

periodType

O

String

10

周期类型。

说明：

非必传，如需此参数，计费类型需选择包周期chargingMode=1，包周期购买场景请求时传该参数

年："year"

月："month"

chargingMode=3，按次数购买场景请求时不传该参数。

periodNumber

O

integer

2

周期数量。

说明：

非必传，如需此参数，计费类型需选择包周期chargingMode=1，包周期购买场景请求时传该参数。

周期数量：1,2,3…

orderAmount

O

bigdecimal

20

订单金额。

说明：

该金额为用户实际支付金额，供商家对账参考。

① 续费场景： 金额值大于等于0，最大三位小数。

② 退续费场景：金额值为负数，最大三位小数。

单位：元

testFlag

O

Integer

1

是否调测数据。

  • 1：接口调测数据
  • 不传参数：真实买家同步数据

2018年5月12日新增接口参数：productId和trialToFormal。

  • 2018年5月12日之后发布产品或已发布成功的产品新增规格时，请填写此新参数并通过接口调试（productId为空或者填值，trialToFormal“不传参数”或为“1”都要求调试通过）。
  • 2018年5月12日之前已发布成功的产品，如果不涉及免费试用变更，不要求做接口调试。

请求消息示例：

https://example.isv.com?activity=refreshInstance& expireTime=20180725000000&instanceId=03pf80c2bae96vc49b80b917bea776d7&orderId=HWS001014ED483AA1E8&timeStamp=20170725025113409&testFlag=0&authToken=09lsS5y+KCtxBu+ON4TXv1SrjH5KVYka9sx2MauHrQU=

响应消息

响应参数说明请参见下表：

参数

是否必选

类型

最大字符长度

说明

resultCode

M

String

6

调用结果码。

具体请参见调用结果码说明。

resultMsg

O

String

255

调用结果描述。
  • 商家的服务器在处理接口请求时，需要做好幂等性处理。
  • 云商店服务有可能重发请求，针对同一订单号，商家的服务器应当返回成功的响应，不应该再做实例延期处理，返回成功响应即可。

响应消息示例：

{
    "resultCode":"000000",
    "resultMsg":"success."
}
父主题： 接口描述

相关文档