Skip to content

查询订阅详情

接口信息

GET /subscription/detail

请求参数

参数名类型必填参与签名说明
subscriptionIdString订阅 ID
merchantIdString商户号
signString签名

响应参数(data 对象)

字段类型说明
subscriptionIdString订阅 ID
subscriptionCodeString订阅编号
userIdString用户 ID
planIdString订阅计划 ID
planNameString计划名称
planDescriptionString计划描述
amountBigDecimal订阅金额
currencyString货币
cycleTypeString周期类型
cycleLengthInteger周期长度
statusString订阅状态
nextBillingTimeString下次扣费时间
startTimeString开始时间
endTimeString结束时间
cancelTimeString取消时间
billingCountInteger已扣费次数
failedCountInteger失败次数
totalPaidBigDecimal累计支付金额
createTimeString创建时间

请求示例

json
{
  "subscriptionId": "SUB_001",
  "merchantId": "MERCHANT_001",
  "sign": "calculated_signature"
}

响应示例

json
{
  "rtn_code": "0000",
  "success": true,
  "data": {
    "subscriptionId": "SUB_001",
    "subscriptionCode": "SC_001",
    "userId": "USER_12345",
    "planId": "PLAN_MERCHANT001_20241021001",
    "planName": "Basic Monthly Plan",
    "planDescription": "Basic features, billed monthly",
    "amount": 9.99,
    "currency": "USD",
    "cycleType": "MONTHLY",
    "cycleLength": 1,
    "status": "ACTIVE",
    "nextBillingTime": "2024-12-21 10:00:00",
    "startTime": "2024-10-21 10:00:00",
    "billingCount": 2,
    "failedCount": 0,
    "totalPaid": 19.98,
    "createTime": "2024-10-21 10:00:00"
  }
}

Codrimpay