RenewPlan
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
When your plan needs to be extended, you can use this interface to renew it. Plan renewal is only supported for the Personal, Basic, and Standard Editions.
For cost details, refer to Plan Fees.
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 Params. The value used for this API: RenewPlan. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| PlanId | Yes | String | Plan ID, formatted as edgeone-2unuvzjmmn2q. |
| Period | Yes | Integer | Renewal plan duration, unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. |
| AutoUseVoucher | No | String | Whether to automatically use a voucher. Valid values: |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DealName | String | Order number. |
| 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 Renewing Plan for Three Months
The plan edgeone-2unuvzjmmn2q is renewed for three months and the voucher will not be automatically used.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewPlan
<Common request parameters>
{
"PlanId": "edgeone-2unuvzjmmn2q",
"Period": 3,
"AutoUseVoucher": "false"
}
Output Example
{
"Response": {
"DealName": "20240312347001004723731",
"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"
}
}
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 |
|---|---|
| FailedOperation.InsufficientAccountBalance | The account balance is insufficient. |
| InvalidParameter.InvalidAutoUseVoucher | The format of automatically used vouchers is incorrect. Enter the correct format. |
| InvalidParameter.InvalidPeriod | The plan cycle format is incorrect. Enter the correct format. |
| InvalidParameter.PlanNotFound | The plan doesn’t exist. |
| OperationDenied.EnterprisePlanRenewUnsupported | The Enterprise Edition Plan does not support renewal. |
| OperationDenied.ResourceHasBeenLocked | Billing resources are in operation. Try again later. |