\\\ object has similar functionality to the \\\ object, with the exception that \\\ stores information about discount codes that are managed by an app using Shopify Functions.\ \API versions prior to \2025-10\ only return automatic discounts with \context\ set to \all\, discounts with other values are filtered out.
***
* appDiscountType
[AppDiscountType!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppDiscountType)
non-null
The details about the app extension that's providing the [discount type](https://help.shopify.com/manual/discounts/discount-types). This information includes the app extension's name and [client ID](https://shopify.dev/docs/apps/build/authentication-authorization/client-secrets), [App Bridge configuration](https://shopify.dev/docs/api/app-bridge), [discount class](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations), [function ID](https://shopify.dev/docs/apps/build/functions/input-output/metafields-for-input-queries), and other metadata about the discount type, including the discount type's name and description.
* appliesOnOneTimePurchase
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the discount applies on one-time purchases.
* appliesOnSubscription
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the discount applies on subscription items. [Subscriptions](https://shopify.dev/docs/apps/launch/billing/subscription-billing/offer-subscription-discounts) enable customers to purchase products on a recurring basis.
* asyncUsageCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
* combinesWith
[DiscountCombinesWith!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith)
non-null
The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types).
* context
[DiscountContext!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountContext)
non-null
The context defining which buyers can use the discount.
* createdAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was created.
* discountClasses
[\[DiscountClass!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass)
non-null
The classes of the discount.
* discountId
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
non-null
The [globally-unique ID](https://shopify.dev/docs/api/usage/gids) for the discount.
* endsAt
[DateTime](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify `null`.
* errorHistory
[FunctionsErrorHistory](https://shopify.dev/docs/api/admin-graphql/latest/objects/FunctionsErrorHistory)
The [error history](https://shopify.dev/docs/apps/build/functions/monitoring-and-errors) for the latest version of the discount type that the app provides.
* recurringCycleLimit
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to `3`, then the discount only applies to the first three billing cycles of a subscription. If you specify `0`, then the discount applies indefinitely.
* startsAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount becomes active and is available to customers.
* status
[DiscountStatus!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountStatus)
non-null
The status of the discount that describes its availability, expiration, or pending activation.
* title
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
* updatedAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was updated.
* discountClass
[DiscountClass!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass)
non-nullDeprecated
* [DiscountAutomaticBasic](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBasic)
OBJECT
The `DiscountAutomaticBasic` object lets you manage [amount off discounts](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount) that are automatically applied on a cart and at checkout. Amount off discounts give customers a fixed value or a percentage off the products in an order, but don't apply to shipping costs.
The `DiscountAutomaticBasic` object stores information about automatic amount off discounts that apply to specific [products and variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountProducts), [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCollections), or [all items in a cart](https://shopify.dev/docs/api/admin-graphql/latest/objects/AllDiscountItems).
Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including limitations and considerations.
***
**Note:** The \\\\\ object has similar functionality to the \\\ object, but customers need to enter a code to receive a discount.\
API versions prior to \2025-10\ only return automatic discounts with \context\ set to \all\, discounts with other values are filtered out.
***
* asyncUsageCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
* combinesWith
[DiscountCombinesWith!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith)
non-null
The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types).
* context
[DiscountContext!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountContext)
non-null
The context defining which buyers can use the discount.
* createdAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was created.
* customerGets
[DiscountCustomerGets!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerGets)
non-null
The items in the order that qualify for the discount, their quantities, and the total value of the discount.
* discountClasses
[\[DiscountClass!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass)
non-null
The classes of the discount.
* endsAt
[DateTime](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify `null`.
* minimumRequirement
[DiscountMinimumRequirement](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountMinimumRequirement)
The minimum subtotal or quantity of items that are required for the discount to be applied.
* recurringCycleLimit
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to `3`, then the discount only applies to the first three billing cycles of a subscription. If you specify `0`, then the discount applies indefinitely.
* shortSummary
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
An abbreviated version of the discount [`summary`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBasic#field-summary) field.
* startsAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount becomes active and is available to customers.
* status
[DiscountStatus!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountStatus)
non-null
The status of the discount that describes its availability, expiration, or pending activation.
* summary
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.
* title
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
* updatedAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was updated.
* discountClass
[MerchandiseDiscountClass!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MerchandiseDiscountClass)
non-nullDeprecated
* usageCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-nullDeprecated
* [DiscountAutomaticBxgy](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBxgy)
OBJECT
The `DiscountAutomaticBxgy` object lets you manage [buy X get Y discounts (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.
The `DiscountAutomaticBxgy` object stores information about automatic BXGY discounts that apply to specific [products and variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountProducts), [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCollections), or [all items in a cart](https://shopify.dev/docs/api/admin-graphql/latest/objects/AllDiscountItems).
Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including limitations and considerations.
***
**Note:** The \\\\\ object has similar functionality to the \\\ object, but customers need to enter a code to receive a discount.\
API versions prior to \2025-10\ only return automatic discounts with \context\ set to \all\, discounts with other values are filtered out.
***
* asyncUsageCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
* combinesWith
[DiscountCombinesWith!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith)
non-null
The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types).
* context
[DiscountContext!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountContext)
non-null
The context defining which buyers can use the discount.
* createdAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was created.
* customerBuys
[DiscountCustomerBuys!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerBuys)
non-null
The items eligible for the discount and the required quantity of each to receive the discount.
* customerGets
[DiscountCustomerGets!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerGets)
non-null
The items in the order that qualify for the discount, their quantities, and the total value of the discount.
* discountClasses
[\[DiscountClass!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass)
non-null
The classes of the discount.
* endsAt
[DateTime](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify `null`.
* events
[EventConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection)
non-null
The paginated list of events associated with the host subject.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[EventSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/EventSortKeys)
Default:ID
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * action
string
* comments
boolean
* created\_at
time
* id
id
* subject\_type
string
- The action that occured.
- Example:
* `action:create`
Whether or not to include [comment-events](https://shopify.dev/api/admin-graphql/latest/objects/CommentEvent) in your search, passing `false` will exclude comment-events, any other value will include comment-events.
- Example:
* `false`
* `true`
Filter by the date and time when the event occurred. Event data is retained for 1 year.
- Example:
* `created_at:>2025-10-21`
* `created_at:\\\ object has similar functionality to the \\\ object, but customers need to enter a code to receive a discount.\
API versions prior to \2025-10\ only return automatic discounts with \context\ set to \all\, discounts with other values are filtered out.
***
* appliesOnOneTimePurchase
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the discount applies on one-time purchases. A one-time purchase is a transaction where you pay a single time for a product, without any ongoing commitments or recurring charges.
* appliesOnSubscription
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the discount applies on subscription items. [Subscriptions](https://shopify.dev/docs/apps/launch/billing/subscription-billing/offer-subscription-discounts) enable customers to purchase products on a recurring basis.
* asyncUsageCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
* combinesWith
[DiscountCombinesWith!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith)
non-null
The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types).
* context
[DiscountContext!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountContext)
non-null
The context defining which buyers can use the discount.
* createdAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was created.
* destinationSelection
[DiscountShippingDestinationSelection!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountShippingDestinationSelection)
non-null
The countries that qualify for the discount. You can define [a list of countries](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCountries) or specify [all countries](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCountryAll) to be eligible for the discount.
* discountClasses
[\[DiscountClass!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass)
non-null
The classes of the discount.
* endsAt
[DateTime](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify `null`.
* hasTimelineComment
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether there are [timeline comments](https://help.shopify.com/manual/discounts/managing-discount-codes#use-the-discount-timeline) associated with the discount.
* maximumShippingPrice
[MoneyV2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2)
The maximum shipping price amount accepted to qualify for the discount.
* minimumRequirement
[DiscountMinimumRequirement](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountMinimumRequirement)
The minimum subtotal or quantity of items that are required for the discount to be applied.
* recurringCycleLimit
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-null
The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to `3`, then the discount only applies to the first three billing cycles of a subscription. If you specify `0`, then the discount applies indefinitely.
* shortSummary
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
An abbreviated version of the discount [`summary`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticFreeShipping#field-summary) field.
* startsAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount becomes active and is available to customers.
* status
[DiscountStatus!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountStatus)
non-null
The status of the discount that describes its availability, expiration, or pending activation.
* summary
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.
* title
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
* totalSales
[MoneyV2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2)
The total sales from orders where the discount was used.
* updatedAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the discount was updated.
* discountClass
[ShippingDiscountClass!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShippingDiscountClass)
non-nullDeprecated
***
## Examples
* ### automaticDiscount reference