Create a Billing Profile Template

A billing profile template defines the billing cycle information for a wallet. This information includes the billing period, billing interval, and billing offset date. The billing profile template defines a periodic cycle used by MATRIXX Engine that, in addition to subscriber-specific data, defines the billing cycle.

Before you begin

You must have the Domain role of Configuration User to create a billing profile template.

Procedure

  1. In Billing Profile Templates, click New Billing Profile Template.
  2. In Create New Billing Profile Template:
    1. In Name, enter a unique name.
      This value is returned on a bill cycle query with the SubMan APIs.
    2. Click Create.
  3. In Edit Billing Profile Template:
    1. (Optional) In Description, enter descriptive information about the item.
      This value is returned for a bill cycle query with the SubMan APIs.
    2. In Billing Period, select the value for the billing period where the value is one of:
      • Daily — The billing period is a day.
      • Weekly — The billing period is a week.
      • Monthly — The billing period is a month.
      • Yearly — The billing period is a year.
    3. In Billing Interval, enter the value of the billing interval.

      The number of billing periods that make up the billing cycle. The billing interval is a multiplier of the billing period. For example, if the billing period is monthly and the billing interval is 3, billing occurs once every three months (on a quarterly cycle). The default is one (1).

    4. In Billing Interval, enter the value of the billing interval.
    5. In Billing Date Policy, select the policy that specifies on which date billing occurs within the billing cycle, where the value is one of:
      Property (Policy) Description
      billing_period_start

      This policy specifies that billing occurs at the beginning of the billing period. Depending on the billing period, one of:

      • Daily — Midnight
      • Weekly — Sunday
      • Monthly — First day of the month
      • Yearly — January 1
      offset

      This policy specifies that billing occurs at a specific offset from the beginning of the billing cycle (a specific number of days into the billing cycle).

      You use the Billing Profile REST APIs to set the offset value, which is a number. Depending on the billing period, this is one of:

      • Daily — Not applicable
      • Weekly — The number of days into the week, represented numerically:
        • Sunday (1)
        • Monday (2)
        • Tuesday (3)
        • Wednesday (4)
        • Thursday (5)
        • Friday (6)
        • Saturday (7)
      • Monthly — The number of days into the month: 1–31. If the day of the month is greater than the number of days in the month, the billing runs on the last day of the month.
      • Yearly — The number of days into the year: 1–365. January 1 is 1, and December 31 is 365. For leap years, the last day of the year is used.

      The specific offset (for example, the day of the month) is subscriber or group data that is provided by way of the SubMan API (not provided by the billing profile template).

    6. Click Create.
  4. (Optional) In Recurring Failure Notification Profile, select the notification profile you want to use to control when notifications are generated during or after recurring processing failure.
  5. (Optional) In Recurring Advance Notification Profile, select the profile you want to use to control when advance notifications are generated for upcoming recurring processing (notifications that are generated before the start of a recurring cycle period).
  6. (Optional) In Recurring Recharge Notification Profile, select the profile you want to use to control when advance notifications are generated for upcoming automatic recurring recharges.
  7. (Optional) In Cycle Arrears Notification Profile, select the profile you want to use to control when advance notifications are generated for cycle recurring charges or discounts incurred during the preceding billing cycle and applied in the current cycle.

Results

When the product catalog is compiled and loaded into the MATRIXX Pricing database, the billing profiles are available to SubMan APIs. Customer service representatives can associate one billing profile with a group or subscriber. The time zone of the group or subscriber determines the billing policy dates. If one is not defined, the system time zone is used.
Note: If a group purchases a product offer that adds a periodic balance to the group wallet (G/L balance), and the balance is configured to align with the billing cycle, it is aligned with the billing cycle associated with the group wallet. In addition, each virtual balance created in the group members wallets assumes the billing cycle associated with the member's wallet—not the billing cycle of the group. If any subscribers in the group do not have a billing profile associated with their wallet, the operation fails and the group cannot purchase the product offer requiring the periodic balance. Similarly, if a group's G/L balance is aligned with the billing cycle and a subscriber joining the group does not have a billing cycle defined, the add membership operation fails.