Updated on 2023-08-04 GMT+08:00

Querying the Amount of Unsubscription Orders

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 customer token replaced by the partner token.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

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

Table 1 Query parameters

Parameter

Mandatory

Type

Value Range

Description

order_id

Yes

String

A maximum of 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 number indicates the handling fee for unsubscription.

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.

service_type_code

String

Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs.

resource_type_name

String

Resource type. For example, the resource type of ECS is Cloud Host.

service_type_name

String

Cloud service type. For example, the cloud service type of ECS is Elastic Cloud Server.

region_code

String

Cloud service region code, for example, ap-southeast-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": "ccefa7ff-****-****-99f5-bb25a2551217",
            "amount": -3,
            "measure_id": "1",
            "customer_id": "075a5d********ffb75c20a82d228130",
            "resource_type_code": "hws.resource.type.volume",
            "service_type_code": "hws.service.type.ebs",
            "resource_type_name": "EVS",
            "service_type_name": "EVS",
            "region_code": "ap-southeast-1",
            "base_order_id": "CS2006******1F8CI"
        }
    ]
}

Status Code

  • 4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
  • 5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

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.