Setting Customer Budgets

Function

This API is used to set or adjust a customer's budget. If the budget is set for the first time, and the freezing type is not specified for budget exhaustion, manual freezing is applied by default.

Click here to learn about how to query the budget of a customer.

Once a distributor grants the budget setting permission to a reseller, the reseller can set budgets for their own customers.

For details, see Setting Account Freezing and Budget Setting Permissions for Resellers.

Constraints

This API can only be invoked using the AK/SK or token of a cloud solution provider or a Huawei Cloud distributor.

Debugging

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

URI

POST /v2/partners/sub-customers/budget

Request

Request Parameters

Parameter	Mandatory	Type	Maximum Length/Value Range	Description
customer_id	Yes	String	A maximum of 64 characters	Customer account ID. You can call the API in Querying Customers to obtain the customer ID.
budget_amount	Yes	BigDecimal	(0-2147483647]	Target amount, which can be accurate to two decimal places. Unit: USD
cancel_partner_frozen	No	String	-	Whether to unfreeze the account when setting the customer budget. 0: No 1: Yes The default value is 0. If this parameter is not included in the request parameters, is set to "", or is set to null, the default value 0 is used.
indirect_partner_id	No	String	A maximum of 64 characters	Reseller ID. For details about how to obtain the ID, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory if you want to set a budget for a reseller's customer. If this parameter is not included in the request parameters, is set to "", or is set to null, this parameter will not be used.
budget_type	No	String	-	Budget type. MONTHLY: Monthly budget PACKAGE: One-time budget The default value is MONTHLY. If this parameter is not included in the request parameters or is set to null, the default value MONTHLY is used. The value of this parameter cannot be an empty string.
frozen_operate_type	No	Integer		Whether to automatically freeze the budget when the budget is exhausted. 0: Manual freezing 1: Auto freezing NOTE: Monthly budget effective time and disclaimer One-time budget effective time and disclaimer If this parameter is not included in the request, is left empty, or is set to null, this parameter does not take effect.

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/budget HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "customer_id": "053a48736500d5f40ffec01689b88480",
    "budget_amount": 100,
    "cancel_partner_frozen": 0,
    "indirect_partner_id": "0b5e9b********0c0f0fc00874a9e000",
    "budget_type":"MONTHLY",
    "frozen_operate_type": 0
}

Response

Response Parameters

Parameter	Type	Maximum Length	Description
error_code	String	A maximum of 20 characters	Error code. For details, see Returned Values. This parameter is returned only when a failure occurs.
error_msg	String	A maximum of 2,000 characters	Error description. This parameter is returned only when a failure occurs.

Example Response

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

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.50000030	Setting budgets not supported. This reseller's budget quota is insufficient.
400	CBC.50000033	Budget setting permissions have been revoked. This reseller cannot set budgets.
400	CBC.99000000	You do not have the operation permission to this customer.
400	CBC.99000037	You do not have the permission to operate this Huawei Cloud reseller.
400	CBC.99005024	This API cannot be invoked because the association type of the customer is incorrect.
403	CBC.0151	Access denied.
403	CBC.0150	Invalid operation.
500	CBC.0999	Other errors.