DiscountCodeApp

The details about the app extension that's providing the discount type. This information includes the app extension's name and client ID, App Bridge configuration, discount class, function ID, and other metadata about the discount type, including the discount type's name and description.

Whether a customer can only use the discount once.

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.

A list codes that customers can use to redeem the discount.

The number of codes that a customer can use to redeem the discount.

The discount classes that you can use in combination with Shopify discount types.

The date and time when the discount was created.

The customers that can use the discount.

The discount class that's used to control how discounts can be combined.

The globally-unique ID for the discount.

The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify null.

The error history for the latest version of the discount type that the app provides.

Whether there are timeline comments associated with the discount.

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.

A list of URLs that the app can use to share the discount.

The date and time when the discount becomes active and is available to customers.

The status of the discount that describes its availability, expiration, or pending activation.

The discount's name that displays to merchants in the Shopify admin and to customers.

The total sales from orders where the discount was used.

The date and time when the discount was updated.

The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify null.

Creates a code discount. The discount type must be provided by an app extension that uses Shopify Functions. Functions can implement order, product, or shipping discount functions. Use this mutation with Shopify Functions when you need custom logic beyond Shopify's native discount types.

For example, use this mutation to create a code discount using an app's "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to our tutorial.

Updates a code discount, where the discount type is provided by an app extension that uses Shopify Functions. Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.