GetSubscriptionPrice-阿里云帮助中心

This operation queries the price of a subscription product.

Operation description

Call QueryProductList to get the product code. For more information, see Query product information.
Call DescribePricingModule to get the configuration parameters for the product. For more information, see Query product module information.
Call this operation with the retrieved configuration parameters to query the price of the subscription product.
Use the configuration returned by DescribePricingModule to build the Config parameter within ModuleList. You must include all values; otherwise, the price query will fail.

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 Resources

*

bssapi:ProductCode
bssapi:ProductType

None

Request parameters

Parameter	Type	Required	Description	Example
ServicePeriodUnit	string	No	The unit of the subscription duration. Valid values: Year Month	Year
SubscriptionType	string	Yes	The subscription type. The value is fixed as `Subscription`.	Subscription
ProductCode	string	Yes	The product code.	ecs
OrderType	string	Yes	The order type. Valid values: `NewOrder`: a new purchase. `Renewal`: a renewal. `Upgrade`: an upgrade.	NewOrder
ServicePeriodQuantity	integer	No	The subscription duration.	1
ProductType	string	No	The product type. Whether this parameter is required depends on the pricing documentation of the specific product.	ecs
Region	string	No	The region ID.	cn-hangzhou
InstanceId	string	No	The instance ID for which you want to query the price. This parameter is required for upgrades (when `OrderType` is set to `Upgrade`) to obtain the pre-upgrade configuration of the instance.	i-khkjhxxxxxxxxx
Quantity	integer	No	The quantity.	1
ModuleList	array<object>	Yes	The list of pricing modules.
	object	No
ModuleStatus	integer	No	This parameter is required only when `OrderType` is set to `Upgrade`. It specifies the change status of the pricing module. Valid values: 1: Added. 2: Changed. If the configuration of a pricing module changes in an upgrade scenario, you must explicitly set this parameter to this value. Default value: 1.	1
ModuleCode	string	Yes	The pricing module code.	PackageCode
Tag	string	No	This parameter is required only for upgrades or downgrades of some products. It specifies the identifier of a specific resource. For example, if you change disk specifications, you can use this parameter to specify the disk ID.	213213123
Config	string	Yes	The configuration of the pricing module. n is an integer from 1 to 50. The value must be in the "AA:aa,BB:bb" format. In this format, `AA` and `BB` are property identifiers of the pricing module, and `aa` and `bb` are their corresponding property values.	PackageCode:version_1

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	InvalidConfigCod
Message	string	The error message.	Successful
RequestId	string	The request ID.	30E7066E-AE6F-4E59-AFE6-11386CE3AFA7
Success	boolean	Indicates whether the request was successful.	true
Data	object	The subscription price details.
OriginalPrice	number	The original price.	900
DiscountPrice	number	The discount amount.	100
Currency	string	The currency. Valid values: CNY: Chinese Yuan. USD: US Dollar. JPY: Japanese Yen.	CNY
Quantity	integer	The quantity.	1
TradePrice	number	The discounted price.	0
ModuleDetails	object
ModuleDetail	array<object>	A list of price details for each pricing module.
	object
CostAfterDiscount	number	The discounted price of the module.	0
InvoiceDiscount	number	The discount amount for the module.	100
UnitPrice	number	The unit price. This field is deprecated.	0
OriginalCost	number	The original price of the module.	200
ModuleCode	string	The pricing module code.	PackageCode
PromotionDetails	object
PromotionDetail	array<object>	A list of details for each applied promotion.
	object
PromotionDesc	string	The promotion description.	test
PromotionId	integer	The promotion ID.	1021199213
PromotionName	string	The promotion name.	test

Examples

Success response

JSON format

{
  "Code": "InvalidConfigCod",
  "Message": "Successful",
  "RequestId": "30E7066E-AE6F-4E59-AFE6-11386CE3AFA7",
  "Success": true,
  "Data": {
    "OriginalPrice": 900,
    "DiscountPrice": 100,
    "Currency": "CNY",
    "Quantity": 1,
    "TradePrice": 0,
    "ModuleDetails": {
      "ModuleDetail": [
        {
          "CostAfterDiscount": 0,
          "InvoiceDiscount": 100,
          "UnitPrice": 0,
          "OriginalCost": 200,
          "ModuleCode": "PackageCode"
        }
      ]
    },
    "PromotionDetails": {
      "PromotionDetail": [
        {
          "PromotionDesc": "test",
          "PromotionId": 1021199213,
          "PromotionName": "test"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.