tencent cloud

All product documents
APIs
DocumentationAPIsInternational PartnersBill Management APIsDescribeBillSummaryByPayMode
DescribeBillSummaryByPayMode
Last updated: 2025-02-27 10:07:26
DescribeBillSummaryByPayMode
Last updated: 2025-02-27 10:07:26

1. API Description

Domain name for API request: intlpartnersmgt.intl.tencentcloudapi.com.

This API is used to obtain the total amount of customer bills by payment mode.
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: DescribeBillSummaryByPayMode.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
BillMonth Yes String Bill month in the format of "yyyy-MM"
CustomerUin Yes Integer Customer UIN

3. Output Parameters

Parameter Name Type Description
SummaryOverview Array of PayModeSummaryOverviewItem Get the payment mode details of the sub-customer bill summary through the api.
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 Obtaining the total amount of customer bills by payment mode

This example shows you how to obtain the total amount of customer bills by payment mode.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummaryByPayMode
<Common request parameters>

{
    "BillMonth": "2022-11",
    "CustomerUin": 123456
}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support