Grants
Grants credit a currency or asset quantity to a balance. They are only applied during non-usage rating. You can grant on purchase, purchased item activation, cancel, recurring, first-usage, or auto-renew, balance threshold, first use, resume, and suspend.
Grants apply to balances owned by the associated subscription or group wallet, unless the grant definition in the pricing configuration has a target tier or tier parameter ID specified (applicable to groups). When a target tier or tier parameter ID is specified, the grant is applied to the G/L balance in the wallet of the group with the specified tier or tier parameter ID. This group must be higher in the group hierarchy than the subscription or group or device that owns the product offer. When a tier parameter ID is selected, this allows group tier name parameterization so that only one set of price components is required in pricing, and upon purchase, a parameter can be used to specify the group tier name.
For more information about specifying a target tier or tier parameter, see the discussion about grant price component properties and grants. For more information about creating predefined parameters, see the discussion about adding parameters in MATRIXX Pricing and Rating.
During rating, all grants in all the applicable product offers are applied—the product offer priority is not used. When there are multiple valid balance instances in a wallet, a grant is allocated to the balance instance that expires last, so the quantity is available for the longest amount of time. When an at-tier grant is selected during rating, if an at-tier required balance is specified in the same product offer, the grant is applied to the required balance instance even if there are other instances of the balance template in the wallet at that tier.
A grant price component can include a single rate table that grants into a single balance template, or can include multiple rate tables to grant into one instance of any of several balance templates. For example, multiple subscription offers might share the same grant but require different balance templates, or a single one-time offer might use a grant with multiple rate tables to top up an instance of any of several balance templates.
When grant components include multiple rate tables, each rate table may specify a different balance template. Normalization on fields, such as fields in the purchased offer (or purchased bundle) custom extension, or fields in the product offer custom extension, can be used to grant to different balances based on the normalized values.
A product offer can designate one grant price component as its GL Target Grant to be used for consumption-based revenue recognition and one grant price component as its Refund Proration Grant to be used for prorated refund of its charges. Often, the same grant price component is designated for both purposes.
For more information about GL Target Grant and Refund Proration Grant, see the discussion about applying proration settings.
- A purchase grant is applied to a balance when a subscriber purchases the product offer or bundle containing the grant.
- A cancelation grant is applied to a balance when the product offer or bundle containing the grant is canceled.
- A first-use grant is applied to a balance when a specified balance is impacted the first time by a usage charge.
- A purchase grant is applied to a balance when a subscriber purchases the product offer or bundle containing the grant.
- Recurring grants are triggered by the start of a new cycle period.
- Auto-renew grants are applied when usage charges cannot be satisfied by available balances (for example, when the subscriber's balance has expired or is at its credit limit).