Domain name for API request: tokenhub.intl.tencentcloudapi.com.
Query the TokenPlan package details.
Return the package basic info and the remaining quota of the package.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeTokenPlan. |
| Version | Yes | String | Common Params. The value used for this API: 2026-03-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TeamId | Yes | String | Package ID. You can obtain it through the DescribeTokenPlanList API. |
| Parameter Name | Type | Description |
|---|---|---|
| TeamId | String | Package ID |
| Name | String | Package name. |
| AppId | String | Root account APP ID. |
| Uin | String | Main account UIN. |
| Status | String | Status. Valid values: enable, disable. |
| StopReason | String | Disablement reason. Value: NORMAL, ISOLATED, FROZEN, EXHAUSTED, DESTROYED. |
| ApiKeyMax | Integer | Maximum number of API Keys that can be created. |
| PrepayResourceID | String | Cloud billing prepaid resource package ID. |
| Creator | String | Creator. Packages created by a sub-account show the sub-account UIN. |
| CreatedAt | Timestamp ISO8601 | Creation time. |
| UpdatedAt | Timestamp ISO8601 | Update time. |
| PackageInfo | TokenPlanPackageInfo | Basic information of the package. |
| AutoRenewFlag | Integer | Auto-renewal flag. Value: 0 (manual renewal), 1 (auto renewal), 2 (no automatic renewal). It is not returned if not bound to a prepaid resource. |
| ApiKeyCount | Integer | Current number of created API Keys. |
| TokenSummary | TokenSummary | Token usage details in the current cycle |
| ProductType | String | Package type. Values: enterprise (Enterprise Professional package), enterprise-auto (Enterprise Light package) |
| 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. |
Test query for TokenPlan package details
POST / HTTP/1.1
Host: tokenhub.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenPlan
<Common request parameters>
{
"TeamId": "team-1a2b3c4d"
}{
"Response": {
"ApiKeyCount": 10,
"ApiKeyMax": 10000,
"AppId": "12438230",
"AutoRenewFlag": 0,
"CreatedAt": "2026-04-05T21:06:09+08:00",
"Creator": "12438230",
"Name": "my-test-team",
"PrepayResourceID": "",
"RequestId": "45b1f117-4a30-4d5f-a73c-6966d50ab010",
"Status": "enable",
"StopReason": "",
"TeamId": "team-1a2b3c4d",
"Uin": "21239852",
"UpdatedAt": "2026-04-07T23:26:01+08:00"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |
文档反馈