DescribeBillSummaryByRegion

Last updated: 2020-12-17 16:55:34

1. API Description

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

Gets the bill summarized according to region

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 parameter. The value used for this API: DescribeBillSummaryByRegion.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
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

3. Output Parameters

Parameter Name Type Description
Ready Integer Indicates whether or not the data is ready. 0 = not ready, 1 = ready.
SummaryOverview Array of RegionSummaryOverviewItem Detailed cost distribution for all regions
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the bill summarized by region

Input Example

https://billing.tencentcloudapi.com/?Action=DescribeBillSummaryByRegion
&BeginTime=2018-11
&EndTime=2018-11
&<Common request parameters>

Output Example

{
    "Response": {
        "Ready": 1,
        "SummaryOverview": [
            {
                "RegionId": "4",
                "RealTotalCost": "1330.52",
                "CashPayAmount": "1330.52",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "83.26",
                "BillMonth": "2018-11",
                "RegionName": "East China (Shanghai)",
            },
            {
                "RegionId": "1",
                "RealTotalCost": "200.85",
                "CashPayAmount": "24.87",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "175.99",
                "RealTotalCostRatio": "12.57",
                "BillMonth": "2018-11",
                "RegionName": "South China (Guangzhou)"
            },
            {
                "RegionId": "8",
                "RealTotalCost": "66.58",
                "CashPayAmount": "66.58",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "4.17",
                "BillMonth": "2018-11",
                "RegionName": "North China (Beijing)",
            },
            {
                "RegionId": "16",
                "RealTotalCost": "0.02",
                "CashPayAmount": "0.02",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Southwest China (Chengdu)"
            },
            {
                "RegionId": "19",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Southwest China (Chongqing)"
            },
            {
                "RegionId": "24",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Europe (Moscow)"
            },
            {
                "RegionId": "6",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "North America (Toronto)",
            },
            {
                "RegionId": "9",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Southeast Asia (Singapore)",
            },
            {
                "RegionId": "17",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Europe (Germany)"
            },
            {
                "RegionId": "5",
                "RealTotalCost": "0.00",
                "CashPayAmount": "0.00",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.00",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Hong Kong, Macao and Taiwan, China (Hong Kong)"
            },
            {
                "RegionId": "0",
                "RealTotalCost": "-1.49",
                "CashPayAmount": "-1.50",
                "IncentivePayAmount": "0.00",
                "VoucherPayAmount": "0.01",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2018-11",
                "RegionName": "Others",
            }
        ],
        "RequestId": "88268803-850d-44bc-8d64-df857c2d7487"
    }
}

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help