The Firmhouse Logo [FH]
Developer Docs
Home
Storefront JS SDK
New
API Reference
Liquid
Examples

OrderDiscountPromotion

Promotion applied to a subscription in an order based project

Fields

activated (Boolean!)
Whether or not this promotion is currently active
autoApply (Boolean!)
Whether or not this promotion will automatically be applied on checkout
deactivateAfterAmountIncludingTaxCents (Int)
The amount after which the promotion should get deactivated on a customer
deactivateAfterTimes (Int)
After how many times this promotion is "used up" for a customer
deactivationStrategy (AppliedPromotionDeactivationStrategy!)
Which mechanism will be used to deactivate the promotion
id (ID!)
The id of this promotion that can be used to apply the promotion on a subscription.
percentDiscount (Int)
The percentage of discount that this promotion gives
publicName (String)
Alternative name to be displayed on invoices and checkout.
title (String!)
The title of the promotion as it will appear on invoices and in the portal.