tencent cloud

Billing Center

Release Notes and Announcements
Release Notes
Product Announcements
Billing Details
Billing Mode
Frozen Funds
Balance Notifications
Refunds
Billing Mode
Yearly/Monthly Subscription Products
Purchase Guide
Purchasing Cloud Services
Payment Methods
Beneficiary Account Bank Transfer
Top-up
Payment Methods for Prepaid Products
Post-paid Account Payment
Auto-payment
Transactions
Promo Vouchers
Savings Plan
Renewal Management
Bill Management
View bills
Bill Introduction
Fields in Bills
Usage Details
Billing Export Center
Bill subscription
Saving Bills to COS
Granting Billing-related CAM Access
Self-Service Invoice
Tax Management
FOCUS 1.0
FOCUS 1.0 Conformance Gaps
Cost Management
Consumption Bill Overview
Consumption Bill Description
Anomaly Detection
Fields in Consumption Bill
Cost Explorer
Budget Management
Cost Allocation Management
Cost Allocation Units
Cost Allocation Bill
Cost Allocation Tags
Cost Allocation Backtracking
API Documentation
API Category
Funds Management APIs
Order Management APIs
Resource Management APIs
Bill Management APIs
Cost Allocation Management APIs
Cost Management APIs
Making API Requests
Organization Account APIs
Data Types
Error Codes
FAQs
Bills
Promo Vouchers
Renewal

DescribeBillSummaryByProduct

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-11-13 20:46:27

1. API Description

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

Gets the bill summarized according to product

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: DescribeBillSummaryByProduct.
Version Yes String Common Params. The value used for this API: 2018-07-09.
Region No String Common Params. This parameter is not required.
BeginTime Yes String The value must be of the same month as EndTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018.
EndTime Yes String The value must be of the same month as BeginTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018.
PayerUin No String Queries bill data user's UIN
PayType No String A bill type, which corresponds to a subtotal type of L0 bills.
This parameter has become valid since v3.0 bills took effect in May 2021.
Valid values:
consume: consumption
refund: refund
adjustment: bill adjustment

3. Output Parameters

Parameter Name Type Description
Ready Integer Indicates whether the data is ready. 0: Not ready. 1: Ready. If Ready is 0, it indicates that the current UIN is initializing billing for the first time. Wait for 5-10 minutes and try again.
SummaryTotal BusinessSummaryTotal Total cost details
Note: This field may return null, indicating that no valid value was found.
SummaryOverview Array of BusinessSummaryOverviewItem Cost distribution of all products
Note: This field may return null, indicating that no valid value was found.
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 Getting the bill summarized by product

This example shows you how to get the bill summarized by product.

Input Example

POST / HTTP/1.1Host: billing.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBillSummaryByProduct<Common request parameters>{    "EndTime": "2018-11",    "BeginTime": "2018-11"}

Output Example

{
    "Response": {
        "Ready": 1,
        "RequestId": "2ed6ea97-3052-431c-938c-bc5d166862d9",
        "SummaryOverview": [
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_cdh",
                "BusinessCodeName": "CVM Dedicated Host(CDH)",
                "CashPayAmount": "2547.01736286",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "2547.01736286",
                "RealTotalCostRatio": "78.53",
                "TotalCost": "4581.36000000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_svp",
                "BusinessCodeName": "Saving Plan",
                "CashPayAmount": "432.03240000",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "432.03240000",
                "RealTotalCostRatio": "13.32",
                "TotalCost": "396.36000000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_cbs",
                "BusinessCodeName": "cloud block storage",
                "CashPayAmount": "131.70202768",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "131.70202768",
                "RealTotalCostRatio": "4.06",
                "TotalCost": "483.58967000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_nat",
                "BusinessCodeName": "NAT Gateway",
                "CashPayAmount": "68.26613290",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "68.26613290",
                "RealTotalCostRatio": "2.10",
                "TotalCost": "93.60000000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_cvm",
                "BusinessCodeName": "Cloud Virtual Machine(CVM)",
                "CashPayAmount": "34.69206519",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "34.69206519",
                "RealTotalCostRatio": "1.07",
                "TotalCost": "33.38087375",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_redis",
                "BusinessCodeName": "TencentDB for Redis",
                "CashPayAmount": "21.00957669",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "21.00957669",
                "RealTotalCostRatio": "0.65",
                "TotalCost": "77.95693680",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_clb",
                "BusinessCodeName": "Cloud Load Balancer",
                "CashPayAmount": "6.93276770",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "6.93276770",
                "RealTotalCostRatio": "0.21",
                "TotalCost": "42.90000000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_eip",
                "BusinessCodeName": "Cloud Public IP",
                "CashPayAmount": "1.29682227",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "1.29682227",
                "RealTotalCostRatio": "0.04",
                "TotalCost": "32.42389139",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_cls",
                "BusinessCodeName": "cloud log service",
                "CashPayAmount": "0.37071133",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "0.37071133",
                "RealTotalCostRatio": "0.01",
                "TotalCost": "0.84700000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_privatedns",
                "BusinessCodeName": "Private DNS",
                "CashPayAmount": "0.21486340",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "0.21486340",
                "RealTotalCostRatio": "0.01",
                "TotalCost": "0.45000000",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            },
            {
                "BillMonth": "2024-11",
                "BusinessCode": "p_cos",
                "BusinessCodeName": "Cloud Object Storage",
                "CashPayAmount": "0.04614960",
                "IncentivePayAmount": "0.00000000",
                "RealTotalCost": "0.04614960",
                "RealTotalCostRatio": "0.00",
                "TotalCost": "0.06573282",
                "TransferPayAmount": "0.00000000",
                "VoucherPayAmount": "0.00000000"
            }
        ],
        "SummaryTotal": {
            "CashPayAmount": "3243.58087962",
            "IncentivePayAmount": "0.00000000",
            "RealTotalCost": "3243.58087962",
            "TotalCost": "5742.93410476",
            "TransferPayAmount": "0.00000000",
            "VoucherPayAmount": "0.00000000"
        }
    }
}

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

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
AuthFailure.UnauthorizedOperation No permission.
InternalError Internal error.
InternalError.GatewayError Gateway error.
InternalError.UnknownError Undefined exception.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan