International Partners
- User Guide
- Distributor
- Becoming a Distributor
- Reseller Business
- Managing Reseller
- Agreement Management
- Second-Level Reseller
- Customer Business
- Reseller
- Becoming a Reseller
- Account Management
- Employee Management
- Reseller's Customer Business
- Reseller's Customer Management
- Finance Management
- Bill Management
- Settlement Management
- Commission Management
- Customer
- Account Management
- Impact on Account Assets
- Bill Management
- Agreement Management
- Partner Academy
- Access Management
- API Documentation
- Making API Requests
- Customer Management APIs
- Credit Management APIs
- Agent-Related Interfaces
- Bill Management APIs
DescribeCustomerBillSummary
Last updated: 2025-02-27 10:07:22
1. API Description
Domain name for API request: intlpartnersmgt.intl.tencentcloudapi.com.
This API is used to query the total amount of customer bills.
Callable roles: Distributor, Second-level reseller, Reseller
A maximum of 1 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: DescribeCustomerBillSummary. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-28. |
| Region | No | String | Common Params. This parameter is not required. |
| CustomerUin | Yes | Integer | Customer UIN |
| Month | Yes | String | The queried month in "YYYY-MM" format, such as 2023-01. |
| 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 |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCost | Float | Total amount |
| 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 DescribeCustomerBillSummary
This example shows you how to get the total amount of customer bills through API.
Input Example
POST / HTTP/1.1
Host: intlpartnersmgt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomerBillSummary
<Common request parameters>
{
"CustomerUin": 1,
"Month": "2023-02",
"PayMode": "postPay",
"ActionType": "postpay_deduct_h",
"IsConfirmed": "0"
}
Output Example
{
"Response": {
"TotalCost": 0,
"RequestId": "123456"
}
}
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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No