1. API Description
Domain name for API request: intlpartnersmgt.tencentcloudapi.com.
This API is used to query bill details by customers.
A maximum of 5 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: DescribeBillDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-28. |
| Region | No | String | Common Params. This parameter is not required. |
| Month | Yes | String | The queried month in the format of "YYYY-MM", such as 2023-01. |
| PageSize | Yes | Integer | Page parameter: Indicates the number of entries per page. Value range: [1, 200] |
| Page | Yes | Integer | Page parameter: Indicates the current page number. The minimum value is 1. |
| PayMode | No | String | Billing mode. Valid values: prePay (Monthly subscription), postPay` (Pay-As-You-Go resources). |
| ActionType | No | String | Transaction type. Valid values: prepay_purchase (Purchase), prepay_renew (Renewal), prepay_modify (Upgrade/Downgrade), prepay_return ( Monthly subscription refund), postpay_deduct (Pay-as-you-go), postpay_deduct_h (Hourly settlement), postpay_deduct_d (Daily settlement), postpay_deduct_m (Monthly settlement), offline_deduct (Offline project deduction), online_deduct (Offline product deduction), recon_deduct (Adjustment - deduction), recon_increase (Adjustment - compensation), ripay_purchase (One-off RI Fee), postpay_deduct_s (Spot), ri_hour_pay (Hourly RI fee), prePurchase (New monthly subscription), preRenew (Monthly subscription renewal), preUpgrade (Upgrade/Downgrade), preDowngrade (Upgrade/Downgrade), svp_hour_pay (Hourly Savings Plan fee), recon_guarantee (Minimum spend deduction), pre_purchase (New monthly subscription), pre_renew (Monthly subscription renewal), pre_upgrade (Upgrade/Downgrade), pre_downgrade (Upgrade/Downgrade). |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DetailSet | Array of CustomerBillDetailData | Data details Note: This field may return null, indicating that no valid values can be obtained. |
| Total | Integer | Total number of data entries Note: This field may return null, indicating that no valid values can be obtained. |
| 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 Querying the customer bill details
This example shows you how to query the customer bill details.
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomerBillDetail
Input Example
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillDetail
<Common request parameters>
{
"Month": "2023-02",
"PayMode": "postPay",
"ActionType": "postpay_deduct_h",
"PageSize": "10",
"Page": "1"
}
Output Example
{
"Response": {
"Total": 0,
"DetailSet": [
{
"PayerAccountId": 1230,
"OwnerAccountId": 132,
"OperatorAccountId": 321,
"ProductName": "cloud block storage",
"BillingMode": "Pay-As-You-Go resources",
"ProjectName": "default",
"Region": "East Chinaxa0(Shanghai)",
"AvailabilityZone": "Shanghai Zone 1",
"InstanceId": "123456",
"InstanceName": "the name",
"SubProductName": "HDD cloud block storage",
"TransactionType": "Hourly settlement",
"TransactionId": "2023010112345678",
"TransactionTime": "2023-01-01 00:01:02",
"UsageStartTime": "2023-01-01 00:01:02",
"UsageEndTime": "2023-01-01 00:01:02",
"ComponentType": "volume size",
"ComponentName": "HDD cloud block storage-volume size",
"ComponentListPrice": "0.1",
"ComponentPriceMeasurementUnit": "USD/GB/Second",
"ComponentUsage": "100",
"ComponentUsageUnit": "GB",
"UsageDuration": "100",
"DurationUnit": "Second",
"OriginalCost": "10",
"Currency": "USD",
"TotalCost": "10"
}
],
"RequestId": "asdfgh"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InvalidParameterValue.InvalidMonth | Incorrect month value |
| OperationDenied.ServiceBusy | System busy. Please try again later. |
| UnauthorizedOperation.UinNoAuth | The current user doesn’t have permission for the operation. |
是
否
本页内容是否解决了您的问题？