Help Center > > API Reference> Transaction Management> Managing Customers' Budgets> Setting Customers' Budgets

Setting Customers' Budgets

Updated at: Jun 17, 2021 GMT+08:00

Function

This API is used to set or adjust a customer's budget.

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

Constraints

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

URI

POST /v2/partners/sub-customers/budget

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

customer_id

Yes

String

Maximum length: 64 characters

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

budget_amount

Yes

BigDecimal

-

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.

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
}

Response

Response Parameters

Parameter

Type

Value Range

Description

error_code

String

Maximum length: 20 characters

Error code. For details, see Returned Values. This parameter is returned only when a failure occurs.

error_msg

String

Maximum length: 2000 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

HTTP Value

Error Code

Description

400

CBC.0100

Parameter error.

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.

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