订阅查询

商户业务系统通过订阅查询接口，查询订阅关系的当前状态。

接口说明

接口

请求API: /api/subscription/query

请求方式: POST

请求类型：application/json 或 application/x-www-form-urlencoded

请求参数

字段名	变量名	必填	类型	示例值	描述
商户号	mchNo	是	String(30)	M1621873433953	商户号
应用ID	appId	是	String(24)	60cc09bce4b0f1c0b83761c9	应用ID
订阅ID	subscriptionId	是	String(32)	SUB_20210618164232	订阅ID
请求时间	reqTime	是	long	1622016572190	请求接口时间,13位时间戳
接口版本	version	是	String(3)	1.0	接口版本号，固定：1.0
签名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	签名值，详见签名算法
签名类型	signType	是	String(32)	MD5	签名类型，目前只支持MD5方式

请求示例数据

{
  "mchNo": "M1623984572",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "subscriptionId": "SUB_20210618164232",
  "reqTime": "1622016572190",
  "version": "1.0",
  "signType": "MD5",
  "sign": "84F606FA25A6EC4783BECC08D4FDC681"
}

返回参数

字段名	变量名	必填	类型	示例值	描述
返回状态	code	是	int	0	0-处理成功，其他-处理有误，详见错误码
返回信息	msg	否	String(128)	签名失败	具体错误原因
签名信息	sign	否	String(32)	CCD9083A6DAD9A2DA9F668C3D4517A84	对data内数据签名
返回数据	data	否	Object	{}	返回订阅数据

data数据格式 (SubscriptionRS)

字段名	变量名	类型	示例值	描述
订阅ID	subscriptionId	String	SUB_20210618001	支付系统订阅ID
商户号	mchNo	String	M1621873433953	商户号
应用ID	appId	String	60cc09bce4b0f1c0b83761c9	应用ID
订阅计划ID	planId	String	PLAN_001	订阅计划ID
订阅计划编码	planCode	String	VIP_MONTH	订阅计划编码
订阅周期	cycleIndex	integer	1	订阅周期值
商户订单号	mchOrderNo	String	sub1624005107281	商户传入的订单号
状态	state	Byte	1	0-待生效, 1-等生效 2-活跃, 3-暂停, 4-逾期 5-已取消, 6-完成, 7-无效
当前周期开始	currentPeriodStart	Long	1624005107281	当前计费周期开始时间戳 (可选)
下次扣费时间	currentPeriodEnd	Long	1626597107281	当前周期结束/下次扣费时间戳 (可选)
到期取消	cancelAtPeriodEnd	Boolean	false	是否在周期结束时取消
币种	currency	String	USD	币种
是否有效	isActive	Boolean	true	根据状态和时间判断当前是否有效

返回示例数据

{
  "code": 0,
  "msg": "SUCCESS",
  "data": {
    "subscriptionId": "SUB_20210618001",
    "mchOrderNo": "sub1624005107281",
    "state": 1,
    "currentPeriodStart": 1624005107281,
    "currentPeriodEnd": 1626597107281,
    "cancelAtPeriodEnd": false,
    "isActive": true
  },
  "sign": "F4DA202C516D1F33A12F1E547C5004FD"
}