Skip to main content

Renew Seats

Renew a seat subscription as a whole.

Prerequisites

You have obtained the AccessKey of an Alibaba Cloud account or a RAM user, and the identity has been granted the RAM permissions required to call BssOpenApi. We recommend that you set the AccessKey as the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET instead of hard-coding it. You have an existing Token Plan team edition seat subscription, and you have obtained ProductCode, ProductType, and SubscriptionType by calling QueryProductList.

Request description

  • HTTP method：POST
  • Request URL

    Region

    Endpoint

    China site

    POST https://business.aliyuncs.com/

  • Authentication This operation belongs to BssOpenApi (version 2023-09-30) and uses AccessKey-based RPC signatures (HMAC-SHA1). The Authorization: Bearer {API_KEY} scheme is not supported. We recommend that you call this operation with the CommonRequest class of an Alibaba Cloud SDK. The SDK generates the common parameters and calculates the signature automatically.

Request parameters

All parameters are passed as form data or in the query string.

Parameter

Type

Required

Description

ProductCode

string

Yes

Product code. Obtain it by calling QueryProductList. Example: sfm.

ProductType

string

Yes

Product type. Obtain it by calling QueryProductList. Example: sfm_tokenplanteams_dp_cn.

SubscriptionType

string

Yes

Subscription type. Obtain it by calling QueryProductList. Example: Subscription.

ClientToken

string

Yes

Idempotency token. Generate it on the client and keep it unique across requests. Maximum length: 64 ASCII characters.

Period

integer

Yes

Renewal period. Minimum value: 1.

PeriodUnit

string

Yes

Unit of the renewal period. Valid values:
Year
Month

AutoRenew

boolean

No

Specifies whether to enable auto-renewal.

Response parameters

Parameter

Type

Description

RequestId

string

Request ID.

Success

boolean

Whether the request was successful.

Code

string

Result code. The value is Success when the request succeeds.

Message

string

Result message.

Data

object

Business data.

Data.OrderId

long

Renewal order ID.

Data.HostId

string

Site identifier. The China site returns cn. This field may be omitted in some responses.

AccessDeniedDetail

string

Detailed error information returned when RAM permissions are denied.

Request example

This operation uses BssOpenApi RPC signatures. In the following example, ${SIGNATURE} must be calculated with the signature algorithm, and SignatureNonce and Timestamp must be replaced with actual values. An Alibaba Cloud SDK handles the common parameters and signature automatically. 
curl -X POST "https://business.aliyuncs.com/" \
    --data-urlencode "Action=RenewCreditSeat" \
    --data-urlencode "Version=2023-09-30" \
    --data-urlencode "Format=JSON" \
    --data-urlencode "AccessKeyId=${ALIBABA_CLOUD_ACCESS_KEY_ID}" \
    --data-urlencode "SignatureMethod=HMAC-SHA1" \
    --data-urlencode "SignatureVersion=1.0" \
    --data-urlencode "SignatureNonce=${SIGNATURE_NONCE}" \
    --data-urlencode "Timestamp=2026-01-01T12:00:00Z" \
    --data-urlencode "Signature=${SIGNATURE}" \
    --data-urlencode "ProductCode=sfm" \
    --data-urlencode "ProductType=sfm_tokenplanteams_dp_cn" \
    --data-urlencode "SubscriptionType=Subscription" \
    --data-urlencode "ClientToken=example-client-token-001" \
    --data-urlencode "Period=1" \
    --data-urlencode "PeriodUnit=Month" \
    --data-urlencode "AutoRenew=false"

Response example 

{
  "RequestId": "request-id-example",
  "Success": true,
  "Code": "Success",
  "Message": "Successful!",
  "Data": {
    "OrderId": 1234567890123459
  }
}

Error codes

If the call fails, an error message is returned. Common error codes for renewal:
  • INSTANCE_HOLDING_LIMIT_EXCEEDED: The number of held instances exceeds the limit.
  • MissingParameter: A required parameter is missing.
  • ResourceNotExists: The specified resource does not exist.
For more error codes and solutions, see BssOpenApi error codes.