Domain name for API request: intlpartnersmgt.tencentcloudapi.com.
This API is used to query the customer 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 Params. The value used for this API: DescribeCustomerBillDetail. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
CustomerUin | Yes | Integer | Customer UIN |
Month | Yes | String | The queried month in “YYYY-MM” format, 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) |
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) |
IsConfirmed | No | String | Payment status0 : N/A1 : Paid2 : Unpaid |
Parameter Name | Type | Description |
---|---|---|
Total | Integer | Total number of data entries |
DetailSet | Array of BillDetailData | Data details Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to get the customer bill details through API.
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomerBillDetail
<Common request parameters>
{
"CustomerUin": 1,
"Month": "2023-02",
"PayMode": "postPay",
"ActionType": "postpay_deduct_h",
"IsConfirmed": "0",
"PageSize": 10,
"Page": 1
}
{
"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": "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",
"DiscountRate": "1",
"Currency": "USD",
"TotalAmountAfterDiscount": "10",
"VoucherDeduction": "0",
"TotalCost": "10"
}
],
"RequestId": "asdfgh"
}
}
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 |
---|---|
InvalidParameterValue.InvalidMonth | Incorrect month value |
OperationDenied.ServiceBusy | System busy. Please try again later. |
UnauthorizedOperation.NotCustomerUin | The current user is not a customer. |
UnauthorizedOperation.UinNoAuth | The current user doesn’t have permission for the operation. |
Was this page helpful?