DiscountCodeBasicInput
The input fields for creating or updating an amount off discount that's applied on a cart and at checkout when a customer enters a code. Amount off discounts can be a percentage off or a fixed amount off.
Anchor to FieldsFields
- Anchor to appliesOncePerCustomerapplies•
Once Per Customer Whether a customer can only use the discount once.
- Anchor to codecode•
The code that customers use to apply the discount.
- Anchor to combinesWithcombines•
With The discount class that you can use in combination with Shopify discount types.
- Anchor to customerGetscustomer•
Gets The items in the order that qualify for the discount, their quantities, and the total value of the discount.
- Anchor to customerSelectioncustomer•
Selection The customers that can use the discount.
- Anchor to endsAtends•
At 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•
Requirement The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•
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•
At The date and time when the discount becomes active and is available to customers.
- Anchor to titletitle•
The discount's name that displays to merchants in the Shopify admin and to customers.
- Anchor to usageLimitusage•
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null
.