The input fields for creating or updating an automatic discount
that's managed by an app.
Use these input fields when you need advanced, custom, or
dynamic discount capabilities that aren't supported by
[Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types).
Access Scopes
Fields
appliesOnSubscription:
Boolean -
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.
combinesWith:
DiscountCombinesWithInput -
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).
endsAt:
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`.
functionId:
String -
The
[function ID](https://shopify.dev/docs/apps/build/functions/input-output/metafields-for-input-queries)
associated with the app extension providing the
[discount type](https://help.shopify.com/manual/discounts/discount-types).
metafields:
MetafieldInput -
Additional metafields to associate to the discount.
[Metafields](https://shopify.dev/docs/apps/build/custom-data)
provide dynamic function configuration with
different parameters, such as `percentage` for a percentage discount. Merchants can set metafield values
in the Shopify admin, which makes the discount function more flexible and customizable.
recurringCycleLimit:
Int -
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 -
The date and time when the discount becomes active and is available to customers.
title:
String -
The discount's name that displays to merchants in the Shopify admin and to customers.