Contents：
1. API Description
Domain name for API request: billing.tencentcloudapi.com.
This API is used to get the bill summarized by billing mode.
Default API request rate limit: 20 requests/sec.
2. Input Parameters
The list below contains only the API request parameters and certain 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: DescribeBillSummaryByPayMode |
| Version | Yes | String | Common parameter; the version of this API: 2018-07-09 |
| Region | No | String | Common parameter; this parameter is not required for this API. |
| PayerUin | Yes | String | Query payer’s UIN |
| BeginTime | Yes | String | Currently only supports starting from the current month, and the month must be the same as that set for EndTime. For example, 2018-09-01 00:00:00. |
| EndTime | Yes | String | Currently only supports ending in the current month, and the month must be the same as that set for BeginTime. For example, 2018-09-30 23:59:59. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Ready | Integer | Indicates whether the data is ready. 0 = not ready, 1 = ready |
| SummaryOverview | Array of RegionSummaryOverviewItem | Detailed cost distribution for all billing modes Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Examples
Example 1: Getting the bill summarized by billing mode
Input example
https://billing.tencentcloudapi.com/?Action=DescribeBillSummaryByPayMode
&PayerUin=909619400
&BeginTime=2018-11-01 00:00:00
&EndTime=2018-11-01 23:59:59
&<Common Request Parameters>Output example
{
"Response": {
"Ready": 1,
"SummaryOverview": [
{
"PayMode": "postPay",
"PayModeName": "Pay-as-You-Go",
"RealTotalCost": "1596.49",
"CashPayAmount": "1420.49",
"IncentivePayAmount": "0.00",
"VoucherPayAmount": "176.00",
"RealTotalCostRatio": "100.00",
"Detail": [
{
"ActionType": "postpay_deduct",
"ActionTypeName": "Pay-as-You-Go deduction",
"RealTotalCost": "1598.44",
"CashPayAmount": "1422.45",
"IncentivePayAmount": "0.00",
"VoucherPayAmount": "175.99",
"RealTotalCostRatio": "100.00",
"BillMonth": "2018-11"
}
]
}
],
"RequestId": "f40a84b9-d74b-4cf5-89ea-56558baf1c96"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
6. Error Codes
There are no error codes related to this API. For other error codes, see Common Error Codes.
