Help Center > > API Reference> Transaction Management> Managing Yearly/Monthly Orders> Querying the Amount of Unsubscription Orders

Querying the Amount of Unsubscription Orders

Updated at: Dec 15, 2021 GMT+08:00

Function

A customer can query the resources and original orders of the unsubscription amount for an unsubscription order or degrade order on the partner sales platform.

  • After you invoke the API in Unsubscribing from Yearly/Monthly Resources to generate an unsubscription order ID, you can invoke this API to query the resources and amount of an unsubscription order. For example, after you invoke the API in Unsubscribing from Yearly/Monthly Resources, you can invoke this API to query the original order ID and original subscription renewal order ID.
  • You can query original order IDs for only unsubscription orders generated after May 2018.

Constraints

This API can be invoked using the AK/SK or token of the partner or of the partner's customer.

URI

GET /v2/orders/customer-orders/refund-orders

Table 1 Query parameters

Parameter

Mandatory

Type

Value Range

Description

order_id

Yes

String

A maximum 64 characters

ID of an unsubscription or degrade order.

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/refund-orders?order_id=CS1904190917GIBHC HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Response

Response Parameters

Parameter

Type

Description

error_code

String

Status code.

For details, see Status Code.

error_msg

String

Error description.

total_count

Integer

Total queries.

refund_infos

List<OrderRefundInfoV2>

Resource list.

For details, see Table 2.

Table 2 OrderRefundInfoV2

Parameter

Type

Description

id

String

Record ID.

amount

BigDecimal

Amount.

  • A negative number indicates the unsubscription amount.
  • A positive amount indicates the consumption amount or the unsubscription handling fee.

measure_id

String

Fee unit.

  • 1: 1 Yuan/Dollar

customer_id

String

Customer account ID.

resource_type_code

String

Resource type code. For example, the VM resource type code of ECS is hws.resource.type.vm. To obtain a specific resource type, call the API in Querying Resource Types.

service_type_code

String

Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs. To obtain a specific service type, call the API in Querying Cloud Service Types.

region_code

String

Cloud service region code, for example, cn-north-1. Obtain the value from the Region column in Regions and Endpoints.

base_order_id

String

ID of the original order corresponding to the unsubscription amount, consumption amount, or unsubscription handling fee.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1,
    "refund_infos": [
        {
            "id": "e9bb1650-0f34-49b8-9628-23d4155abc1c",
            "amount": -1200.0,
            "measure_id": "1",
            "customer_id": "cd1b7080452c410fa2b922baa9b6a408",
            "resource_type_code": "hws.resource.type.volume",
            "service_type_code": "hws.service.type.ebs",
            "region_code": "cn-north-1",
            "base_order_id": "CS20061811411F8CI"
        }
    ]
}

Status Code

HTTP Value

Error Code

Description

400

CBC.99005026

The order is not a degrade or unsubscription order.

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