Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to get bill details by product, project, region, billing mode, and tag by passing in parameters.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeBillSummary. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required. |
| Month | Yes | String | Bill month in the format of "yyyy-mm" |
| GroupType | Yes | String | Bill dimension. Valid values: business, project, region, payMode, and tag |
| TagKey.N | No | Array of String | Tag key, which is used when GroupType is tag. |
| 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. |
| SummaryDetail | Array of SummaryDetail | Detailed summary of costs by multiple dimensions |
| 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. |
This example shows you how to get the details of bill summary by region.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Common request parameters>
{
"Month": "2023-04",
"GroupType": "region"
}{
"Response": {
"Ready": 1,
"RequestId": "6bec8438-9c17-4793-b38d-8aa43d1c6358",
"SummaryDetail": [
{
"Business": [
{
"BusinessCode": "p_ckafka",
"BusinessCodeName": "Message Queue CKafka",
"CashPayAmount": "190.44491904",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "190.44491904",
"TotalCost": "199.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine(CVM)",
"CashPayAmount": "50.55947280",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "89.55947280",
"TotalCost": "116.23401844",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "39.00000000"
},
{
"BusinessCode": "p_emr",
"BusinessCodeName": "Elastic MapReduce",
"CashPayAmount": "38.75629030",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "38.75629030",
"TotalCost": "53.62459200",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_eip",
"BusinessCodeName": "Cloud Public IP",
"CashPayAmount": "0.00004059",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00004059",
"TotalCost": "0.00103833",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "cloud block storage",
"CashPayAmount": "-21.51352251",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "-7.94874051",
"TotalCost": "50.44529414",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "13.56478200"
}
],
"CashPayAmount": "258.24720022",
"GroupKey": "1",
"GroupValue": "South China (Guangzhou)",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "310.81198222",
"TotalCost": "419.30494291",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "52.56478200"
},
{
"Business": [
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "cloud block storage",
"CashPayAmount": "1.74120480",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "1.74120480",
"TotalCost": "3.11040000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine(CVM)",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "7.54272000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
],
"CashPayAmount": "1.74120480",
"GroupKey": "5",
"GroupValue": "Hong Kong/Macao/Taiwan (China) (Hong Kong (China))",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "1.74120480",
"TotalCost": "10.65312000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": [
{
"BusinessCode": "p_cos",
"BusinessCodeName": "Cloud Object Storage",
"CashPayAmount": "0.00016748",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00016748",
"TotalCost": "0.00023060",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
],
"CashPayAmount": "0.00016748",
"GroupKey": "33",
"GroupValue": "East China (Nanjing)",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00016748",
"TotalCost": "0.00023060",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": [
{
"BusinessCode": "p_tmp_5def062a6f799",
"BusinessCodeName": "",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "0.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
],
"CashPayAmount": "0.00000000",
"GroupKey": "0",
"GroupValue": "other",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "0.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
]
}
}
This example shows you how to get the details of bill summary by project.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Common request parameters>
{
"Month": "2023-04",
"GroupType": "project"
}{
"Response": {
"Ready": 1,
"RequestId": "62ac11d7-728b-4dfe-9077-fef9a4b43b0a",
"SummaryDetail": [
{
"Business": [
{
"BusinessCode": "p_ckafka",
"BusinessCodeName": "Message Queue CKafka",
"CashPayAmount": "190.44491904",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "190.44491904",
"TotalCost": "199.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine(CVM)",
"CashPayAmount": "50.55947280",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "89.55947280",
"TotalCost": "123.77673844",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "39.00000000"
},
{
"BusinessCode": "p_emr",
"BusinessCodeName": "Elastic MapReduce",
"CashPayAmount": "38.75629030",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "38.75629030",
"TotalCost": "53.62459200",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cos",
"BusinessCodeName": "Cloud Object Storage",
"CashPayAmount": "0.00016748",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00016748",
"TotalCost": "0.00023060",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_eip",
"BusinessCodeName": "Cloud Public IP",
"CashPayAmount": "0.00004059",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00004059",
"TotalCost": "0.00103833",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_tmp_5def062a6f799",
"BusinessCodeName": "",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "0.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "cloud block storage",
"CashPayAmount": "-19.77231771",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "-6.20753571",
"TotalCost": "53.55569414",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "13.56478200"
}
],
"CashPayAmount": "259.98857250",
"GroupKey": "0",
"GroupValue": "default",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "312.55335450",
"TotalCost": "429.95829351",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "52.56478200"
}
]
}
}
This example shows you how to get the details of bill summary by product.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Common request parameters>
{
"Month": "2023-04",
"GroupType": "business"
}{
"Response": {
"Ready": 1,
"RequestId": "46ed3af3-06b6-4cf5-94b9-aea9b0c1908b",
"SummaryDetail": [
{
"Business": null,
"CashPayAmount": "190.44491904",
"GroupKey": "p_ckafka",
"GroupValue": "Message Queue CKafka",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "190.44491904",
"TotalCost": "199.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": null,
"CashPayAmount": "50.55947280",
"GroupKey": "p_cvm",
"GroupValue": "Cloud Virtual Machine(CVM)",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "89.55947280",
"TotalCost": "123.77673844",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "39.00000000"
},
{
"Business": null,
"CashPayAmount": "38.75629030",
"GroupKey": "p_emr",
"GroupValue": "Elastic MapReduce",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "38.75629030",
"TotalCost": "53.62459200",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": null,
"CashPayAmount": "0.00016748",
"GroupKey": "p_cos",
"GroupValue": "Cloud Object Storage",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00016748",
"TotalCost": "0.00023060",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": null,
"CashPayAmount": "0.00004059",
"GroupKey": "p_eip",
"GroupValue": "Cloud Public IP",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00004059",
"TotalCost": "0.00103833",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": null,
"CashPayAmount": "0.00000000",
"GroupKey": "p_tmp_5def062a6f799",
"GroupValue": "",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "0.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"Business": null,
"CashPayAmount": "-19.77231771",
"GroupKey": "p_cbs",
"GroupValue": "cloud block storage",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "-6.20753571",
"TotalCost": "53.55569414",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "13.56478200"
}
]
}
}
This example shows you how to get the details of bill summary by tag.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Common request parameters>
{
"Month": "2023-05",
"GroupType": "tag",
"TagKey": [
"Test Key",
"Department Classification"
]
}{
"Response": {
"Ready": 1,
"RequestId": "fdb44563-4a70-4c41-88a4-68b628a221a8",
"SummaryDetail": [
{
"Business": [
{
"BusinessCode": "p_tencentmeeting_saas",
"BusinessCodeName": "VooV Meeting (SAAS Edition)",
"CashPayAmount": "3284.27",
"IncentivePayAmount": "0.00",
"RealTotalCost": "3284.27",
"TotalCost": "7308.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "Cloud Block Storage (CBS)",
"CashPayAmount": "2583.11",
"IncentivePayAmount": "0.00",
"RealTotalCost": "2583.43",
"TotalCost": "6383.01",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.32"
}
],
"CashPayAmount": "5867.38",
"GroupKey": "Test Key",
"GroupValue": "",
"IncentivePayAmount": "0.00",
"RealTotalCost": "5867.70",
"TotalCost": "13691.01",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.32"
},
{
"Business": [
{
"BusinessCode": "p_nat",
"BusinessCodeName": "NAT Gateway",
"CashPayAmount": "127.44",
"IncentivePayAmount": "0.00",
"RealTotalCost": "127.44",
"TotalCost": "188.93",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"BusinessCode": "p_cls",
"BusinessCodeName": "Cloud Log Service (CLS)",
"CashPayAmount": "0.71",
"IncentivePayAmount": "0.00",
"RealTotalCost": "0.71",
"TotalCost": "1.08",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
],
"CashPayAmount": "128.15",
"GroupKey": "Test Key",
"GroupValue": "123456",
"IncentivePayAmount": "0.00",
"RealTotalCost": "128.15",
"TotalCost": "190.01",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"Business": [
{
"BusinessCode": "p_tencentmeeting_saas",
"BusinessCodeName": "VooV Meeting (SAAS Edition)",
"CashPayAmount": "3284.27",
"IncentivePayAmount": "0.00",
"RealTotalCost": "3284.27",
"TotalCost": "7308.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "Cloud Block Storage (CBS)",
"CashPayAmount": "2583.11",
"IncentivePayAmount": "0.00",
"RealTotalCost": "2583.43",
"TotalCost": "6383.01",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.32"
}
],
"CashPayAmount": "5867.38",
"GroupKey": "Department Classification",
"GroupValue": "",
"IncentivePayAmount": "0.00",
"RealTotalCost": "5867.70",
"TotalCost": "13691.01",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.32"
},
{
"Business": [
{
"BusinessCode": "p_ckafka",
"BusinessCodeName": "CKafka Message Service",
"CashPayAmount": "1076.00",
"IncentivePayAmount": "0.00",
"RealTotalCost": "1076.00",
"TotalCost": "1076.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
],
"CashPayAmount": "1076.00",
"GroupKey": "Department Classification",
"GroupValue": "Purchasing Department",
"IncentivePayAmount": "0.00",
"RealTotalCost": "1076.00",
"TotalCost": "1076.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"Business": [
{
"BusinessCode": "p_yunjing",
"BusinessCodeName": "T-Sec CWPP (CWP)",
"CashPayAmount": "123.18",
"IncentivePayAmount": "0.00",
"RealTotalCost": "123.18",
"TotalCost": "180.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
],
"CashPayAmount": "123.18",
"GroupKey": "Department Classification",
"GroupValue": "Administrative Department",
"IncentivePayAmount": "0.00",
"RealTotalCost": "123.18",
"TotalCost": "180.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"Business": [
{
"BusinessCode": "p_clb",
"BusinessCodeName": "Cloud Load Balancer (CLB)",
"CashPayAmount": "38.31",
"IncentivePayAmount": "0.00",
"RealTotalCost": "38.31",
"TotalCost": "112.20",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"BusinessCode": "p_cos",
"BusinessCodeName": "Cloud Object Storage (COS)",
"CashPayAmount": "0.00",
"IncentivePayAmount": "0.00",
"RealTotalCost": "0.00",
"TotalCost": "0.00",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
],
"CashPayAmount": "38.31",
"GroupKey": "Department Classification",
"GroupValue": "Business Department",
"IncentivePayAmount": "0.00",
"RealTotalCost": "38.31",
"TotalCost": "112.20",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
},
{
"Business": [
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine (CVM)",
"CashPayAmount": "-43.67",
"IncentivePayAmount": "0.00",
"RealTotalCost": "-43.67",
"TotalCost": "-43.67",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
],
"CashPayAmount": "-43.67",
"GroupKey": "Department Classification",
"GroupValue": "Finance Department",
"IncentivePayAmount": "0.00",
"RealTotalCost": "-43.67",
"TotalCost": "-43.67",
"TransferPayAmount": "0.00",
"VoucherPayAmount": "0.00"
}
]
}
}
This example shows you how to get the details of bill summary by billing mode.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Common request parameters>
{
"Month": "2023-04",
"GroupType": "payMode"
}{
"Response": {
"Ready": 1,
"RequestId": "0aa37606-0416-468c-8d3f-7b70dd2542e0",
"SummaryDetail": [
{
"Business": [
{
"BusinessCode": "p_ckafka",
"BusinessCodeName": "Message Queue CKafka",
"CashPayAmount": "190.44491904",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "190.44491904",
"TotalCost": "199.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine(CVM)",
"CashPayAmount": "27.00000000",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "66.00000000",
"TotalCost": "64.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "39.00000000"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "cloud block storage",
"CashPayAmount": "-32.70587451",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "-19.14109251",
"TotalCost": "11.43376214",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "13.56478200"
}
],
"CashPayAmount": "184.73904453",
"GroupKey": "prePay",
"GroupValue": "Monthly subscription",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "237.30382653",
"TotalCost": "274.43376214",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "52.56478200"
},
{
"Business": [
{
"BusinessCode": "p_emr",
"BusinessCodeName": "Elastic MapReduce",
"CashPayAmount": "38.75629030",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "38.75629030",
"TotalCost": "53.62459200",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cvm",
"BusinessCodeName": "Cloud Virtual Machine(CVM)",
"CashPayAmount": "23.55947280",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "23.55947280",
"TotalCost": "59.77673844",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cbs",
"BusinessCodeName": "cloud block storage",
"CashPayAmount": "12.93355680",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "12.93355680",
"TotalCost": "42.12193200",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_cos",
"BusinessCodeName": "Cloud Object Storage",
"CashPayAmount": "0.00016748",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00016748",
"TotalCost": "0.00023060",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_eip",
"BusinessCodeName": "Cloud Public IP",
"CashPayAmount": "0.00004059",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00004059",
"TotalCost": "0.00103833",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
},
{
"BusinessCode": "p_tmp_5def062a6f799",
"BusinessCodeName": "",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "0.00000000",
"TotalCost": "0.00000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
],
"CashPayAmount": "75.24952797",
"GroupKey": "postPay",
"GroupValue": "Pay-As-You-Go resources",
"IncentivePayAmount": "0.00000000",
"RealTotalCost": "75.24952797",
"TotalCost": "155.52453137",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.TagKeyNotExist | This cost allocation tag key does not exist. |
| InternalError | Internal error. |
| InternalError.GatewayError | Gateway error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
Feedback