For the complete documentation index, see llms.txt. This page is also available as Markdown.

Interface: FirmhousePromotion

Properties

Property
Type
Description

__typename

"BillingCyclePromotion" | "OrderDiscountPromotion"

The concrete promotion type.

activated

boolean

Whether the promotion is currently active.

amountCents

number | null

The fixed discount amount in cents.

autoApply

boolean

Whether or not this promotion will automatically be applied on checkout

deactivateAfterAmountIncludingTaxCents

number | null

The amount after which the promotion should get deactivated on a customer

deactivateAfterTimes

number | null

After how many times this promotion is "used up" for a customer

deactivationStrategy

Which mechanism will be used to deactivate the promotion

discountType

PromotionDiscountTypeEnum | null

Whether the promotion applies a fixed amount or a percentage.

id

string

The id of this promotion that can be used to apply the promotion on a subscription

percentDiscount

number | null

The percentage of discount that this promotion gives

publicName

string | null

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

Last updated

Was this helpful?