General Product Offer Properties

All product offers have a generic set of properties that you configure when you create a product offer. Some product offers have additional properties that you can configure.

Revision General Product Offer Properties lists general properties.

Table 1. Revision General Product Offer Properties
Property Description
ID An identifier that is automatically created and modified by My MATRIXX.
Name A descriptive name for the product offer that you enter. Product offer names are displayed in My MATRIXX and in bundles.
Description (Optional) Add descriptive information about the purpose of the product offer.
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.
Version External ID (Optional) Use this field to identify this item's version in MATRIXX pricing items. External IDs are saved to the pricing configuration file and loaded into the pricing database. The value of an External ID can be set to any alphanumeric character that is meaningful to your implementation. An External ID could be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It could be used, for example, by the Subscriber Management API to query and purchase product offers and bundle ID.
Product The product to associate with the product offer. The product identifies the service that is provisioned when the catalog item is purchased.
Payment Method (Not applicable to global offers) Specifies the product offer purchase payment method. Leave this field empty to select Pay On Account.
  • Pay On Account — Use the currency balance. Payment is not immediate.
  • Pay Now — Always use Pay Now. A payment method must be defined before using Pay Now.
  • Pay Now or Pay On Account — Use Pay Now if the subscription or group is configured to use Pay Now. Otherwise, use Pay On Account.
Purchase Start Date The date that the product offer is available for purchase.
Purchase End Date The date after which the product is no longer available for purchase.
Max Refund Period in Days (One Time Offers Only) The maximum number of days for the refund period.
Note: One time offer purchase data is saved if the product offer contains a cancel pricing component, has a value set in Max Refund Period In Days, and is stored in the subscription, group, or device purchasing the product offer.
Provider Type (US Taxation Only) Specifies the US taxation provider type.

If an offer uses the default provider type, and the provider type is changed in Tax Setting, the new value is used on the offer. If a provider type is selected on the offer, then that provider type is always used on the offer. For more information about enabling US taxation and setting the default provider type, see the discussion about configuring US tax settings. For more information about using the default provider type versus selecting a product offer-specific provider type, see the discussion about product offers.

Note: US taxation must be enabled in Tax Setting to select the provider type. If US taxation has not been imported, a default provider type list is provided.
Revision Start Date The date a revision of an offer becomes available for rating. This sets when the pricing associated with the product offer becomes valid. If no revision start date is set, the pricing is valid immediately on product offer purchase and available indefinitely.

Each revision must have a revision start date that is after the start date of the previous revision. The Initial revision of an offer (revision "0") does not require a revision start date.

Expiration Policy (Not applicable to global offers) Sets whether the product offer should be canceled when it expires.
  • None — (Default) No cancelation pricing or proration pricing is applied. The offer is invalid during rating.
  • Cancel — Triggers any cancelation pricing and proration processing for recurring charges associated with the product offer. This makes the offer invalid during rating. A product offer cannot have an expiration policy of Cancel if it has a cancelation charge.
Expiration Notification Profile (Not applicable to global offers) Used to select a notification profile that determines when and how often balance expiration notifications are sent. For more information about expiration notification profiles, see the discussion about notifications in MATRIXX Pricing and Rating.
Offer Cancel Type (Not applicable to global offers) The processing behavior for a canceled product offer.
  • Immediate invalidates the product offer for rating immediately when it is canceled. All cancelation pricing is applied, the product offer is removed from the subscription or group, and no further rating of the associated balances can occur. Any remaining balance amounts are either refunded or forfeited, based on the proration settings. If a cancelation notification is configured, it is sent.
    Note: When the Offer Cancel Type is not set to Immediate, the following settings in the Proration tab are set and cannot be modified:
    • The Cancel Proration Type option in Charge Proration Settings is set to Refund Nothing.
    • The Cancel Proration Type option in Grant Proration Settings is set to Forfeit Nothing.
    • The Cancel Proration Type option in Charge in Arrears Proration Settings is set to Charge Full Amount.
  • Billing Cycle, Balance Cycle, and Purchased Item Cycle apply all cancelation operations immediately but leave the product offer valid until the end of the current cycle. This makes the product offer valid for usage rating until the cancel end time so subscribers can use any assets or currencies in the balances associated with the product offer. Therefore, no proration pricing is applied (nothing is refunded or forfeited) and the balance is available for use until the end of the current period of the current cycle. Also, first-use pricing and recurring pricing are not valid during the cancelation period. For on-demand balances, no more entries are created after the current (in-cancelation) entry.
Note: An in-cancelation status in MtxPurchasedOfferInfo indicates that an offer that is configured to end at the end of the current period has been canceled and is in the interval to end the period. If an offer is in a suspended state and it passes the provisioned end date, the offer state becomes inactive. Inactive indicates the offer end date has passed, either from cancelation or by setting the end date during provisioning.

For product offers that are canceled at the end of the current balance cycle, the end times of all valid, required simple balances and periodic balance entries associated with the offer are examined. The end time with the latest expiration date is used, which drains the remaining balance amount up to the cycle end time. If a valid balance does not have a validity end time, it is ignored for the calculations. If no valid balances have an end time set, the cancelation occurs immediately without proration.

Offer Life Cycle Profile The life cycle profile that determines the status definitions and transitions for this product offer. If none is selected, the default life cycle profile is used. If the offer is part of a bundle and the bundle has a life cycle profile defined, the bundle's life cycle profile is used.
Discount Component Scope You have these options for applying the scope of a discount to product offer charges. You can apply discounts to charges:
  • Same Product Offer — Applies discounts to charges from the same product offer in the same purchased item.
  • Same Purchased Item — Applies discounts only to charges from the same purchased item.
  • Any Offer in Purchase Package — Applies discounts to any catalog items in the same purchase package.
  • Any Purchased Items of Owner — Applies discounts to charges from all purchased items owned by the event initiator.
  • Any Purchased Items of Owner or Descendants — Applies discounts to charges from any purchased item at or below in the purchased item hierarchy (for example, descendants).
  • Any Purchased Items of Owner, Descendants or Ancestors — (Applies to usage charges only) Apply discounts to usage charges from any purchased item in the hierarchy. This includes ancestors above, and descendants below, in the purchased item hierarchy.
Note: If a global offer has only non-usage discount pricing components, in order for the non-usage discount pricing components to be applicable during rating, set Discount Component Scope to one of the following:
  • Any Purchased Items of Owner (4)
  • Any Purchased Items of Owner or Descendants (5)
  • Any Purchased Items of Owner, Descendants, or Ancestors (6)

For more information, see the discussion about discount component selection in MATRIXX Pricing and Rating.

Supplemental Sets the product offer as a supplemental offer, so its pricing is applied in addition to the pricing contained in any non-supplemental offers owned by the subscription or group.
Note: An offer can be policy supplemental, but not supplemental for charging. The setting of supplemental compared to non-supplemental is independent for charging, policy, and repository.
Policy Supplemental (Not applicable to finance and service contract offers) Sets whether a product offer is considered a supplemental product offer for policy calculation. During policy calculations, all applicable policy-supplemental product offers are used, and the highest priority non-policy supplemental product offer. A product offer can be configured with the following supplemental settings:
  • Non-supplemental for charging and non-supplemental for policy.
  • Non-supplemental for charging and supplemental for policy.
  • Supplemental for charging and supplemental for policy.
  • Supplemental for charging and non-supplemental for policy.

See the Supplemental property description for information about supplemental offers for charging.

Policy Quota Action Type (Applicable only to subscription and global offers) Sets whether to:
  • Have no impact (not set).
  • To apply the policy component only if the product offer is authorized quota, select Only Apply Policy When Quota Authorized. When set, data and policy changes for the subscription are applied after the next Gy CCR-U is received:
    • For Sy policy components, the Charging Server sends a Spending-Notification-Request (SNR) if the product offer has authorized quota and a later quota request detects a change in authorizing the product offer.
    • For Gx policy components, the Charging Server sends a Re-Authorization-Request (RAR) if the product offer has authorized quota and a later quota request detects a change in authorizing the product offer.
  • To apply the policy component only if the product offer is denied quota, select Only Apply Policy When Quota Denied. When set, data and policy changes for the subscription are applied after the next Gy CCR-U is received:
    • For Sy policy components, the Charging Server sends a Spending-Notification-Request (SNR) if the product offer is denied quota.
    • For Gx policy components, the Charging Server sends a Re-Authorization-Request (RAR) if the product offer is denied.
Repository Supplemental (Not applicable to finance and service contract offers) Sets whether a product offer is considered a supplemental product offer for Sh repository data calculation. During repository calculations, all applicable repository-supplemental product offers are used, and the highest priority non-repository supplemental product offer. A product offer can be configured with the following supplemental settings:
  • Non-supplemental for charging and non-supplemental for Sh repository data.
  • Non-supplemental for charging and supplemental for Sh repository data.
  • Supplemental for charging and supplemental for Sh repository data.
  • Supplemental for charging and non-supplemental for Sh repository data.

See the Supplemental property description for information about supplemental offers for charging.

Can Not Be Suspended (Required for finance and service contract offers, not applicable to global offers) Applies pricing in this offer even when the subscription, device, or group owning the product is in a suspended state. By default, the pricing for a suspended object is not suspended.
Charge Only Required Balances (Not applicable to global offers) Restricts the charges for this offer to a specified balance or balances.
Use Immediate Revenue Recognition Forces immediate revenue recognition for all charges in the offer.
Notifies On Purchase (Not applicable to global offers) When selected, a notification is sent to the contact person associated with the subscription or group, informing them that the product offer has been purchased.
Notifies on Cancel (Not applicable to one-time or global offers) When selected, a notification is sent to the contact person associated with the subscription or group canceling the product offer, informing them that the product offer was canceled.
Notifies on Suspend (Not applicable to one-time or global offers) When selected, a notification is sent to the contact person associated with the subscription or group suspending the product offer, informing them that the product offer was suspended.
Notifies on Resume (Not applicable to one-time or global offers) When selected, a notification is sent to the contact person associated with the subscription or group resuming the product offer, informing them that the product offer was resumed.