> For the complete documentation index, see [llms.txt](https://developer.firmhouse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.firmhouse.com/graphql-api/api-reference/objects/billing-cycle-promotion.md).

# BillingCyclePromotion

Promotion applied to a subscription in a plan based project

### Fields

#### activated ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean.md)!)

Whether or not this promotion is currently active

#### amountCents ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int.md))

The amount of discount that this promotion gives (fixed amount discounts)

#### appliesTo (\[[PromotionAppliesToEnum](https://developer.firmhouse.com/graphql-api/api-reference/objects/promotion-applies-to-enum.md)!]!)

The purchases to which this promotion may apply.

#### autoApply ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean.md)!)

Whether or not this promotion will automatically be applied on checkout

#### countryOverrides (\[[PromotionCountryOverride](https://developer.firmhouse.com/graphql-api/api-reference/objects/promotion-country-override.md)!]!)

Country-specific overrides for this promotion

#### deactivateAfterAmountIncludingTaxCents ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int.md))

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

#### deactivateAfterTimes ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int.md))

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

#### deactivationStrategy ([AppliedPromotionDeactivationStrategy](https://developer.firmhouse.com/graphql-api/api-reference/objects/applied-promotion-deactivation-strategy.md)!)

Which mechanism will be used to deactivate the promotion

#### discountType ([PromotionDiscountTypeEnum](https://developer.firmhouse.com/graphql-api/api-reference/objects/promotion-discount-type-enum.md))

The type of this discount: fixed or percentage.

#### id ([ID](https://developer.firmhouse.com/graphql-api/api-reference/objects/id.md)!)

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

#### metadata ([JSON](https://developer.firmhouse.com/graphql-api/api-reference/objects/json.md))

Metadata makes it possible to store additional information on objects. Read and merge the existing object before updating it so other keys are preserved.

#### percentDiscount ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int.md))

The percentage of discount that this promotion gives

#### publicName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string.md))

Alternative name to be displayed on invoices and checkout.

#### publicNameTranslations (\[[Translation](https://developer.firmhouse.com/graphql-api/api-reference/objects/translation.md)!]!)

Translations for the promotion public name in the project's enabled locales.

#### requiredPlans (\[[Plan](https://developer.firmhouse.com/graphql-api/api-reference/objects/plan.md)!]!)

Plans that are required for this promotion to be applicable.

#### title ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string.md)!)

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