GetPayAsYouGoPrice - Expenses and Costs - Alibaba Cloud Documentation Center

Queries the prices of pay-as-you-go products.

Operation description

API description

Call the QueryProductList operation to obtain the product code. For more information, see Query product information.
Call the DescribePricingModule operation to obtain the configuration parameters of the product. For more information, see Query product module information.
Call this operation with the obtained configuration parameters to query the prices of pay-as-you-go products.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribePrice

get

*All Resource

*

bssapi:ProductCode

bssapi:ProductType

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The product code.	ecs
ProductType	string	No	The product type.	ecs
SubscriptionType	string	Yes	The subscription type. Valid value: PayAsYouGo.	PayAsYouGo
Region	string	No	The ID of the region where the instance resides.	cn-hangzhou
ModuleList	array<object>	Yes	The list of pricing modules.
	object	No	A pricing module.
ModuleCode	string	Yes	The code of the Nth pricing module. Note Obtain the module code by calling the DescribePricingModule operation.	InstanceType
PriceType	string	Yes	The price type of the Nth pricing module. Valid values: Hour: hourly price. Usage: usage. Month: monthly price. Year: yearly price. Note Obtain the price type by calling the DescribePricingModule operation.	Hour
Config	string	Yes	The configuration of the Nth pricing module. The value of N can be an integer from 1 to 50. The configuration is in the "AA:aa,BB:bb" format. In this format, AA and BB are the property codes of the pricing module, and aa and bb are the property values. Note Obtain the configuration by calling the DescribePricingModule operation.	InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux

Response elements

Parameter	Type	Description	Example
	object	The response.
Code	string	The status code.	Success
Message	string	The error message.	Successful
RequestId	string	The request ID.	1537A007-72D7-4165-8A26-8694A38E219A
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
Currency	string	The currency. Valid values: CNY: Chinese Yuan USD: US Dollar JPY: Japanese Yen	CNY
ModuleDetails	object
ModuleDetail	array<object>	The price details of the pricing module.
	object	The price details of the pricing module.
CostAfterDiscount	number	The discounted price.	100
InvoiceDiscount	number	The discount.	20
UnitPrice	number	The unit price.	0
OriginalCost	number	The original price.	1.77
ModuleCode	string	The code of the pricing module.	InstanceType
PromotionDetails	object
PromotionDetail	array<object>	The discount details.
	object	The discount details.
PromotionDesc	string	The description of the discount.	This discount allows you to use a service at the minimum price and is provided for testing purposes only.
PromotionId	integer	The ID of the discount.	10200210
PromotionName	string	The name of the discount.	This discount allows you to use a service at the minimum price and is provided for testing purposes only.

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "1537A007-72D7-4165-8A26-8694A38E219A",
  "Success": true,
  "Data": {
    "Currency": "CNY",
    "ModuleDetails": {
      "ModuleDetail": [
        {
          "CostAfterDiscount": 100,
          "InvoiceDiscount": 20,
          "UnitPrice": 0,
          "OriginalCost": 1.77,
          "ModuleCode": "InstanceType"
        }
      ]
    },
    "PromotionDetails": {
      "PromotionDetail": [
        {
          "PromotionDesc": "This discount allows you to use a service at the minimum price and is provided for testing purposes only.\n",
          "PromotionId": 10200210,
          "PromotionName": "This discount allows you to use a service at the minimum price and is provided for testing purposes only.\n"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.