tencent cloud

ModifyInstancesChargeType
Last updated: 2025-10-30 21:38:00
ModifyInstancesChargeType
Last updated: 2025-10-30 21:38:00

1. API Description

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

This API is used to switch the billing mode of an instance.

This API is used to perform operations that do not support instances with no charge when shut down, instances of the model families Batch Compute BC1 and Batch Compute BS1, or instances of scheduled termination.

  • You can query the result of the instance operation by calling the API DescribeInstances. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

A maximum of 10 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: ModifyInstancesChargeType.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceIds.N Yes Array of String One or more instance ids to be operated. you can obtain the instance ID through the InstanceId in the return value from the api DescribeInstances. the maximum number of instances per request is 30.
InstanceChargeType Yes String Modified instance billing type.
  • PREPAID: monthly subscription.

    • Note: Only supports converting pay-as-you-go instances to annual and monthly subscription instances.

    default value: PREPAID
    InstanceChargePrepaid No InstanceChargePrepaid Modified prepaid mode, parameter settings related to monthly/annual subscription. by specifying this parameter, you can specify the purchase duration of annual and monthly subscription instances, whether to enable auto-renewal, and other attributes.
    ModifyPortableDataDisk No Boolean Whether to switch the billing mode of elastic data cloud disks simultaneously. valid values:
  • true: means switching the billing mode of elastic data cloud disks
  • false: means not switching the billing mode of elastic data cloud disks
    • default value: false.

    3. Output Parameters

    Parameter Name Type Description
    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 Switching Instance Billing Mode to Hourly Postpaid in This Example

    This example shows you how to switch the billing mode of an instance.

    Input Example

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

{
    "InstanceChargeType": "POSTPAID_BY_HOUR",
    "InstanceIds": [
        "ins-r8hr2upy"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
    }
}

    Example2 This Example Switches Instance Billing Mode to Prepaid Mode with a Duration of 1 Month

    This example shows you how to switch the billing mode of an instance.

    Input Example

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

{
    "InstanceChargeType": "PREPAID",
    "InstanceIds": [
        "ins-r8hr2upy"
    ],
    "InstanceChargePrepaid": {
        "Period": "1"
    }
}

    Output Example

    {
    "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
    }
}

    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
    AccountQualificationRestrictions Your account failed the qualification verification.
    FailedOperation.InvalidInstanceApplicationRoleEmr The EMR instance ins-xxxxxxxx does not support this operation.
    FailedOperation.PromotionalPerioRestriction The configuration or billing mode of the CVM instances purchased during the promotion period cannot be modified.
    InternalError.TradeUnknownError Internal error.
    InternalServerError Internal error.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidAccount.UnpaidOrder The account has unpaid orders.
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameter A parameter error occurred.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.InvalidInstanceTypeUnderwrite The specified instance type does not support exclusive sales payment mode.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    InvalidPeriod Invalid period. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]; unit: month.
    InvalidPermission This operation is not supported for the account.
    LimitExceeded.InstanceQuota You are short of the instance quota.
    LimitExceeded.InstanceTypeBandwidth Unable to adjust: the target instance type does not support the configured public network bandwidth cap. See Public Network Bandwidth Cap.
    MissingParameter Missing parameter.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    ResourceInsufficient.CloudDiskUnavailable The parameters of cloud disk do not meet the specification.
    UnsupportedOperation.CommercialImageChangeChargeType Commercial image instance use cannot be adjusted for payment mode.
    UnsupportedOperation.InstanceChargeType This instance billing mode does not support the operation.
    UnsupportedOperation.InstanceMixedZoneType Central AZ and edge zone instances cannot be mixed in batch operation.
    UnsupportedOperation.InstanceStateBanning This CVM is blocked. Please submit a ticket.
    UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
    UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
    UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
    UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
    UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
    UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
    UnsupportedOperation.RedHatInstanceUnsupported The operating system of the instance is RedHat, so this operation is not supported.
    UnsupportedOperation.UnderwriteDiscountGreaterThanPrepaidDiscount Monthly subscription to subcontracted exclusive sale does not support exclusive sales discount higher than existing annual/monthly subscription discount.
    UnsupportedOperation.UnderwritingInstanceTypeOnlySupportAutoRenew For an underwriting instance, RenewFlag can only be set to NOTIFY_AND_AUTO_RENEW.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback