Help Center/ Partner Center/ API Reference/ Customer Management/ Customer Management/ Freezing a Customer Account

Updated on 2024-07-08 GMT+08:00

View PDF

Freezing a Customer Account

Function

A partner can freeze an account of a customer associated with the partner by reseller model.

Visit Freezing a Customer Account to learn about how to freeze a customer account.

Constraints

This API can be invoked using the partner AK/SK or token only.

URI

POST /v2/partners/sub-customers/freeze

Request

Request Parameters

Parameter	Mandatory	Type	Value Range	Description
customer_ids	Yes	List<String>	A maximum of 10 IDs	IDs of customers whose accounts are to be frozen. You can call the API in Querying Customers to obtain the customer ID.
reason	Yes	String	A maximum of 256 characters	Account freezing reason.
indirect_partner_id	No	String	Maximum length: 64 characters	Reseller ID. For details about how to obtain the ID, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory for freezing the customers of a reseller.

Parameter

Mandatory

Type

Value Range

Description

customer_ids

Yes

List<String>

A maximum of 10 IDs

IDs of customers whose accounts are to be frozen.

You can call the API in Querying Customers to obtain the customer ID.

reason

Yes

String

A maximum of 256 characters

Account freezing reason.

indirect_partner_id

String

Maximum length: 64 characters

Reseller ID. For details about how to obtain the ID, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory for freezing the customers of a reseller.

Example Request

POST https://bss.myhuaweicloud.eu/v2/partners/sub-customers/freeze HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "customer_ids": [
        "0bb8e9********760f6fc010ebfd95e1"
    ],
    "reason": "Arrears",
    "indirect_partner_id": "0b5e9b********0c0f0fc00874a9e000"
    
}

Response

Response Parameters

Parameter	Type	Value Range	Description
error_code	String	A maximum of 20 characters	Error code. This field is not returned when the operation is successful or partially failed. For details, see Returned Values.
error_msg	String	A maximum of 2,000 characters	Error description. This field is not returned when the operation is successful or partially failed.
error_details	List<ErrorDetail>	-	Error cause description. This field is returned only when the operation is partially failed. For details, see Table 1.

Parameter

Type

Value Range

Description

error_code

String

A maximum of 20 characters

Error code. This field is not returned when the operation is successful or partially failed.

For details, see Returned Values.

error_msg

String

A maximum of 2,000 characters

Error description. This field is not returned when the operation is successful or partially failed.

error_details

List<ErrorDetail>

Error cause description. This field is returned only when the operation is partially failed.

For details, see Table 1.

**Table 1** ErrorDetail
Parameter	Type	Value Range	Description
error_code	String	A maximum of 20 characters	Error code. For details, see Returned Values. The returned status code is 200.
error_msg	String	A maximum of 2,000 characters	Error message.
id	String	A maximum of 256 characters	ID. This parameter corresponds to customer_ids.

Example Response

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

Returned Values

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.0100	Parameter error.
400	CBC.99000000	You do not have the operation permission to this customer.
400	CBC.99000035	You are not a customer of a partner yet.
400	CBC.99000037	You do not have the permission to operate this Huawei Cloud reseller.
200	CBC.99005024	This API cannot be invoked because the association type of the customer is incorrect.
403	CBC.0150	Invalid operation.
403	CBC.0151	Access denied.
500	CBC.0999	Other errors.