Domain name for API request: intlpartnersmgt.tencentcloudapi.com.
This API is used to obtain the total amount of customer bills by payment mode.
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: DescribeBillSummaryByPayMode. |
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. |
BillMonth | Yes | String | Bill month in the format of "yyyy-MM" |
CustomerUin | Yes | Integer | Customer UIN |
Parameter Name | Type | Description |
---|---|---|
SummaryOverview | Array of PayModeSummaryOverviewItem | Payment mode details in the customer bill data totaled by payment mode 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 obtain the total amount of customer bills by payment mode.
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummaryByPayMode
<Common request parameters>
{
"BillMonth": "2022-11",
"CustomerUin": 123456
}
{
"Response": {
"SummaryOverview": [
{
"PayMode": "postPay",
"PayModeName": "Pay-As-You-Go resources",
"OriginalCost": "100.00000000",
"Detail": [
{
"ActionType": "postpay_deduct_h",
"ActionTypeName": "Hourly settlement",
"OriginalCost": "100.00000000",
"VoucherPayAmount": "100.00000000",
"TotalCost": "100.00000000"
}
],
"VoucherPayAmount": "100.00000000",
"TotalCost": "100.00000000"
}
],
"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.UinNoAuth | The current user doesn’t have permission for the operation. |
Was this page helpful?