You are not logged in.
PayOrders
A customer can invoke this API to pay yearly-monthly product orders in the pending payment status.
Customers can follow the instructions described in Payment to pay yearly/monthly product orders in the pending payment status in Billing Center.
NOTE:
- This API supports both monthly settlement and balance payment. Monthly settlement is preferred.
- Balance payment includes cash account payment and credit account payment. If both accounts have balance, the cash account payment is preferred.
- Restrictions for using a discount and coupon at the same time:
- If the restriction attribute of a coupon contains field simultaneousUseWithEmpowerDiscount with a value of 0, the discount and coupon cannot be used at the same time.
- If the restriction attribute of a coupon contains field minConsumeDiscount and the values of discount_ratio for all the order items are less than the value of minConsumeDiscount, the discount and coupon cannot be used at the same time.
This API can be invoked only by the customer AK/SK or token.
Name | Type | IN | Mandatory | Description |
---|---|---|---|---|
X-Auth-Token | string | header | Yes | Call with customer token |
Name | Type | Mandatory | Description |
---|---|---|---|
order_id | string | Yes | Order ID. The value is the same as the order_id value in the response message of invoking the API described in Querying Orders or the order_ids value in the response message of API described in Renewing Subscription to Yearly/Monthly Resources. |
use_coupon | string | Yes | Whether coupons are used for order payment. If this parameter is set to YES, the coupon_infos field is mandatory. If this parameter is set to NO, the value of coupon_infos is ignored.YES: indicates that the coupons are used for payment.NO: indicates that the coupons are not used for payment. |
use_discount | string | Yes | Whether a discount is used for the order payment. If this parameter is set to YES, the discount_infos field is mandatory. If this parameter is set to NO, the value of discount_infos is ignored.YES: indicates that the discount is used for payment.NO: indicates that the discount is not used for payment. |
coupon_infos | Array of CouponSimpleInfoOrderPayV3 objects | No | This parameter is reserved. For details, see Table 1. |
discount_infos | Array of DiscountSimpleInfoV3 objects | No | Discount ID list. For details, see Table 2. |
Name | Type | Mandatory | Description |
---|---|---|---|
id | string | Yes | Coupon ID. |
type | integer | Yes | Discount type. 300: Discount coupon 301: Promotion coupon 302: Promotion flexi-purchase coupon 303: Promotion stored value card |
Name | Type | Mandatory | Description |
---|---|---|---|
id | string | Yes | Discount ID. |
type | integer | Yes | Discount type. 0: promotion discount 1: contract discount2: commercial discount3: discount granted by a partner609: discount for adjusting an order price NOTE: Once the discount 609 (discount for adjusting an order price) is used during order payment, the discount must be used and the discount type cannot be changed. |
Parameter Name: The default value is returned. no content:no content
CBC.0100:Parameter error. CBC.99003141:The cloud service quota or capacity is insufficient, or the resource specifications have changed. CBC.99003155:The enterprise project's fund quota is insufficient, or the project is invalid.
Name | Type | Description |
---|---|---|
quota_infos | Array of QuotaInfoV3 objects | List of the resources whose quota or capacity is insufficient. For details, see Table 3. This parameter is valid only when error_code is set to CBC.99003141. If the quota is insufficient, notify the customer to submit a service ticket on the HUAWEI CLOUD official website to increase the quota and then pay the order.If the capacity is insufficient, notify the customer to place an order again.If the specifications have changed, notify the customer to place an order again. |
enterprise_project_auth_result | Array of EnterpriseProjectv3 objects | Information about the enterprise project whose fund is insufficient. For details, see Table 4. This parameter is valid only when error_code is set to CBC.99003155. |
Name | Type | Description |
---|---|---|
region | string | Cloud service region code, for example, ap-southeast-1. Obtain the value from the Region column in Regions and Endpoints. |
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. |
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. The relationship between ResourceType and CloudServiceType is as follows: A resource type represents a resource contained in the cloud service type, and the cloud service type is a combination of multiple resource types. |
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. |
resource_spec_code | string | Resource specifications of the subscribed cloud service products. For example, the resource specification of a small-scale VM is s2.small.1.linux. |
auth_result | integer | Verification result of the change of the cloud service quota, capacity, or specifications. 1: The quota is insufficient.2: The capacity is insufficient.3: The resource specifications are incorrect. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order.4: The associated resource information is incorrect. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order.99: Other errors. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order. |
available_zone | string | AZ ID. For details, see the AZ names of regions listed on the Regions and Endpoints, for example, cn-north-1a. |
Name | Type | Description |
---|---|---|
enterprise_project_id | string | ID of the enterprise project where an order belongs. 0: ID of a default project null: Non-project ID |
enterprise_project_name | string | Enterprise project name. |
auth_result | integer | Verification result of the change of the cloud service quota, capacity, or specifications. 1: The quota is insufficient.2: The capacity is insufficient.3: The resource specifications are incorrect. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order.4: The associated resource information is incorrect. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order.99: Other errors. This value is valid only when the resource specifications change between the time when a customer places an order and the time when the customer pays the order. |
"POST https://bss-intl.myhuaweicloud.com/v3/orders/customer-orders/pay"
{
"use_coupon": true,
"use_discount": true,
"coupon_infos": [
{
"id": "CP200527025610NGSC",
"type": 301
}
],
"discount_infos": [
{
"id": "PDP2011260815047721TYT48G0BA02EI",
"type": 1
}
],
"order_id": "CS20052715001E4CR"
}