查询订阅详情

约 165 字小于 1 分钟

View as Markdown

2026-06-16

OpenAPI 总览

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

durationObject必填
trialObject可选
autoRecoveryObject可选
paymentRecordsArray可选
refundRecordsArray可选
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)必填
订阅通知地址。
resultCodeString必填
业务处理结果码。
resultMessageString必填
业务处理结果描述。

响应报文示例

{
  "clientId": "2025050971820281024",
  "accId": "2025050971820281024001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "version": "1.0",
  "bizContent": {
    "merchantSubscriptionId": "SUB_MER_001",
    "subscriptionId": "SUB-1234567890abcdef",
    "requestId": "REQ_SUB_QUERY_001",
    "description": "monthly membership plan",
    "status": "ACTIVE",
    "cancelReason": "",
    "currentPeriod": 1,
    "startAt": "1785152760",
    "endAt": "1816688760",
    "notifyUrl": "https://merchant.example.com/notify/subscription",
    "duration": {
      "periodCount": 1,
      "periodUnit": "MONTH"
    },
    "trial": {
      "startAt": "1785152760",
      "endAt": "1785757560",
      "periodDays": 7,
      "amount": "0.00",
      "currency": "USD"
    },
    "autoRecovery": {
      "enabled": true
    },
    "paymentRecords": [
      {
        "period": 1,
        "merchantTransactionId": "SUB-1234567890abcdef_P1"
      }
    ],
    "refundRecords": [
      {
        "merchantRefundId": "SREF-1234567890",
        "originalMerchantTransactionId": "SUB-1234567890abcdef_P1"
      }
    ],
    "resultCode": "000000",
    "resultMessage": "SUCCESS"
  },
  "code": "000000",
  "description": "SUCCESS"
}