POST 应用代金券
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | POST |
| 接口地址 | /console/v1/promo_code/apply |
| 所属业务 | 插件 |
| 来源模块/系统 | 优惠码插件 |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
应用代金券,新购/续费/升降级等,可使用此接口对代金券进行验证
请求体
正在加载示例…请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | 是 | — |
| body.scene | body | string | 是 | 代金券应用场景:new新购,renew续费,upgrade升降级,change_billing_cycle按需转包年包月 |
| body.promo_code | body | string | 否 | 代金券 新购时必传 |
| body.host_id | body | integer(int32) | 否 | 产品ID |
| body.product_id | body | integer(int32) | 是 | 商品ID |
| body.qty | body | integer(int32) | 否 | 数量 新购时必传 |
| body.amount | body | integer(int32) | 是 | 单价 |
| body.billing_cycle_time | body | integer(int32) | 否 | — |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.discount | number(double) | 否 | — | — | 折扣金额 |
| data.id | integer(int32) | 否 | — | — | 代金券ID |
| data.loop | integer(int32) | 否 | — | — | 循环折扣0否1是 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |