DescribeVoucherUsageDetails

PDF

Mode fokus

Ukuran font

Terakhir diperbarui: 2026-04-24 15:08:08

1. API Description

Domain name for API request: billing.intl.tencentcloudapi.com.

This API is used to query voucher usage details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeVoucherUsageDetails.
Version	Yes	String	Common Params. The value used for this API: 2018-07-09.
Region	No	String	Common Params. This parameter is not required.
Limit	Yes	Integer	The number of records per page. The default is 20, and the maximum is 1,000.
Offset	Yes	Integer	The page number the records start from. The default is 1.
VoucherId	Yes	String	The voucher ID.
Operator	No	String	The operator. The default is the UIN of the current.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The total number of vouchers.
TotalUsedAmount	Integer	The total amount used. The value of this parameter is the total amount used (USD, rounded to 8 decimal places) multiplied by 100,000,000.
UsageRecords	Array of UsageRecords	Voucher usage record details
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Retrieving Voucher Usage Record

Retrieve voucher usage record

Input Example

https://billing.intl.tencentcloudapi.com/?Action=DescribeVoucherUsageDetails
&Limit=10
&Offset=1
&VoucherId="abc"
&Operator="abc"
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalUsedAmount": 10000000,
        "TotalCount": 1,
        "RequestId": "1820282306173927424",
        "UsageRecords": [
            {
                "UsedAmount": 10000000,
                "PayScene": "common",
                "UsedTime": "2024-03-29 02:03:27",
                "VoucherId": "VHPIUDFG9GUZDESWPR4W99",
                "SeqId": "10071_2024032902_1300223973_1711649007",
                "UsageDetails": [
                    {
                        "Action": "purchase",
                        "BillingItemCode": "v_cvm_bandwidth",
"SubProductName": "Cloud Virtual Machine (CVM)-standard type S1",
                        "SubProductEnName": "CVM Standard S1",
"ProductName": "Cloud Virtual Machine (CVM)"
                        "ProductCode": "cvm",
                        "SubBillingItemCode": "sv_cvm_bandwidth_prepay",
                        "ProductEnName": "Cloud Virtual Machine(CVM)",
                        "CalcUnit": "1",
                        "SubProductCode": "p_cvm"
                    }
                ],
                "PayMode": "postpay"
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.InvalidAppId	Invalid App ID.
InternalError	Internal error.
InternalError.GatewayError	Gateway error.
InvalidParameter	Invalid parameter.
UnauthorizedOperation.CamNoAuth	The account does not have CAM permission.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Billing Center