CreateLicenseOrder

最后更新时间：2024-08-27 11:38:37

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to create Professional/Flagship edition orders
.This API is used to support creating orders through prepaid and pay-as-you-go.
This API is used to directly create postpaid orders.
This API is used to call the billing payment API for payment since prepaid orders are only placed but not paid.

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: CreateLicenseOrder.
Version	Yes	String	Common Params. The value used for this API: 2018-02-28.
Region	No	String	Common Params. This parameter is not required.
Tags.N	No	Array of Tags	Tag array. Leaving it blank indicates no tags need to be bound.
LicenseType	No	Integer	Authorization type. 0: Pro Edition-pay-as-you-go; 1: Pro Edition-monthly subscription; 2 - Ultimate Edition-monthly subscriptionThe default is 0.
LicenseNum	No	Integer	Authorization quantity: the number of units that need to be purchased The default is 1.
RegionId	No	Integer	Region of purchase order. In this case, only 1 - Guangzhou and 9 - Singapore are supported. Guangzhou is recommended. Singapore region is reserved for allowlisted users. The default is 1.
ProjectId	No	Integer	Project ID The default is 0.
TimeSpan	No	Integer	Purchase duration, with a default value of 1. The optional values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36 This parameter is only valid for monthly subscription.
AutoRenewFlag	No	Boolean	Whether to auto-renew. The default is not to auto-renew. This parameter is only valid for monthly subscription.
AutoProtectOpenConfig	No	String	This field is deprecated.
ModifyConfig	No	OrderModifyObject	Reconfiguration Parameters

3. Output Parameters

Parameter Name	Type	Description
DealNames	Array of String	Order ID list
ResourceIds	Array of String	Resource ID list. This field needs to be left blank for prepaid orders.
BigDealId	String	Large order ID. This field needs to be left blank for postpaid orders.
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

Input Example

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

{}

Output Example

{
    "Response": {
        "DealNames": [
            "Order number xxxx"
        ],
        "RequestId": "1bb6cbfb-572d-4f29-b6e0-017acd8659f0",
        "ResourceIds": [
            "Resource ID"
        ],
        "BigDealId": "Large order number xxx"
    }
}

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

Tencent Cloud CLI 3.0

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	Operation failed.
InternalError	Internal error
InvalidParameter	Incorrect parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter error.
OperationDenied	The operation was denied.
ResourceNotFound	The resource does not exist.

tencent cloud

Recent Pages