This object represents a pricing rule in the API context.
For general information about the pricing rule entity in the CloudBilling context, see Pricing Rules.
A PriceRule has the following properties:
|BillingOutPutTags||List of Strings||A list of tags that are added to the pricing rule results generated by a pricing rule that can be used in transformations.|
|ChargePerUOM||String||The unit of measurement (UOM) for which the price applies. Used for pro-rata calculations|
|CostOperatorValue||Double||The value of the cost operator|
|CostOperatorValueExpression||String||A cost value expression that can use properties of the source item to define the cost applied|
|CustomerClusterId||String||The Id of the Customer Cluster the pricing rule is applied to|
|CustomerClusterTagName||String||The name of the Customer Cluster|
|Id||String||The Id of the pricing rule|
|InvoiceLabelKey||String||The invoice label key is used by the system to identify the correct Invoice Label to be displayed on the invoice.|
|InvoiceOrderIndex||Integer||An integer that is used to determine the relative order of the invoice line items generated by this rule|
|IsFinalResult||Boolean||True or False, determines if the pricing rule result can be overwritten by subsequent rules|
|IsInvoiceRule||Boolean||Determines if the pricing rule result should be displayed on the invoice|
|ItemCondition||String||A conditional expression used to determine whether the price rule should apply to a source item.|
|Operator||String||The operator of the Price Rule|
|OperatorValue||Double||The value of the Price Rule|
|OperatorValueExpression||String||An expression that defines the operator value|
|ProRataPriceUOM||String||The unit of measurement (UOM) that is used to calculate the price pro rata according to the correct period. The UOM can be second, minute, hour, day, month or week|
How the ProRata rounding should be applied to the beginning of the UOM.
Valid options include: none (no rounding), off (round to nearest integer), down (round down) or up (round up)
How the ProRata rounding should be applied to the end of the UOM.
Valid options include: none, off, down or up
|ProductClusterId||String||The Id of the Product Cluster the pricing rule applies to|
|ProductClusterTagName||String||The name of the Product Cluster the Price Rule applies to|
|RuleCondition||String||Similar to item conditions, this condition applies once for a single rule and can use properties of the customer to determine whether or not the rule should be applied.|
|RuleCreated||String||The date the rule was created|
|RuleName||String||The name of the rule|
|RuleOrder||Integer||The order in which the rule is applied when there are multiple rules applied on the same Product Cluster and Customer Cluster combination.|
|SeparateLineItemBillingOutputTags||List of Strings||A list of tags that are added to separate line items that can be used to identify these results.|
|UpdatedDate||String||The most recent date the rule was updated|
|ValidFrom||String||The date from which the rule is valid|
|ValidTo||String||The date after which the rule is no longer valid|