Help & DocumentationAbout BillingAPI DocumentationBill Management APIsDescribeBillSummaryByPayMode

DescribeBillSummaryByPayMode

Last updated: 2020-02-10 12:56:36

PDF

Contents：

1. API Description

Domain name for API request: billing.tencentcloudapi.com.

Gets the bill summarized according to billing mode

A maximum of 20 requests can be initiated per second for this API.

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 parameter. The value used for this API: DescribeBillSummaryByPayMode
Version Yes String Common parameter. The value used for this API: 2018-07-09
Region No String Common parameter. This parameter is not required for this API.
PayerUin Yes String Query bill data user’s UIN
BeginTime Yes String Only beginning in the current month is supported, and it must be the same month as the EndTime. For example, 2018-09-01 00:00:00.
EndTime Yes String Only ending in the current month is supported, and it must be the same month as the BeginTime. For example, 2018-09-30 23:59:59.

3. Output Parameters

Parameter Name Type Description
Ready Integer Indicates whether or not the data is ready. 0 = not ready, 1 = ready.
SummaryOverview Array of PayModeSummaryOverviewItem Detailed cost distribution for all billing modes
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Gets the bill summarized according to billing mode

Input Example

https://billing.tencentcloudapi.com/?Action=DescribeBillSummaryByPayMode
&PayerUin=909619400
&BeginTime=2018-11-01 00:00:00
&EndTime=2018-11-01 23:59:59
&<Common Request Parameters>

Output Example

{
  "Response": {
    "Ready": 1,
    "SummaryOverview": [
      {
        "PayMode": "prePay",
        "PayModeName": "Monthly subscription",
        “RealTotalCost": "0.00",
        "RealTotalCostRatio": "0.00",
        "Detail": []
      },
      {
        "PayMode": "postPay",
        "PayModeName": "Pay-as-you-go",
        “RealTotalCost": "440.66",
        "RealTotalCostRatio": "100.00",
        "Detail": [
          {
            "ActionType": "postpay_deduct",
            "ActionTypeName": "Pay-as-you-go deduction",
            “RealTotalCost": "441.25",
            "RealTotalCostRatio": "99.98"
          },
          {
            "ActionType": "offline_deduct",
            "ActionTypeName": "",
            “RealTotalCost": "0.10",
            "RealTotalCostRatio": "0.02"
          },
          {
            "ActionType": "billVirtualId",
            "ActionTypeName": "Monthly billing precision discrepancy",
            “RealTotalCost": "-0.69",
            "RealTotalCostRatio": "0.00"
          }
        ]
      }
    ],
    "RequestId": "59a408bc-5d95-4d40-bf21-58e5e8d48dd0"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.