tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpgradePlan

Last updated: 2024-12-03 16:17:54

1. API Description

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

When you need features available only in higher-tier plans, you can upgrade your plan through this interface. Upgrades are only supported for Personal and Basic Edition Plans.

For differences between EdgeOne billing plans, refer to Comparison of EdgeOne Plans.
For EdgeOne plan upgrade rules and pricing details, refer to EdgeOne Plan Upgrade Guide.
If your plan needs to upgrade to the Enterprise Edition, Contact Us.

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: UpgradePlan.
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.
PlanType Yes String Target plan version for upgrade. Valid values:
  • basic: Basic Edition Plan;
  • standard: Standard Edition Plan.
    • AutoUseVoucher No String Whether to automatically use a voucher. Valid values:
  • true: Yes;
  • false: No.
    • If this field is not specified, the default value 'false' will be used.

    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 Upgrading Prepaid Plan to Standard Edition

    Upgrade the prepaid plan edgeone-2unuvzjmmn2q to the Standard Edition without using the voucher.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradePlan
<Common request parameters>

{
    "PlanId": "edgeone-2unuvzjmmn2q",
    "PlanType": "standard",
    "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.

    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.InvalidPlanType The plan type format is incorrect. Enter the correct format.
    InvalidParameter.PlanNotFound The plan doesn’t exist.
    OperationDenied.EnterprisePlanUpgradeUnsupported The Enterprise Edition Plan does not support upgrades.
    OperationDenied.PlanDowngradeNotAllowed A plan downgrade is not supported.
    OperationDenied.PlanHasBeenExpired The plan has expired.
    OperationDenied.PlanHasBeenIsolated The plan has been isolated.
    OperationDenied.ResourceHasBeenLocked Billing resources are in operation. Try again later.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy