Querying the Price of a Yearly/Monthly Product

Function

Customers can use this API to query prices of yearly/monthly products for new subscriptions on their platforms.

If the tenant who purchases the product enjoys a discount, the discount amount and the final price can be obtained from the query result.

If the customer enjoys multiple discounts, the system returns the rating result for each discount. The system preferentially uses the rating result of the commercial discount if the customer selects automatic payment.

Ensure that you provide the correct service type, region, resource type, region and resource specification. Otherwise, an error may be reported.
You can use the price calculator to determine product prices.
You can also use the price calculator to get the value of the product_infos request parameter when you call the API for querying product prices. For more details, see price inquiry examples.

Constraints

This API can be called using the customer AK/SK or token.

Debugging

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

URI

POST /v2/bills/ratings/period-resources/subscribe-rate

Request

Request Parameters

Parameter	Mandatory	Type	Value Range	Description
project_id	Yes	String	A maximum of 64 characters	Project ID. NOTE: Access the My Credentials page. On the Projects tab, view the project IDs of different regions. To call this API, an IAM member account must be authorized by the IAM master account. For details, see Creating a User Group and Assigning Permissions.
product_infos	Yes	List<PeriodProductInfo>	A maximum of 100 values	Product information list. For details, see Table 1.

**Table 1** PeriodProductInfo
Parameter	Mandatory	Type	Value Range	Description
id	Yes	String	A maximum of 64 characters	The ID is used to identify the mapping between the inquiry result and the request and must be unique in an inquiry.
cloud_service_type	Yes	String	A maximum of 400 characters	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	Yes	String	A maximum of 400 characters	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_spec	Yes	String	A maximum of 400 characters	Resource specifications. For details, see related cloud service documentation. The following provides examples of services and resource specifications: ECS Add .win or .linux to the end of the ECS flavor ID based on the OS type, for example, s2.small.1.linux. Call the API for querying details about flavors and extended flavor information to obtain the flavor IDs. Bandwidth 12_bgp: dynamic BGP bandwidth billed by traffic 12_sbgp: static BGP bandwidth billed by traffic 19_bgp: dynamic BGP bandwidth billed by bandwidth 19_sbgp: Static BGP bandwidth billed by bandwidth 19_share: Shared bandwidth billed by bandwidth IP address: 5_bgp: dynamic BGP public IP address 5_sbgp: static BGP public IP address RDS: You can call the API for querying database specifications to obtain the RDS specifications. DCS: You can call the API for querying service specifications to obtain the DCS specifications. EVS: SATA: Common I/O SAS: High I/O GPSSD: General-purpose SSD SSD: Ultra-high I/O ESSD: Extreme SSD GPSSD2.storage: General-purpose SSD V2 storage
region	Yes	String	A maximum of 64 characters	Cloud service region code, for example, ap-southeast-1. Obtain the value from the Region column in Regions and Endpoints.
period_type	Yes	Integer	[0-4]	Period type of a yearly/monthly product order. 0: Day 2: Month 3: Year 4: Hour
period_num	Yes	Integer	[1-214783647]	Number of periods of a yearly/monthly product order.
subscription_num	Yes	Integer	[1-10000]	Number of subscriptions of a yearly/monthly product order.
available_zone	No	String	A maximum of 64 characters	AZ identifier, for example, cn-north-1a. AZ identifiers are case-insensitive. Obtain the value from the Availability Zone (AZ) column in Regions and Endpoints. If this parameter is not included in the request parameters, is set to "", or is set to null, it cannot be used as a filter criterion.
resource_size	No	Integer	[1-214783647]	Resource capacity. It can be the subscribed volume size or bandwidth size. This parameter is mandatory for a linear product. Linear products are those whose size must be specified during a subscription, such as hard disks and bandwidth. For example, you can select 10 GB or 20 GB during a disk subscription. For non-linear products, if this parameter is not included in the request parameters or is set to null, it cannot be used as a filter criterion.
size_measure_id	No	Integer	-	Resource capacity measurement ID. The options are as follows: 15: Mbit/s (used when the bandwidth is subscribed) 17: GB (used when a cloud disk is subscribed) 14: amount This parameter is mandatory for a linear product. Linear products are those whose size must be specified during a subscription, such as hard disks and bandwidth. For example, you can select 10 GB or 20 GB during a disk subscription. For non-linear products, if this parameter is not included in the request parameters or is set to null, it cannot be used as a filter criterion.

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/bills/ratings/period-resources/subscribe-rate HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "project_id": "84c53ec51e794a4888fb0f5c0cfb2420",
    "product_infos": [
        {
            "id": "1",
	   "cloud_service_type": "hws.service.type.ec2",
	   "resource_type": "hws.resource.type.vm",
           "resource_spec": "s3.medium.4.linux",
	   "region": "ap-southeast-1",
	   "available_zone": "ap-southeast-1a",
	   "resource_size": null,
	   "size_measure_id": null,
	   "period_type": 2,
	   "period_num": 1,
	   "subscription_num": 1
        },
        {
	   "id": "2",
	   "cloud_service_type": "hws.service.type.vpc",
	   "resource_type": "hws.resource.type.ip",
	   "resource_spec": "5_bgp",
	   "region": "ap-southeast-1",
	   "available_zone": null,
	   "resource_size": null,
	   "size_measure_id": 15,
	   "period_type": 2,
	   "period_num": 1,
	   "subscription_num": 1
        },
        {
 	   "id": "3",
	   "cloud_service_type": "hws.service.type.ebs",
	   "resource_type": "hws.resource.type.volume",
	   "resource_spec": "GPSSD",
	   "region": "ap-southeast-1",
	   "available_zone": "ap-southeast-1a",
	   "resource_size": 40,
	   "size_measure_id": 17,
	   "period_type": 2,
	   "period_num": 1,
	   "subscription_num": 1
         },
         {
           "id": "4",
	   "cloud_service_type": "hws.service.type.vpc",
	   "resource_type": "hws.resource.type.bandwidth",
	   "resource_spec": "19_bgp",
	   "region": "ap-southeast-1",
	   "available_zone":"ap-southeast-1a",
	   "resource_size": 40,
	   "size_measure_id": 15,
	   "period_type": 2, 
	   "period_num": 1,
	   "subscription_num": 1
         }
    ]
}

Response

Response Parameters

Parameter	Type	Value Range	Description
error_code	String	A maximum of 20 characters	Status code. For details, see Returned Values. This parameter is returned only when the query failed.
error_msg	String	A maximum of 1000 characters	Error description. This parameter is returned only when the query failed.
official_website_rating_result	List<OfficialWebsiteRatingResult Object>	-	The result for querying the list price of a yearly/monthly product. For details, see Table 2.
optional_discount_rating_results	List<OptionalDiscountRatingResult>	-	Rating results by discount if optional discounts exist. Each optional discount has a rating result. For details, see Table 4. NOTE: If the user does not have the required permission, no information is returned. For details, see API Access Permission (Customer).
currency	String	A maximum of 20 characters	Currency. USD If the parameter is left blank, USD is used.

**Table 2** OfficialWebsiteRatingResult
Parameter	Type	Value Range	Description
official_website_amount	BigDecimal	-	Price of a yearly/monthly product on the official website.
measure_id	Integer	A maximum of 4 characters	Measurement unit ID. 1: USD
product_rating_results	List<PeriodProductOfficialRatingResult>	-	Price query result. For details, see Table 3.

**Table 3** Price query result.
Parameter	Type	Value Range	Description
id	String	A maximum of 64 characters	ID, which comes from the ID in the request.
product_id	String	A maximum of 64 characters	Yearly/monthly product ID.
official_website_amount	BigDecimal	-	Price of a yearly/monthly product on the official website.
measure_id	Integer	A maximum of 4 characters	Measurement unit ID. 1: USD

**Table 4** OptionalDiscountRatingResult
Parameter	Type	Value Range	Description
discount_id	String	A maximum of 64 characters	Discount ID.
amount	BigDecimal	-	Final price after the discount. Amount= official_website_amount - discountAmount
official_website_amount	BigDecimal	-	Price of a yearly/monthly product on the official website.
discount_amount	BigDecimal	-	Amount of an available discount, such as commercial discounts, partner discounts, promotion discounts, and coupons.
measure_id	Integer	A maximum of 4 characters	Measurement unit ID. 1: USD
discount_type	Integer	A maximum of 32 characters	Discount type. Commercial discounts: 605: Contract commercial discount in the HUAWEI CLOUD BE scenario 606: Contract commercial discount in the reseller BE scenario Partner discounts: 607: Partner authorized discount
discount_name	String	A maximum of 256 characters	Discount name.
best_offer	Integer	-	Optimal discount. 0: No (default value) 1: Yes Optimal discount: The system selects a discount from the commercial discount and partner discount. The discount with the maximum discount amount is the optimal discount. If the discount amounts are the same, the system uses the commercial discount first. The promotional discount and coupon are not in the calculation of the optimal discount.
product_rating_results	List<PeriodProductRatingResult>	-	Product price query result. For details, see Table 5.

**Table 5** PeriodProductRatingResult
Parameter	Type	Value Range	Description
id	String	A maximum of 64 characters	ID, which comes from the ID in the request.
product_id	String	A maximum of 64 characters	Yearly/monthly product ID.
amount	BigDecimal	-	Final price after the discount. Amount= official_website_amount - discountAmount
official_website_amount	BigDecimal	-	Price of a yearly/monthly product on the official website.
discount_amount	BigDecimal	-	Amount of an available discount, such as commercial discounts, partner discounts, promotion discounts, and coupons.
measure_id	Integer	A maximum of 4 characters	Measurement unit ID. 1: USD

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "official_website_rating_result": {
        "official_website_amount": 623.78,
        "installment_official_website_amount": null,
        "installment_period_type": null,
        "measure_id": 1,
        "product_rating_results": [
            {
                "id": "1",
                "product_id": "00301-18008-0--0",
                "official_website_amount": 27.2,
                "measure_id": 1,
                "installment_official_website_amount": null,
                "installment_period_type": null
            },
            {
                "id": "2",
                "product_id": "00301-03001-0--0",
                "official_website_amount": 0,
                "measure_id": 1,
                "installment_official_website_amount": null,
                "installment_period_type": null
            },
            {
                "id": "3",
                "product_id": "00301-170006-0--0",
                "official_website_amount": 5.28,
                "measure_id": 1,
                "installment_official_website_amount": null,
                "installment_period_type": null
            },
            {
                "id": "4",
                "product_id": "00301-34543-0--0",
                "official_website_amount": 591.3,
                "measure_id": 1,
                "installment_official_website_amount": null,
                "installment_period_type": null
            }
        ]
    },
    "optional_discount_rating_results": [],
    "currency": "USD"
}

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.99006006	Product not found.
400	CBC.99006055	The queried amount exceeds the upper limit.
403	CBC.0151	Access denied.
429	CBC.0250	Connection request control triggered.
500	CBC.0999	Other errors.