Domain name for API request: billing.tencentcloudapi.com.
This API is used to query bill details.
A maximum of 5 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 parameter. The value used for this API: DescribeBillDetail. |
| 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. |
| Offset | Yes | Integer | Offset |
| Limit | Yes | Integer | Quantity, maximum is 100 |
| PeriodType | Yes | String | The period type. byUsedTime: By usage period; byPayTime: By payment period. Must be the same as the period of the current monthly bill of the Billing Center. You can check your bill statistics period type at the top of the Bill Overview page. |
| Month | No | String | Month; format: yyyy-mm. You only have to enter either Month or BeginTime and EndTime. When you enter values for BeginTime and EndTime, Month becomes invalid. This value must be no earlier than the month when Bill 2.0 is activated; last 24 months data are available. |
| BeginTime | No | String | The start time of the period; format: Y-m-d H:i:s. You only have to enter either Month or BeginTime and EndTime. When you enter values for BeginTime and EndTime, Month becomes invalid. BeginTime and EndTime must be inputted as a pair. This value must be no earlier than the month when Bill 2.0 is activated; last 24 months data are available. |
| EndTime | No | String | The end time of the period; format: Y-m-d H:i:s. You only have to enter either Month or BeginTime and EndTime. When you enter values for BeginTime and EndTime, Month becomes invalid. BeginTime and EndTime must be inputted as a pair. This value must be no earlier than the month when Bill 2.0 is activated; last 24 months data are available. |
| NeedRecordNum | No | Integer | Indicates whether or not the total number of records of accessing the list is required, used for frontend pages. 1 = yes, 0 = no |
| ProductCode | No | String | Queries information on a specified product |
| PayMode | No | String | Billing mode: prePay/postPay |
| ResourceId | No | String | Queries information on a specified resource |
| ActionType | No | String |
| Parameter Name | Type | Description |
|---|---|---|
| DetailSet | Array of BillDetail | Details list |
| Total | Integer | Total number of records 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. |
https://billing.tencentcloudapi.com/?Action=DescribeBillDetail
&Month=2018-07
&PeriodType=byPayTime
&Offset=0
&Limit=1
&BeginTime=2018-11-01 00:00:00
&EndTime=2018-11-01 23:59:59
&NeedRecordNum=1
&ResourceId=ins-49zhx6z1
&<Common request parameters>{
"Response": {
"DetailSet": {
"PayerUin": "20548499",
"OwnerUin": "20548499",
"OperateUin": "20548499",
"BusinessCodeName": "FaceID",
"ProductCodeName": "Bank card information verification",
"PayModeName": "Pay-as-you-go",
"ProjectName": "Default project",
"RegionName": "South China (Guangzhou)",
"ZoneName": "-",
"ResourceId": "huiyan_idbankcard-1251006373-201907",
"ResourceName": "-",
"ActionTypeName": "monthly settlement",
"OrderId": "201907",
"BillId": "20190612020000003179923224518398",
"PayTime": "2019-06-12 14:56:05",
"FeeBeginTime": "2019-06-01 00:00:00",
"FeeEndTime": "2019-06-30 23:59:59",
"RegionId": 1,
"ComponentSet": [
{
"ComponentCodeName": "Three bank card identifiers",
"ItemCodeName": "FaceID - three bank card identifiers",
"SinglePrice": "0.4",
"ContractPrice": "0.4",
"SpecifiedPrice": "0.4",
"PriceUnit": "USD/count/month",
"UsedAmount": "5",
"UsedAmountUnit": "count",
"TimeSpan": "1",
"TimeUnitName": "Month",
"Cost": "2",
"Discount": "1",
"ReduceType": "Discount",
"RealCost": "2",
"VoucherPayAmount": "0",
"CashPayAmount": "2",
"IncentivePayAmount": "0"
}
],
"Tags": [
{
"TagKey": "-",
"TagValue": "-"
}
]
},
"Total": 1,
"RequestId": "d11d7149-3a4a-496c-999a-9287adf0962e"
}
}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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| UnsupportedOperation |
Was this page helpful?