Skip to content

创建订阅计划

接口信息

POST /subscription/plan/create

请求参数

参数名类型长度必填参与签名说明
merchantIdString200商户号
planNameString200计划名称
descriptionString500计划描述
priceString(12,2)订阅价格(保留两位小数)
currencyString20货币(目前仅支持 USD
cycleTypeString20周期类型:DAILY / WEEKLY / MONTHLY / YEARLY
cycleLengthInteger-周期长度(如 MONTHLY + 3 = 每3个月扣费一次)
trialDaysInteger-试用天数(默认 0,表示无试用期)
maxSubscriptionsInteger-最大订阅数(默认 0,表示无限制)
signStringtext签名

NOTE

cycleLength 为 Integer 类型,不参与签名

响应参数

字段类型说明
data.planIdString订阅计划 ID(后续订阅时使用)
data.merchantIdString商户号
data.planNameString计划名称
data.descriptionString计划描述
data.priceBigDecimal订阅价格
data.currencyString货币
data.cycleTypeString周期类型
data.cycleLengthInteger周期长度
data.trialDaysInteger试用天数
data.maxSubscriptionsInteger最大订阅数
data.currentSubscriptionsInteger当前订阅数
data.statusString计划状态(ACTIVE
data.createTimeString创建时间

请求示例

json
{
  "merchantId": "MERCHANT_001",
  "planName": "Basic Monthly Plan",
  "description": "Basic features, billed monthly",
  "price": "9.99",
  "currency": "USD",
  "cycleType": "MONTHLY",
  "cycleLength": 1,
  "trialDays": 7,
  "maxSubscriptions": 1000,
  "sign": "calculated_signature"
}

响应示例

json
{
  "rtn_code": "0000",
  "success": true,
  "data": {
    "planId": "PLAN_MERCHANT001_20241021001",
    "merchantId": "MERCHANT_001",
    "planName": "Basic Monthly Plan",
    "description": "Basic features, billed monthly",
    "price": 9.99,
    "currency": "USD",
    "cycleType": "MONTHLY",
    "cycleLength": 1,
    "trialDays": 7,
    "maxSubscriptions": 1000,
    "currentSubscriptions": 0,
    "status": "ACTIVE",
    "createTime": "2024-10-21 10:00:00"
  }
}

Codrimpay