Skip to content

PUT /api/redeem-codes/:id

请求

内容
方法PUT
路径/api/redeem-codes/:id
鉴权管理员高级版

Header 参数

参数位置类型必填说明
AuthorizationHeaderstringBearer <jwt>
Content-TypeHeaderstringapplication/json

Path 参数

参数位置类型必填说明
idPathstring路径参数 id

Query 参数

无。

Body 参数

字段类型说明
codestring兑换码;创建时可留空自动生成。
amountstring/number余额奖励。与 group_id、subscription_plan_id 三者至少一个有效。
group_idnumber/null授予的用户组 ID。
group_duration_daysnumber用户组有效天数,0 表示永久。
subscription_plan_idnumber/null授予的订阅套餐 ID。
subscription_duration_daysnumber订阅有效天数,0 表示永久。
allow_stackingboolean是否允许权益叠加有效期。
max_usesnumber最大使用次数,0 表示不限。
enabledboolean是否启用。
expires_atstring过期时间,RFC3339/ISO 字符串;空字符串表示不过期。

返回值

更新后的兑换码。

返回字段

字段类型说明
idnumber兑换码 ID。
codestring兑换码。
amountstring/number兑换后直接增加的余额,可为 0。
group_idnumber/null授予的用户组 ID。
groupobject用户组对象。
group_duration_daysnumber用户组有效天数,0 表示永久。
subscription_plan_idnumber/null授予的订阅套餐 ID。
subscription_planobject/null订阅套餐对象。
subscription_duration_daysnumber订阅有效天数,0 表示永久。
allow_stackingboolean同组或同套餐权益是否叠加有效期。
max_usesnumber最大可用次数,0 表示不限。
used_countnumber已使用次数。
enabledboolean是否启用。
expires_atstring/null兑换码过期时间。
created_atstring创建时间。
updated_atstring更新时间。

错误

状态码说明
400参数不合法。
401未登录或登录失效。
403无权限。
404资源不存在。
500服务端错误。

基于 MIT 协议发布(社区版)