Choose a version:

DiscountStatus

enum

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

Anchor to Valid valuesValid values

Anchor to ACTIVEACTIVE: The discount is currently available for use.
Anchor to EXPIREDEXPIRED: The discount has reached its end date and is no longer valid.
Anchor to SCHEDULEDSCHEDULED: The discount is set to become active at a future date.

Was this section helpful?

Anchor to FieldsFields

Anchor to DiscountAutomaticApp.status DiscountAutomaticApp.status •OBJECT: The DiscountAutomaticApp object stores information about automatic discounts that are managed by an app using Shopify Functions. Use DiscountAutomaticAppwhen you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.

Learn more about creating custom discount functionality.

Note
The DiscountCodeApp object has similar functionality to the DiscountAutomaticApp object, with the exception that DiscountCodeApp stores information about discount codes that are managed by an app using Shopify Functions.
Anchor to DiscountAutomaticBasic.status DiscountAutomaticBasic.status •OBJECT: The DiscountAutomaticBasic object lets you manage amount off discounts 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, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountCodeBasic object has similar functionality to the DiscountAutomaticBasic object, but customers need to enter a code to receive a discount.
Anchor to DiscountAutomaticBxgy.status DiscountAutomaticBxgy.status •OBJECT: The DiscountAutomaticBxgy object lets you manage buy X get Y discounts (BXGY) 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, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.
Anchor to DiscountAutomaticFreeShipping.status DiscountAutomaticFreeShipping.status •OBJECT: The DiscountAutomaticFreeShipping object lets you manage free shipping discounts that are automatically applied on a cart and at checkout. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.

The DiscountAutomaticFreeShipping object stores information about automatic free shipping discounts that apply to specific products and variants, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountCodeFreeShipping object has similar functionality to the DiscountAutomaticFreeShipping object, but customers need to enter a code to receive a discount.
Anchor to DiscountCodeApp.status DiscountCodeApp.status •OBJECT: The DiscountCodeApp object stores information about code discounts that are managed by an app using Shopify Functions. Use DiscountCodeApp when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.

Learn more about creating custom discount functionality.

Note
The DiscountAutomaticApp object has similar functionality to the DiscountCodeApp object, with the exception that DiscountAutomaticApp stores information about automatic discounts that are managed by an app using Shopify Functions.
Anchor to DiscountCodeBasic.status DiscountCodeBasic.status •OBJECT: The DiscountCodeBasic object lets you manage amount off discounts that are applied on a cart and at checkout when a customer enters a code. 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 DiscountCodeBasic object stores information about amount off code discounts that apply to specific products and variants, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountAutomaticBasic object has similar functionality to the DiscountCodeBasic object, but discounts are automatically applied, without the need for customers to enter a code.
Anchor to DiscountCodeBxgy.status DiscountCodeBxgy.status •OBJECT: The DiscountCodeBxgy object lets you manage buy X get Y discounts (BXGY) that are applied on a cart and at checkout when a customer enters a code. 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 DiscountCodeBxgy object stores information about BXGY code discounts that apply to specific products and variants, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountAutomaticBxgy object has similar functionality to the DiscountCodeBxgy object, but discounts are automatically applied, without the need for customers to enter a code.
Anchor to DiscountCodeFreeShipping.status DiscountCodeFreeShipping.status •OBJECT: The DiscountCodeFreeShipping object lets you manage free shipping discounts that are applied on a cart and at checkout when a customer enters a code. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.

The DiscountCodeFreeShipping object stores information about free shipping code discounts that apply to specific products and variants, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note
The DiscountAutomaticFreeShipping object has similar functionality to the DiscountCodeFreeShipping object, but discounts are automatically applied, without the need for customers to enter a code.

Was this section helpful?