1. API Description
Domain name for API request: billing.tencentcloudapi.com.
This API is used to check whether the current UIN has any adjustment, enabling customers to proactively obtain the adjustment status faster.
A maximum of 20 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: DescribeBillAdjustInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required. |
| Month | No | String | Format: yyyy-MM. Billing month. Either Month or the combination of TimeFrom and TimeTo needs to be passed. If the TimeFrom and TimeTo are passed, the Month field is invalid. Example: 2024-10. |
| TimeFrom | No | String | Format: yyyy-MM-dd. Start date. Either Month or the combination of TimeFrom and TimeTo needs to be passed. If TimeFrom and TimeTo are passed, the Month field is invalid. TimeFrom and TimeTo should represent the same month and be passed in together. Cross-month queries are not supported. The result will include the full month's data. Example: 2024-10-01. |
| TimeTo | No | String | Format: yyyy-MM-dd. End date. Either Month or the combination of TimeFrom and TimeTo needs to be passed. If TimeFrom and TimeTo are passed, the Month field is invalid. TimeFrom and TimeTo should represent the same month and be passed in together. Cross-month queries are not supported. The result will include the full month's data. Example: 2024-10-02. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total amount of data. Example value: 10. |
| Data | Array of AdjustInfoDetail | Detailed data. Example value: []. |
| 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 Bill Exception Adjustment Information
This example shows you how to obtain bill exception adjustment information by month.
Input Example
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillAdjustInfo
<Common request parameters>
{
"Month": "2023-09"
}
Output Example
{
"Response": {
"Data": [
{
"AdjustAmount": 2346.28,
"AdjustCompletionTime": "2024-10-21 17:50:46",
"AdjustNum": "20230906159081",
"AdjustType": "manualAdjustment",
"Month": "2023-09",
"PayerUin": "909619400"
},
{
"AdjustAmount": 5318.81,
"AdjustCompletionTime": "2024-10-21 17:44:14",
"AdjustNum": "20230909111993",
"AdjustType": "manualAdjustment",
"Month": "2023-09",
"PayerUin": "909619400"
}
],
"RequestId": "7fd119c4-8f8b-4355-b365-6df62b7d6660",
"Total": 2
}
}
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 |
|---|---|
| InternalError.InternalError | An internal system error occurred. |
| InvalidParameter.InvalidParameter | A parameter error occurred. |
是
否
本页内容是否解决了您的问题？