跳转到主要内容
POST
/
open
/
v1
/
plan
/
save
cURL
curl --request POST \
  --url http://sandbox.mintlify.com/open/v1/plan/save \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchantPlanNo": "plan031004",
  "planName": "计划01",
  "planDesc": "计划描述01",
  "priceNo": "3"
}
'
{
  "code": "0",
  "message": "",
  "data": {
    "merchantPlanNo": "plan031004",
    "planNo": "63784604430893064"
  },
  "success": true
}

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"9578"

请求体

application/json

创建订阅计划参数

merchantPlanNo
string
必填

商户订阅计划编号,全局唯一标识

示例:

"PLAN20231024001"

planName
string
必填

订阅计划名称,最多20字符

示例:

"高级月度会员"

planDesc
string
必填

订阅计划描述,最多100字符

示例:

"解锁平台所有高级功能与无限制下载权限"

priceNo
string
必填

关联的价格编号

示例:

"PRICE_10023"

trialDays
integer<int32>

试用天数,默认授权后立即扣款

示例:

7

totalPayCount
integer<int32>

扣款总次数,不填按长期处理

示例:

12

endTime
integer<int64>

订阅结束时间,毫秒时间戳;不填按长期处理

示例:

1735660800000

authorizedAmount
string

授权额度,用户需授权的代币数量

示例:

"200.000000"

响应

200 - application/json

创建订阅计划成功

code
string

响应码,0 表示成功

示例:

"0"

message
string

响应描述,成功时为空

示例:

""

success
boolean

请求是否成功

示例:

true

data
object

响应数据