Anchor to section titled 'undefined'

DiscountAutomaticFreeShipping
object

Requires Apps must have read_discounts access scope.

An automatic discount that offers customers free shipping on their order.


Whether the discount applies on regular one-time-purchase shipping lines.

Whether the discount applies on subscription shipping lines.

The number of times that the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

Determines which discount classes the discount can combine with.

The date and time when the discount was created.

A shipping destination that qualifies for the discount.

The class of the discount for combining purposes.

The date and time when the discount ends. For open-ended discounts, use null.

Indicates whether there are any timeline comments on the discount.

The maximum shipping price amount accepted to qualify for the discount.

The minimum subtotal or quantity that's required for the discount to be applied.

The number of times a discount applies on recurring purchases (subscriptions).

A short summary of the discount.

The date and time when the discount starts.

The status of the discount.

A detailed summary of the discount.

The title of the discount.

The total sales from orders where the discount was used.

The date and time when the discount was updated.


Was this section helpful?
Map

Possible types in

DiscountAutomaticFreeShipping