tencent cloud

All product documents
About Billing
DocumentationAbout BillingAPI DocumentationFunds Management APIsDescribeAccountBalance
DescribeAccountBalance
Download PDF
Last updated: 2024-11-27 17:30:30
DescribeAccountBalance
Last updated: 2024-11-27 17:30:30
Download PDF

1. API Description

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

This API is used to check the Tencent Cloud account balance.

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: DescribeAccountBalance.
Version Yes String Common Params. The value used for this API: 2018-07-09.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
Balance Integer Available account balance in cents, which takes the same calculation rules as RealBalance, CreditBalance, and RealCreditBalance.
Uin Integer The UIN to query.
RealBalance Float Available account balance in cents, which takes the same calculation rules as Balance, CreditBalance, and RealCreditBalance.
CashAccountBalance Float Cash account balance in cents. Currently, this field is not applied.
IncomeIntoAccountBalance Float Income account balance in cents. Currently, this field is not applied.
PresentAccountBalance Float Present account balance in cents. Currently, this field is not applied.
FreezeAmount Float Frozen amount in cents.
OweAmount Float Overdue amount in cents, which is when the available credit balance is negative.
IsAllowArrears Boolean Whether overdue payments are allowed. Currently, this field is not applied.
IsCreditLimited Boolean Whether you have a credit limit. Currently, this field is not applied.
CreditAmount Float Credit limit in cents. Credit limit－available credit balance = consumption amount
CreditBalance Float Available credit balance in cents, which takes the same calculation rules as Balance, RealBalance, and RealCreditBalance.
RealCreditBalance Float Available account balance in cents, which takes the same calculation rules as Balance, RealBalance, and CreditBalance.
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 Checking the account balance

Input Example

https://billing.intl.tencentcloudapi.com/?Action=DescribeAccountBalance
&<Common request parameters>

Output Example

{
    "Response": {
        "Uin": "90961",
        "RealBalance": 9647442,
        "CashAccountBalance": 1299806668,
        "IncomeIntoAccountBalance": 0,
        "PresentAccountBalance": 209512,
        "FreezeAmount": 1290368738,
        "OweAmount": 0,
        "RequestId": "1323",
        "IsAllowArrears": true,
        "IsCreditLimited": true,
        "Balance": -6188426,
        "CreditAmount": 200,
        "CreditBalance": -6188226,
        "RealCreditBalance": -6188226
    }
}

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
FailedOperation Operation failed.
FailedOperation.PayPriceError Payment failed. Please contact Tencent Cloud to resolve this issue.
InternalError Internal error.
InternalError.GatewayError Gateway error.
UnauthorizedOperation.CamNoAuth The account does not have CAM permission.
UnsupportedOperation Operation unsupported.
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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon