Help Center > > API Reference> Transaction Management> Managing Yearly/Monthly Resources> Renewing Subscription to Yearly/Monthly Resources

Renewing Subscription to Yearly/Monthly Resources

Updated at: Jan 25, 2022 GMT+08:00

Function

When subscription to yearly/monthly resources of a customer is about to expire, the customer can renew the subscription to the resources.

Customers can follow the instructions described in Manually Renewing a Resource to renew the subscription to the yearly/monthly resources in Billing Center.

  • If a primary resource has resources attached, the system renews the subscription to both the primary resource and its attached ones after this API is invoked. You can invoke Querying Customer's Yearly/Monthly Resources to obtain the details of the attached resources.
  • If a newly purchased EVS disk is attached to an ECS, but this disk is not the attached to any of the ECS primary resources, you must invoke Querying Customer's Yearly/Monthly Resources to obtain the details of the ECS primary resources and its attached ones.
  • This API supports automatic payment. For details about how to use discounts or coupons during payment, see Support for Discounts or Coupons.

Constraints

A customer can renew subscription to yearly/monthly resources on the partner sales platform.

URI

POST /v2/orders/subscriptions/resources/renew

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

resource_ids

Yes

List<String>

A maximum 100 IDs

Resource IDs.

Only the primary resource ID is supported. A maximum of 100 resource IDs can be configured.

To determine the primary resources, query is_main_resource in the response of the API described in Querying Customer's Yearly/Monthly Resources.

period_type

Yes

Integer

2, 3

Period type. The value can be:

  • 2: month
  • 3: year

period_num

Yes

Integer

1 to 11

Number of periods.

  • Month: 1 to 11
  • Year: 1 to 3

expire_policy

Yes

Integer

0 to 3

Expiration policy.

  • 0: Entering a grace or retention period
  • 1: Yearly/monthly to pay-per-use
  • 2: Automatic unsubscription
  • 3: Automatic renewal

is_auto_pay

No

Integer

0, 1

Whether enable automatic payment.

  • 0: No
  • 1: Yes

If this parameter is left empty, default value 0 is used (automatic payment disabled).

Example Request
POST https://bss-intl.myhuaweicloud.com/v2/orders/subscriptions/resources/renew HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "resource_ids": [
        "96308d5efd7841b9a4dac673d84d0e14"
    ],
    "period_type": 2,
    "period_num": 1,
    "expire_policy": 1,
    "is_auto_pay": 0
}

Response

Response Parameters

Status code: 200

Parameter

Type

Description

order_ids

List<String>

List of order IDs generated when resource subscription is renewed.

Status code: 400

Parameter

Type

Description

error_code

String

Status code.

For details, see Returned Values.

error_msg

String

Error description.

order_ids

List<String>

List of order IDs generated when resource subscription is renewed.

expired_resource_ids

List<String>

List of expired or non-existent resources.

This parameter has a value only when the error code is CBC.99003016.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
  "order_ids": [
    "CS19040119281JMYC"
  ]
}

Returned Values

HTTP Value

Error Code

Description

400

CBC.0100

Parameter error.

400

CBC.30010036

Renewal is only supported for primary resources.

400

CBC.30050006

Automatic order payment failed.

400

CBC.99003002

The resource has been locked.

400

CBC.99003004

The resource has dependencies.

400

CBC.99003005

The resource is being provisioned.

400

CBC.99003006

Unsupported cloud service type.

400

CBC.99003100

This operation is not allowed because some resources are included in your orders to be paid.

400

CBC.99003638

Subscription to bandwidth add-on packages cannot be renewed.

400

CBC.7281

You cannot renew or cancel subscription because your account has been frozen.

400

CBC.99003016

The resources have expired and been deleted or do not exist.

400

CBC.99003124

Resources have been unsubscribed from.

400

CBC.99003144

Resources have being unsubscribed from or changed.

400

CBC.99003634

Resources in discount packages must be renewed as a whole and cannot be renewed together with other resources.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel