Price Component Properties

Charges, grants, discounts, refunds, and forfeitures have a set of generic properties common to all price components and additional properties specific to the process that triggers them to be applied (such as recurring cycles, first use of a balance, or service usage).

Generic Price Component Properties

All price components have a name, description, and start date property, rate tables, system attributes, and a list of parameters attached to the price component. Generic Price Component Properties describes the generic price component properties.

Table 1. Generic Price Component Properties
Property	Description
Name	A descriptive name of the price component. Price component names are displayed in My MATRIXX.
Description	Information about the purpose of the price component.
External ID	(Optional) Use this field to identify this item in MATRIXX pricing items. An External ID is saved to the pricing configuration file and loaded into the Pricing Database. Set the External ID value to any alphanumeric character that is meaningful to your implementation. An External ID can be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It can be used, for example, by the Subscriber Management API to query and purchase product offers and bundle IDs.
Start Date/Time	The date and time that the price component is available in the system. You must provide a start date for the first version of a price component that exists in a pricing plan. Revisions to the price component do not require a start date. You can use a future start date to create a revisions to a price component that become active at the specified time without having to redeploy the pricing plan for each one. Optionally, enter a time for when the price component becomes active. The default is midnight.
Application	Determines when a component is applied. Applications include the following: auto_renew — The component applies to product offer auto-renew only. balance_threshold — The component applies to balance-threshold based pricing only. cancel — The component applies to product offer cancelation only. Refund and forfeiture pricing components must be this application type. cycle_arrears_recurring — The component applies when charges are received during a bill cycle and charges or discounts are applied at the end of the cycle. purchase — The component applies to catalog item purchases only. purchased_item_activation — The component applies to the activation of a purchased item only. recurring — The component applies to a specific recurring cycle only (such as a balance cycle or billing cycle). resume — The component applies to a product offer resumed in a pre-active state. suspend — The component applies to a product offer suspended in a pre-active state. usage — The component applies to service usage only. For more information about price components and applications, see the discussion about when price components can be applied in MATRIXX Pricing and Rating.
Price Type	The pricing component type.
Rate Tables	One or more rate tables that define the prices for the price component. Click New Rate Table to add a rate table to the price component.
Attributes	The system attributes for the price component. Click Add Attribute allows you to attach a system attribute to the price component.
Parameters	The list of parameters assigned to the price component. Click Add Parameter to add a parameter to the list.

Usage Price Component Properties

All usage price components have an additional quantity selector property. Usage Price Component Properties describes the quantity selector property.

Table 2. Usage Price Component Properties
Property	Description
Service Type	The service type indicates the service type to which the component can be applied.
Quantity Selector	Determines whether the component applies to the usage type during rating. See below for quantity selector values. The quantity selector property is required for usage price components because a network message using the Diameter Credit-Control application can contain multiple service contexts, each of which can be charged for based on a different used quantity. For example, one streaming media company might charge for a video based on its length (Duration) and another streaming media company might charge for a video based on its size (Data). If the quantity type specified for a price component does not match a quantity type received in a network message, it is skipped and the next price component is examined.
Is Secondary Beat Sequence	Defines the usage component as a secondary beat sequence. Any rimary beat components charge in parallel with any secondary beat components.

Recurring Price Component Properties

All recurring price components have an additional cycle property. Recurring Price Component Properties describes the cycle property.

Table 3. Recurring Price Component Properties
Property	Description
Cycle	Defines what triggers the pricing to be applied on a recurring basis. Options are: Balance Cycle — Apply the recurring price component at every balance cycle. Billing Cycle — Apply the recurring price component at every billing cycle. Purchased Item — Apply the recurring price component on a purchased item cycle.

First-Use Price Component Properties

All first-use (non-recurring) price components have an additional Balance property. First-Use Price Component Properties describes the first-usage balance property.

Table 4. First-Use Price Component Properties
Property	Description
Balance	When the balance defined as the first usage balance is first used, it triggers the price component to be applied. A first usage component can be applied to any balance, not just the balance that is defined as the first usage balance. For periodic balances, first usage components are applied every time the balance is first used for a particular period.

Grant Price Component Properties

All grant price components have an additional target property. Grant Price Component Properties describes the target property.

Table 5. Grant Price Component Properties
Property	Description
Target	Specifies the balance to which to apply the grant. Options are: Event Initiator — Apply the grant price component to a balance in the subscriber's wallet. Tier — Apply the grant price component to a balance in a specified group's wallet. Tier Parameter — Apply the selected parameter set up in pricing.
Tier	Used if the Target field is set to Tier. Select the tier containing the group to apply the grant to. For information about creating tiers, see the discussion about adding fields to a pricing plan. Note: Select either a Tier or a Tier Parameter; you cannot select both.
Tier Parameter	Used if the Target field is set to Tier. Select from all parameters set up in pricing. Note: Select either a Tier or a Tier Parameter; you cannot select both.

For the balance-threshold application, grant price components have additional properties. Balance-Threshold Application Properties describes the balance-threshold application properties.

Table 6. Balance-Threshold Application Properties
Property	Description
Balance	The balance whose threshold, when crossed during rating, triggers the grant to be applied for balance-threshold based pricing.
Threshold	The threshold (of the specified balance) that when crossed, triggers the grant to be applied for balance-threshold based pricing. When this threshold for the specified balance is crossed during rating, this triggers the grant to impact (extend the validity of) the balance that you specified on the table(s) in the component (specified on the Balance State Update Tables).
Is Instance Specific	When selected, indicates that the balance-threshold based pricing configuration for the grant applies to only balance instances created by the containing offer. When de-selected, indicates that the balance-threshold based pricing configuration for the grant applies to all balance instances in the balance template.