All Products
Search
Document Center

Tair (Redis® OSS-Compatible):TransformInstanceChargeType

Last Updated:Mar 30, 2026

Changes the billing method for a Tair instance between subscription and pay-as-you-go.

Operation description

Before you call this operation, ensure you understand the billing implications and usage notes. For more information, see:

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:TransformInstanceChargeType

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID. You can call the DescribeInstances operation to query instance IDs.

r-bp1zxszhcgatnx****

Period

integer

No

The subscription duration, in months. Valid values: 1 to 9, 12, 24, and 36.

Note

This parameter is available and required only when the ChargeType parameter is set to PrePaid.

1

AutoPay

boolean

No

Specifies whether to enable automatic payment. Valid values:

  • true: Automatic payment. This is the default value.

  • false: Manual payment. In the console, choose Billing Management > Renewal Management in the top navigation bar. In the navigation pane on the left, click Or**rs > My Or**rs to find and pay for the or*er.

true

ChargeType

string

Yes

The target billing method. Valid values:

  • PrePaid: subscription. If you set this parameter to this value, you must also specify the Period parameter.

  • PostPaid: pay-as-you-go.

PrePaid

AutoRenew

string

No

Specifies whether to enable auto-renewal for the instance. Valid values:

  • true: Auto-renewal is enabled.

  • false (default): Auto-renewal is disabled.

Valid values:

  • false :

  • true :

false

AutoRenewPeriod

integer

No

The auto-renewal period, in months. Valid values: 1, 2, 3, 6, and 12.

Note

This parameter is required when the AutoRenew parameter is set to true.

1

CouponNo

string

No

The coupon ID.

Response elements

Element

Type

Description

Example

object

The response parameters.

EndTime

string

The expiration time of the instance.

Note

This parameter is returned only when you change the billing method of an instance from pay-as-you-go to subscription.

2021-05-13T00:00:00Z

RequestId

string

The request ID.

82C791FB-8979-489E-853D-706D7743****

OrderId

string

The order ID.

20881824000****

Examples

Success response

JSON format

{
  "EndTime": "2021-05-13T00:00:00Z",
  "RequestId": "82C791FB-8979-489E-853D-706D7743****",
  "OrderId": "20881824000****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter Period is mandatory for this action.
400 InvalidParam Period is invalid
400 ResourceNotAvailable Resource you requested is not available for finance user.
400 InsufficientBalance Your account does not have enough balance.
400 Order.LatestOrderIsHanding Latest order is handing, please retry later.
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.