查询订阅详情
POST
Request Body Parameters
application/json公共请求参数
bizContent
merchantSubscriptionIdString(64)按条件选商户定义的订阅计划的唯一ID,和 subscriptionId 至少上传一个。subscriptionIdString(64)按条件选PingPong 订阅单号,和 merchantSubscriptionId 至少上传一个。requestIdString(64)必填商户请求唯一编号。
请求报文示例
{
"clientId": "2024061100000000001",
"accId": "20240611000000000010001",
"signType": "SHA256",
"sign": "SIGN_VALUE",
"version": "1.0",
"bizContent": {
"merchantSubscriptionId": "SUB_M_202606110001",
"subscriptionId": "PP_SUB_001",
"requestId": "REQ_SUB_QUERY_001"
}
}Responses Body Parameters
application/json公共返回参数
bizContent
flatPriceObject必填当前订阅计划每个正式计费周期的扣款金额和币种。amountString(12)必填订阅计划每个正式计费周期的实际扣款金额。currencyString(3)必填订阅计划正式计费周期的扣款币种,使用三位字母的 ISO 4217 币种代码。
periodObject必填订阅周期信息。countInteger必填单个正式计费周期包含的单位数量,必须大于等于 1。例如,unit 为MONTH、count 为1表示每月计费一次;此字段不是订阅总期数。unitString必填订阅周期单位类型,有效值包括:YEAR:表示订阅周期以年为单位。MONTH:表示订阅周期以月为单位。WEEK:表示订阅周期以周为单位。DAY:表示订阅周期以天为单位。
trialObject可选试用期信息。startAtString(10)可选试用期开始时间,10 位秒级时间戳字符串。endAtString(10)按条件选试用期结束时间,10 位秒级时间戳字符串。periodDaysInteger按条件选试用期持续天数。
autoRecoveryObject可选自动重试配置。enabledBoolean可选是否开启自动重试,默认自动开启。true开启重试false关闭重试
goodsObject必填订阅计划的商品信息。nameString(500)必填商品名称。descriptionString(500)可选商品描述。skuString(500)可选商品编号,产品SKU。unitPriceString(12)必填商品单价。unitTaxAmountString(12)按条件选单个商品税费,订单总金额包含税费时必填。taxRateString可选税率。totalDiscountAmountString按条件选单个商品总优惠金额,订单总金额涉及优惠时必填。numberString(12)必填商品购买数量。imgUrlString(255)必填商品主图链接。virtualProductString(1)可选是否是虚拟产品,虚拟商品(Y/N)。itemTypeString(1)可选商品类型,枚举值:1/2/3,对应含义如下:1DIGITAL:数字商品2PHYSICAL:实物商品3SERVICE:服务
paymentRecordsArray可选简版支付记录列表。periodInteger必填所属订阅期次。merchantTransactionIdString(64)必填该期对应的商户交易单号。
refundRecordsArray可选退款记录列表。merchantRefundIdString(64)必填退款订单号。originalMerchantTransactionIdString(64)必填退款单对应的原支付商户交易单号。
merchantSubscriptionIdString(64)必填商户定义的订阅计划的唯一ID。subscriptionIdString(64)必填PingPong 订阅单号。requestIdString(64)必填商户请求唯一编号。descriptionString(255)可选订阅计划描述。statusString(32)必填订阅计划状态。有效值包括:PENDING订阅已创建,但尚未进入正式生效阶段。IN_TRIAL订阅处于试用期内,当前服务可用,但尚未完成首次正式收费。ACTIVE订阅当前正常生效中,用户有权使用服务。PAST_DUE订阅已到应扣款时间,但本次扣款失败,进入欠费/补扣阶段。CANCELLED订阅已终止,不再继续自动续费。
cancelReasonString(64)可选订阅状态为CANCELLED时返回,表示订阅取消原因。USER_REQUESTED用户取消MERCHANT_REQUESTED商户取消PAYMENT_RETRY_EXHAUSTED自动重试结束PLAN_ENDED订阅到期结束
currentPeriodInteger必填当前所在周期,0、1、2、3...,其中0代表试用期。startAtString(10)可选订阅开始时间,10 位秒级时间戳字符串。endAtString(10)可选订阅结束时间,10 位秒级时间戳字符串。notifyUrlString(255)必填订阅通知地址。totalPeriodCountInteger可选订阅计划包含的正式扣款周期总数,必须大于等于 1,不包含试用期。不传时不限制正式扣款期数。resultCodeString必填业务处理结果码。resultMessageString必填业务处理结果描述。
响应报文示例
{
"clientId": "2025050971820281024",
"accId": "2025050971820281024001",
"signType": "MD5",
"sign": "SIGN_VALUE",
"version": "1.0",
"bizContent": {
"flatPrice": {
"amount": "9.99",
"currency": "USD"
},
"merchantSubscriptionId": "SUB_MER_001",
"subscriptionId": "SUB-1234567890abcdef",
"requestId": "REQ_SUB_QUERY_001",
"description": "monthly membership plan",
"status": "ACTIVE",
"cancelReason": "",
"currentPeriod": 1,
"startAt": "1785152760",
"endAt": "1817293560",
"notifyUrl": "https://merchant.example.com/notify/subscription",
"period": {
"count": 1,
"unit": "MONTH"
},
"totalPeriodCount": 12,
"trial": {
"startAt": "1785152760",
"endAt": "1785757560",
"periodDays": 7
},
"autoRecovery": {
"enabled": true
},
"goods": {
"name": "Membership",
"description": "Monthly membership",
"sku": "SKU_SUB_001",
"unitPrice": "9.99",
"number": "1",
"imgUrl": "https://merchant.example.com/goods/sub.png",
"virtualProduct": "Y",
"itemType": "1"
},
"paymentRecords": [
{
"period": 1,
"merchantTransactionId": "SUB-1234567890abcdef_P1"
}
],
"refundRecords": [
{
"merchantRefundId": "SREF-1234567890",
"originalMerchantTransactionId": "SUB-1234567890abcdef_P1"
}
],
"resultCode": "000000",
"resultMessage": "SUCCESS"
},
"code": "000000",
"description": "SUCCESS"
}