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

createPromotion

Creates a promotion.

Arguments

Argument
Description

Parameters for CreatePromotion

CreatePromotionInput Arguments

Argument
Description

publicName (String)

Alternative name to be displayed on invoices and checkout.

publicNameTranslations ([TranslationInput!])

Translations for the promotion public name in different locales

autoApply (Boolean)

Whether or not this promotion will automatically be applied on checkout

Which mechanism will be used to deactivate the promotion

deactivateAfterAmountIncludingTaxCents (Int)

The amount (in cents) after which the promotion should get deactivated on a customer

deactivateAfterTimes (Int)

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

Which type of the discount will be used.

amountCents (Int)

The amount of discount that this promotion gives.

activated (Boolean)

Whether or not this promotion should be active

appliesTo ([PromotionAppliesToEnum!])

The purchases to which this promotion may apply

countryOverrides ([PromotionCountryOverrideInput!])

Country specific setting overrides for this promotion. These will override default promotion settings for specified countries. Add new or update override for existing name/countryCode combination. Note: This feature is currently in beta testing - overrides will only take effect once enabled for your account by Firmhouse.

title (String!)

The title of the promotion as it will appear on invoices and in the portal.

percentDiscount (Int)

The percentage of discount that this promotion gives.

Return fields

errors ([ModelValidationError!]!)

promotion (Promotion)

Last updated

Was this helpful?