tencent cloud

SetRenewal
Last updated:2026-03-26 15:09:37
SetRenewal
Last updated: 2026-03-26 15:09:37

1. API Description

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

Notes:

  1. This API supports setting auto-renewal mode and period for annual and monthly subscription instances.
  2. Obtain the product code and region code through an instance query API.
  3. When using this API, a sub-user must possess the QcloudFinanceRenewManageFullAccess permission policy.

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: SetRenewal.
Version Yes String Common Params. The value used for this API: 2018-07-09.
Region No String Common Params. This parameter is not required.
ProductCode Yes String Product code.
RegionCode Yes String Region code.
InstanceId Yes String Instance ID. Only one can be specified.
RenewFlag Yes String Renewal flag. Enumeration values are as follows:
NOTIFY_AND_MANUAL_RENEW: manual renewal.
NOTIFY_AND_AUTO_RENEW: automatic renewal.
DISABLE_NOTIFY_AND_MANUAL_RENEW: non-renewal upon expiration.
RenewPeriod No String Automatic renewal cycle length. If left empty, the default value set by product is used.
If it is month, support: 1-11
If it is year, support: 1-5.
Supported range mainly depends on the product side.
RenewPeriodUnit No String Automatic renewal cycle unit. If left empty, the default value set by the product is used.
Year y, month m
Supported range mainly depends on the product side.

3. Output Parameters

Parameter Name Type Description
InstanceList Array of OperateRsp Instance list when the operation fails.
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 Example 1

Input Example

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

{
    "ProductCode": "p_cos",
    "RegionCode": "ap-others",
    "InstanceId": "std_storage-20240902185001827926251-1",
    "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
    "RenewPeriod": "3",
    "RenewPeriodUnit": "m"
}

Output Example

{
    "Response": {
        "InstanceList": [],
        "RequestId": "6a5c90f0-10e8-4586-97f7-abafa2e46dcf"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback