Requires access scope.
Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.
We recommend using the types and queries detailed at Getting started with discounts instead. These will replace the GraphQL object and REST Admin and resources.
Fields and connections
The maximum number of times that the price rule can be allocated onto an order.
The method by which the price rule's value is allocated to its entitled items.
The application that created the price rule.
Determines which discount classes the discount can combine with.
The date and time when the price rule was created.
The customers that can use this price rule.
The class of the discount for combining purposes.
List of the price rule's discount codes.
How many discount codes associated with the price rule.
The date and time when the price rule ends. For open-ended price rules, use
null.The paginated list of events associated with the price rule.
A list of the price rule's features.
Indicates whether there are any timeline comments on the price rule.
A globally-unique ID.
The items to which the price rule applies.
The items required for the price rule to be applicable.
The ID of the corresponding resource in the REST Admin API.
Whether the price rule can be applied only once per customer.
The number of the entitled items must fall within this range for the price rule to be applicable.
The shipping cost must fall within this range for the price rule to be applicable.
The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
URLs that can be used to share the discount.
The shipping lines to which the price rule applies.
The date and time when the price rule starts.
The status of the price rule.
A detailed summary of the price rule.
The type of lines (line_item or shipping_line) to which the price rule applies.
The title of the price rule.
The total sales from orders where the price rule was used.
The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.
The maximum number of times that the price rule can be used in total.
A time period during which a price rule is applicable.
The value of the price rule.