获取代金券使用记录

最近更新时间:2024-09-11 01:11:24

我的收藏

1. 接口描述

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

获取代金券使用记录

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVoucherUsageDetails。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 一页多少条数据,默认是20条,最大不超过1000
示例值:10
Offset Integer 第多少页,默认是1
示例值:1
VoucherId String 代金券id
示例值:123
Operator String 操作人,默认就是用户uin
示例值:aa

3. 输出参数

参数名称 类型 描述
TotalCount Integer 券总数
示例值:0
TotalUsedAmount Integer 总已用金额(微分)
示例值:0
UsageRecords Array of UsageRecords 代金券使用记录细节
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取代金券使用记录

获取代金券使用记录

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeVoucherUsageDetails
&Limit=10
&Offset=1
&VoucherId="abc"
&Operator="abc"
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "9168e8fe-ed79-4726-9ced-29033e5a7011",
        "TotalCount": 5,
        "TotalUsedAmount": 5000000,
        "UsageRecords": [
            {
                "PayMode": "prepay",
                "PayScene": "",
                "SeqId": "20240212840001259973831114",
                "UsageDetails": [
                    {
                        "Action": "purchase",
                        "BillingItemCode": "",
                        "CalcUnit": "",
                        "ProductCode": "p_cvm",
                        "ProductEnName": "Cloud Virtual Machine(CVM)",
                        "ProductName": "云服务器CVM",
                        "SubBillingItemCode": "",
                        "SubProductCode": "sp_cvm_s2",
                        "SubProductEnName": "CVM Standard S2",
                        "SubProductName": "云服务器CVM-标准型S2"
                    }
                ],
                "UsedAmount": 1000000,
                "UsedTime": "2024-02-12 15:54:56",
                "VoucherId": "WFRCNWBQBHNYJTZ3XLGE3T"
            },
            {
                "PayMode": "postpay",
                "PayScene": null,
                "SeqId": "20240212799000283860282006",
                "UsageDetails": [
                    {
                        "Action": "",
                        "BillingItemCode": "",
                        "CalcUnit": "1",
                        "ProductCode": "p_ccn",
                        "ProductEnName": "Cloud Connect Network",
                        "ProductName": "云联网CCN",
                        "SubBillingItemCode": "",
                        "SubProductCode": "sp_ccn_connecting_instance",
                        "SubProductEnName": "Cloud Connect Network-connecting-instance",
                        "SubProductName": "云联网网络连接实例费"
                    }
                ],
                "UsedAmount": 1000000,
                "UsedTime": "2024-02-12 15:53:33",
                "VoucherId": "WFRCNWBQBHNYJTZ3XLGE3T"
            },
            {
                "PayMode": "postpay",
                "PayScene": null,
                "SeqId": "20240212799000283860282005",
                "UsageDetails": [
                    {
                        "Action": "",
                        "BillingItemCode": "",
                        "CalcUnit": "1",
                        "ProductCode": "p_ccn",
                        "ProductEnName": "Cloud Connect Network",
                        "ProductName": "云联网CCN",
                        "SubBillingItemCode": "",
                        "SubProductCode": "sp_ccn_connecting_instance",
                        "SubProductEnName": "Cloud Connect Network-connecting-instance",
                        "SubProductName": "云联网网络连接实例费"
                    }
                ],
                "UsedAmount": 1000000,
                "UsedTime": "2024-02-12 15:36:54",
                "VoucherId": "WFRCNWBQBHNYJTZ3XLGE3T"
            },
            {
                "PayMode": "prepay",
                "PayScene": "",
                "SeqId": "20240212840001259973831111",
                "UsageDetails": [
                    {
                        "Action": "purchase",
                        "BillingItemCode": "",
                        "CalcUnit": "",
                        "ProductCode": "p_cvm",
                        "ProductEnName": "Cloud Virtual Machine(CVM)",
                        "ProductName": "云服务器CVM",
                        "SubBillingItemCode": "",
                        "SubProductCode": "sp_cvm_s2",
                        "SubProductEnName": "CVM Standard S2",
                        "SubProductName": "云服务器CVM-标准型S2"
                    }
                ],
                "UsedAmount": 1000000,
                "UsedTime": "2024-02-12 15:15:49",
                "VoucherId": "WFRCNWBQBHNYJTZ3XLGE3T"
            },
            {
                "PayMode": "prepay",
                "PayScene": "",
                "SeqId": "20240212840001259973831109",
                "UsageDetails": [
                    {
                        "Action": "purchase",
                        "BillingItemCode": "",
                        "CalcUnit": "",
                        "ProductCode": "p_cvm",
                        "ProductEnName": "Cloud Virtual Machine(CVM)",
                        "ProductName": "云服务器CVM",
                        "SubBillingItemCode": "",
                        "SubProductCode": "sp_cvm_s2",
                        "SubProductEnName": "CVM Standard S2",
                        "SubProductName": "云服务器CVM-标准型S2"
                    }
                ],
                "UsedAmount": 1000000,
                "UsedTime": "2024-02-12 15:14:18",
                "VoucherId": "WFRCNWBQBHNYJTZ3XLGE3T"
            }
        ]
    }
}

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授权。