# BundledDiscount

## Program ID

MetraPipeline.MTBDplugin.1

## Description

The Bundled Discount plugin is used to calculate a discount on an amount that is the aggregate of the charges in a particular billing period. Most bundled discounts are based on a tiered (tapered) scheme. For instance, a tiered discount might be 10% if a user spends more than $100 and 15% if the user spends $500.

Note: | The Bundled Discount plug-in does not contain the logic for a particular kind of discount (such as tiered or tapered). The discount ID specifies which discount in the discount collection will be used for processing sessions. The plug-in itself does not calculate the discount; it uses the discount object specified by the discount ID in the discount collection. For more information see the Discount Interface documentation.

## Required Input Properties

Tag name | Value type | Description
DiscountsDirectory | String | This value should always be "discounts" unless you are changing the location of discounts.xml.
discount_filename | String | Should be discounts.xml.
discount_id | Long | The ID of the discount that will be used during ProcessSessions.
tariff_id | Long | The ID of the Tariff for the account we are currently processing.

## Required Output Properties

Tag name | Value type | Description
DiscountOutput | Long | The amount of the discount. Either a positive or negative amount depending on InvertDiscountAmount.
DiscountName | String | The name of the discount. See remarks section.

## Additional Configuration Tags

Tag name | Value type | Description
InvertDiscountAmount | Boolean | If true, the calculated discount will be a negative amount.