CreatePlan
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
If you need to use the EdgeOne product, you must create a billing plan through this interface.
After creating a plan, you need to complete the process of creating a site and binding the plan through CreateZone, so that the EdgeOne can provide services properly.
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: CreatePlan. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| PlanType | Yes | String | Type of the subscribed plan. Valid values: For an overview of billing, see EdgeOne Billing Overview. For differences between plans, refer to EdgeOne Billing Plan Comparison. |
| AutoUseVoucher | No | String | Whether to automatically use a voucher. Valid values: If this field is not specified, the default value 'false' will be used. |
| PrepaidPlanParam | No | PrepaidPlanParam | Parameters for subscribing to a prepaid plan. When PlanType is personal, basic, or standard, this parameter is optional and can be used to specify the subscription duration of the plan and enable auto-renewal. If this field is not specified, the default plan duration is 1 month, with auto-renewal disabled. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| PlanId | String | Plan ID, formatted as edgeone-2unuvzjmmn2q. |
| 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 Creating Personal Edition Billing Plan
Create a Personal Edition Billing Plan, with a duration of 1 month, and set it not to auto-renew.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan
<Common request parameters>
{
"PlanType": "personal",
"PrepaidPlanParam": {
"Period": 1,
"RenewFlag": "off"
},
"AutoUseVoucher": "false"
}
Output Example
{
"Response": {
"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461",
"PlanId": "edgeone-2unuvzjmmn2q",
"DealName": "20240312347001004723731"
}
}
Example2 Creating Enterprise Edition Plan
Create an Enterprise Edition Plan.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan
<Common request parameters>
{
"PlanType": "enterprise"
}
Output Example
{
"Response": {
"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461",
"PlanId": "edgeone-2unuvzjmmn2q",
"DealName": "20240312347001004723731"
}
}
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.InvalidPlanType | The plan type format is incorrect. Enter the correct format. |
| InvalidParameter.InvalidRenewFlag | The auto-renewal flag format is incorrect. Enter the correct format. |
| OperationDenied.PleaseContactBusinessPersonnel | To create an Enterprise Edition Plan, contact the business personnel. |