计费相关
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 计费相关 > API 文档 > 订单管理相关接口 > 获取代金券相关信息

获取代金券相关信息

最近更新时间：2024-03-12 01:10:26

我的收藏

本页目录：

1. 接口描述

接口请求域名： billing.tencentcloudapi.com 。

获取代金券相关信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeVoucherInfo。
Version 是 String 公共参数，本接口取值：2018-07-09。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 是 Integer 一页多少条数据，默认是20条，最大不超过1000
示例值：10
Offset 是 Integer 第多少页，默认是1
示例值：1
Status 否 String 券状态：待使用：unUsed，已使用： used，已发货：delivered，已作废： cancel，已过期：overdue
示例值：unUsed
VoucherId 否 String 代金券id
示例值：123
CodeId 否 String 代金券订单id
示例值：123
ProductCode 否 String 商品码
示例值：a
ActivityId 否 String 活动id
示例值：123
VoucherName 否 String 代金券名称
示例值：aa
TimeFrom 否 String 发放开始时间,例：2021-01-01
示例值：2021-01-01
TimeTo 否 String 发放结束时间，例：2021-01-01
示例值：2021-01-01
SortField 否 String 指定排序字段：BeginTime开始时间、EndTime到期时间、CreateTime创建时间
示例值：BeginTime
SortOrder 否 String 指定升序降序：desc、asc
示例值：desc
PayMode 否 String 付费模式，postPay后付费/prePay预付费/riPay预留实例/""或者"*"表示全部模式，如果payMode为""或"*"，那么productCode与subProductCode必须传空
示例值：postPay
PayScene 否 String 付费场景PayMode=postPay时：spotpay-竞价实例,"settle account"-普通后付费PayMode=prePay时：purchase-包年包月新购，renew-包年包月续费（自动续费），modify-包年包月配置变更(变配）PayMode=riPay时：oneOffFee-预留实例预付，hourlyFee-预留实例每小时扣费，-支持全部付费场景
示例值：
Operator 否 String 操作人，默认就是用户uin
示例值：aa
VoucherMainType 否 String 代金券主类型 has_price 为有价现金券 no_price 为无价代金券
示例值：no_price
VoucherSubType 否 String 代金券副类型 discount 为折扣券 deduct 为抵扣券
示例值：discount

3. 输出参数

参数名称 类型 描述
TotalCount Integer 券总数
示例值：0
TotalBalance Integer 总余额（微分）
示例值：0
VoucherInfos Array of VoucherInfos 代金券相关信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取代金券相关信息

获取代金券相关信息

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeVoucherInfo
&Limit=10
&Offset=1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "9988deda-d6b4-4c74-9bbf-b3f0cd4f5dba",
        "TotalBalance": 42000000000,
        "TotalCount": 2,
        "VoucherInfos": [
            {
                "ApplicableProducts": {
                    "GoodsName": "全产品通用",
                    "PayMode": "*"
                },
                "Balance": 12000000000,
                "BeginTime": "2023-01-10 14:42:17",
                "EndTime": "2023-04-10 14:42:17",
                "ExcludedProducts": [
                    {
                        "GoodsName": "域名注册",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "云市场",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "云市场镜像",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "培训服务training",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "节省计划",
                        "PayMode": "*"
                    }
                ],
                "NominalValue": 30000000000,
                "OwnerUin": "100026601318",
                "PayMode": "*",
                "PayScene": "settle account",
                "Status": "unUsed",
                "VoucherId": "OZRCGNAV5AB9H9ECMP1VVP"
            },
            {
                "ApplicableProducts": {
                    "GoodsName": "全产品通用",
                    "PayMode": "*"
                },
                "Balance": 30000000000,
                "BeginTime": "2023-02-07 16:40:45",
                "EndTime": "2023-05-08 16:40:45",
                "ExcludedProducts": [
                    {
                        "GoodsName": "域名注册",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "云市场",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "云市场镜像",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "培训服务training",
                        "PayMode": "*"
                    },
                    {
                        "GoodsName": "节省计划",
                        "PayMode": "*"
                    }
                ],
                "NominalValue": 30000000000,
                "OwnerUin": "100026601318",
                "PayMode": "*",
                "PayScene": "settle account",
                "Status": "unUsed",
                "VoucherId": "OZRCGNAV8D9BMI9KMG1FIQ"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.InvalidAppId appId不符。
InternalError 内部错误。
InternalError.GatewayError 网关错误。
InvalidParameter 参数错误。
UnauthorizedOperation.CamNoAuth 账号没有cam授权。
中国站