Discount
The input fields for creating or updating an amount off discount that's automatically applied on a cart and at checkout.
Anchor to FieldsFields
- Anchor to combinesWithcombines•Discount
With Combines With Input The discount class that you can use in combination with Shopify discount types.
- Anchor to contextcontext•Discount
Context Input The context defining which buyers can use the discount. You can target specific customer IDs, customer segments, or make the discount available to all buyers. Discounts automatically apply on Point of Sale (POS) for Pro locations when the context is not set to ALL.
- Anchor to customerGetscustomer•Discount
Gets Customer Gets Input Information about the qualifying items and their discount.
- Anchor to endsAtends•Date
At Time The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify
null.- Anchor to minimumRequirementminimum•Discount
Requirement Minimum Requirement Input The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•Int
Cycle Limit 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 specify0, then the discount applies indefinitely.- Anchor to startsAtstarts•Date
At Time The date and time when the discount becomes active and is available to customers.
- Anchor to titletitle•String
The discount's name that displays to merchants in the Shopify admin and to customers.