Anchor to section titled 'undefined'

DiscountCodeFreeShipping
object

Requires Apps must have read_discounts access scope.

A code discount that offers customers free shipping on their order.


Whether the discount can be applied only once per customer.

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.

The number of redeem codes for the discount.

A list of redeem codes for the discount.

Determines which discount classes the discount can combine with.

The date and time when the discount was created.

The customers that can use the discount.

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).

URLs that can be used to share the discount.

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.

The maximum number of times that the discount can be used.


Was this section helpful?
Map

Possible types in

DiscountCodeFreeShipping