5 Wallet Management - Periodic Charges

This chapter explains the Periodic Charges configuration screens.

This chapter contains the following topics.

Periodic Charges

What

When

Notifications

Subscription Pro-Rating

Charge Alignment Pro-Rating

Unsubscription Pro-Rating

Periodic Charges

The Periodic Charges tab enables you to define subscriber charges which are applied regularly. For example, you can define periodic charges for providing a phone service, or for rental of services and equipment.

You can also define periodic charges for sending SMS notifications and for performing voucher type recharges.

Note: Each time a periodic charge occurs, it is logged in an EDR.

For more overview information about periodic charges, see Subscription Services.

Periodic Charges tab fields

This table describes the function of each field in the table on the Periodic Charge tab.

Field Description
Name See What configuration fields
Based On See When configuration fields
Period See When configuration fields
Custom Type NA
Custom Value NA
Tag Date Field NA
Time Notification Time - see When configuration fields
Day of Week See When configuration fields
Day of Month See When configuration fields
Month Trigger month - see When configuration fields
Charge on Activation Whether or not to charge on activation
Charge States Wallet state - selected states - see When configuration fields
Wallet Type NA
Voucher Type NA
Event Class See What configuration fields
Event Name See What configuration fields
Insufficient Funds Action See What configuration fields
Balance Type See What configuration fields
Recharge Amount See What configuration fields
Recharge Action See What configuration fields
Balance Expiry Update Policy See What configuration fields
Balance Expiry Extension See What configuration fields
Wallet Expiry Update Policy See What configuration fields
Success Notification See Notification fields
Failure Notification See Notification fields
ID ID allocated to this record
Deletion Date Displays the actual date that a periodic charge that has been deleted will finally be deleted. This date is calculated as the current date + one Period + the greatest number of any Days After Failed Charge for grace or loss of service notifications + 1.

Finding periodic charges

Follow these steps to search for an existing periodic charge.

  1. In the Wallet Management screen, select the Service Provider from the drop down list.

  2. On the Periodic Charges tab, enter the search criteria you are using to find the required periodic charge.

    Enter the first few characters of the Name and select the Period you want from the drop down box.

  3. Select the Show Marked For Deletion check box to include charges that have been deleted, but have not yet been removed from the database, in the search results (row will be grayed).

    Note: By default the check box is deselected and the search will ignore deleted periodic charges.

  4. Click Search.

    Result: The table displays the first 100 records matching the search criteria entered in steps 2 and 3. If the required periodic charge is not displayed and more than 100 records were returned, enter different search criteria and click Search again.

Adding periodic charges

Follow these steps to add a new periodic charge.

  1. In the Wallet Management screen, select the service provider from the Service Provider list.

  2. On the Periodic Charges tab, click New.

    The New Periodic Charge window opens and displays the What option.

  3. In the Name field, enter a new name for the periodic charge. The name must be unique. Maximum length is 46 characters.

  4. Add the details on the different option panels as necessary. See:

  5. Click Save.

Notes:

  • To apply a periodic charge to a subscriber, you must assign it to their product type. For more information, see Periodic Charges.

  • To add a periodic charge to a periodic charge group, you must edit the periodic charge group to add it to. For more information, Periodic Charge Groups.

Related topic

Periodic Charges

Configuration options summary

This table lists the configuration options for periodic charges and their functionality.

Option Description
What Configures the type of periodic charge to be applied.
When Defines when to apply the periodic charge.
Notifications Configures the notifications which can be sent to the subscriber.
Subscription Pro-Rating Configures the rules for pro-rating a subscriber's periodic charge subscription.
Charge Alignment Pro-Rating Configures the rules for aligning a subscriber's periodic charge subscription to a common cycle point.
Unsubscription Pro-Rating Configures the rules for pro-rating a subscriber's periodic charge subscription refund.

Editing periodic charges

Follow these steps to edit an existing periodic charge.

  1. In the Wallet Management screen, select the service provider from the Service Provider list.

  2. On the Periodic Charges tab, select the periodic charge to edit.

    Tip: You can search for a specific periodic charge. See Finding periodic charges.

  3. Click Edit.

    The Edit Periodic Charges window opens and displays the What option.

    Note: If a periodic charge is marked for deletion, all components will be grayed out, or read-only, except for the Loss of Service Notifications field on the Notifications option.

  4. Check or update the details on the different option panels as necessary.

    For more information about the available options, see:

  5. If you have made changes to the periodic charge's details, click Save.

    If you do not want to make changes to the periodic charge's details, click Cancel.

Notes:

Related topic

Periodic Charges

Deleting periodic charges

Follow these steps to delete an existing periodic charge.

  1. In the Wallet Management screen, select the service provider from the Service Provider list.

  2. In the table on the Periodic Charges tab, select the periodic charge to delete.

  3. Click Delete.

    Result: You see the Delete Confirmation prompt.

  4. Click OK to delete the record from the database.

    Result:

    If the periodic charge has pre-charge and grace notifications configured, you see the Deleting Periodic Charge with notifications.

    If not, the periodic charges confirmation prompt appears. Note that once deleted, a record with the same name cannot be recreated.

  5. Click OK to return to the Periodic Charges tab.

    Note: The periodic charge is still present until the final deletion date.

    Note: You can search for deleted periodic charges on the Periodic Charges tab by selecting the Show Marked for Deletion check box, before making the search. See Periodic Charges tab fields for a description of a deletion date.

Related topic

Periodic Charges

Deleting Periodic Charge with notifications

When deleting a periodic charge that has any pre-charge and grace Notifications configured, a screen opens allowing you to define different notifications to be used during the period it takes to delete the charge.

  1. If the periodic charge you are deleting from the Periodic Charge tab has pre-charge and grace notifications configured, you see the Delete Periodic Charge screen.

  2. If required, change the notifications to be sent during the period before the deleted periodic charge is removed from the database.

    The following notifications may need to be configured:

    • A separate Pre-charge notification for every pre-charge notification already configured (up to 3)

    • A single Grace notification for all currently configured grace notifications; only a single grace state will be available when the periodic charge definition has been deleted; if both grace periods are defined, the single Grace period available after periodic charge definition is deleted will correspond to the second grace period.

    • Loss of Service notification if loss of service notification is configured in the periodic charge to be deleted

  3. Click OK to delete the record from the database.

    Result: The Periodic Charges confirmation prompt appears. Note that once deleted, a record with the same name cannot be recreated.

  4. Click OK to return to the Periodic Charges tab.

    Note: The periodic charge is still present until the final deletion date.

Note: You may search for deleted periodic charges on the Periodic Charges tab, by selecting the Show Marked for Deletion check box, then making the search. See Periodic Charges tab fields for a description of a deletion date.

Related topic

Periodic Charges

What

The what configuration configures what happens when the periodic charge runs. This can include specifying charges and/or recharges.

Topics:

What configuration fields

Adding What configuration options

Editing What configuration

What configuration fields

This table describes the function of each field on the What configuration option on the New or the Edit Periodic Charge screen.

Field Description
Charge Type

The type of charge. The options are:

  • Debit

  • Debit and Credit Plan

  • Debit and Credit

  • Credit

  • Credit Plan

  • Notification Only

  • Control Plan

The fields you can use will be defined by the type of charge you have chosen.

Debit / Debit and Credit Plan / Debit and Credit Charge Types

Field Description
Event Class

The event class for the charge.

This field is populated by the named event sets configured on the Named Event tab on the Rating Management screen.

This field is available and mandatory for any Debit action.

Event Name

The event name for the charge.

This field is populated by the named events configured on the Named Event tab on the Rating Management screen.

This field is available and mandatory for any Debit action.

Insufficient Funds Action

Specifies what will happen if there are insufficient funds to cover the charge. The options are:

  • Take balance negative - The full charge will be applied, even if this results in a negative balance.

  • Do not make charge - No charge is made.

This field is available for any Debit action.

Retain Without Credit

Selecting this option provides for excluding grace states in the event of a debit failure while continuing to retain the periodic service. Once selected, if a debit action fails, the credit due from a promotion is not implemented, but the periodic service will continue to the next "Active" state.

This periodic service is only applicable to the following Charge Types:

  • Debit and Credit Plan

  • Debit and Credit

By default, the check box is not selected.

Credit Plan / Debit and Credit Plan Charge Types

Field Description
Credit Plan

The credit plan which defines the recharge and product type swap which is executed when this periodic charge is triggered.

This drop down list is populated by records from the Voucher Type tab.

Note: If the application of the voucher type's expiry policy would result in a periodic charge's expiry date being reduced (that is, moved closer) the original expiry date will not be changed.

This field is available for any credit plan action.

Control Plan Charge Type

Field Description
Control Plan

The control plan for this periodic charge to trigger.

This drop down list is populated from all the control plans that have been saved with an association to the OSD operation set periodic charge.

Credit / Debit and Credit Charge Types

Field Description
Recharge Action

Specifies from the list the way a credit is to be applied. The options are:

  • Replace current value with amount credited (updates existing bucket with new value)

  • Update using an existing bucket (updates existing bucket by increasing it by the specified value)

  • Add new bucket with amount (creates a new bucket to hold the new value)

This field is available for any credit action. It is not available for credit plan actions.

Balance Type

The balance type to be credited with the recharge amount. This drop down list shows all chargeable balance types for the current service provider.

For more information about balance types, see Balance Types.

This field is available for any Credit action.

Recharge Amount

The credit recharge value, in units of the balance type.

The allowed range is 1 to 4294967294.

This field is available for any Credit action.

Balance Expiry Extension Days and Hours

The number of days and hours by which to extend the current balance expiry period for the balance type specified in the Balance Type field.

Allowed range is 1 hour to 999999 days.

This field is available for any Credit action where the Balance Expiry Update Policy is not set to Ignore.

Balance Expiry Update Policy

Controls how the balance's expiry date is extended by the recharge. The options are:

  • Best - if you want the system to select the best policy option for the subscriber depending on their particular circumstances,

  • Ignore - if you do not want to change the current expiry period,

  • Extend - if you want to extend the current expiry period by the days and hours specified,

  • Extend From Today - if you want the current expiry period to be the number of days and hours specified from today's date.

This field is available for any Credit action.

Balance Offset Date

(Use Offset Date)

Optional balance offset date that will be applied when the selected balance type is recharged. Creates a new bucket for the balance type that will be available from the balance offset date.

To activate these fields, select the Use Offset Date check box, then select:

  • Date - if you want to set the balance offset date to a specific date. Select the date you want via Date Chooser button button.

  • Extension - if you want to base the balance offset date on the current system date extended by the specified number of Days and Hours.

Allowed range for days is 1-999999.

Allowed range for hours is 1-23.

Wallet Expiry Extension Days and Hours

The number of days and hours by which to extend the current wallet expiry date.

This field is available for any Credit charge where the Wallet Expiry Update Policy is not set to Ignore.

Wallet Expiry Update Policy

Controls how the wallet's expiry date is extended by the recharge.

See the Balance Update Expiry Policy field description for the list of options.

This field is available for any Credit action.

Notification Only Charge Type

No fields are available for this Charge Type.

Adding What configuration options

Follow these steps to configure what happens when the periodic charge runs.

  1. In the New Periodic Charge screen, select What from the left hand menu.

    You see the What option fields.

  2. From the Charge Type list, select the type of actions this periodic charge should take. The available fields on which charge type you select.

  3. Configure this record by entering data in the fields on this screen as defined by the type of periodic charge you are adding.

    For an overview of the fields on this screen and when they are available, see What configuration fields.

Related topic

What

Editing What configuration

Follow these steps to view or change what happens when the periodic charge runs.

  1. In the Edit Periodic Charge screen, select the What option from the left hand menu.

    Result: You see the What option.

  2. Check or update the configuration as necessary.

    For more information about the fields in this option, see What configuration fields.

Related topic

What

When

The periodic charge when configuration sets the frequency and timing of when the periodic charge is triggered. Periodic charges which are scheduled to occur at exactly the same time are handled in alphabetical order.

For more information about how periods are calculated, see Period calculations.

Topics:

About Scheduling Periodic Charges

When configuration fields

Adding When configuration

Editing When configuration

About Scheduling Periodic Charges

You define a schedule for a periodic charge by using the periodic charge When option. The periodic charge schedule depends on the type of date you select in the Based On field. Select:

  • Fixed Date to schedule a particular day or date that the periodic charge period will run from. For example, you could schedule a weekly charge that occurs every Friday, or you could schedule a monthly charge that occurs on the 28th day of every month, and so on.

  • Service Activation to schedule a periodic charge based on the date that the subscriber subscribed to the periodic charge. For example, if a subscriber subscribes to a monthly periodic charge on the 15th of the month, then the next charge will occur on the 15th of the next month.

  • Wallet Activation to schedule a periodic charge based on the date that the subscriber's wallet was activated. The date of the next charge is determined by adding the period selected for the charge to the Subscriber's wallet activation date. If this date is in the past, then this process is repeated until a date in the future is determined. For example, if the wallet is activated on 1st December 2012 and the charge period is weekly, then one week is added to the activation date to give a date for the next charge of 8th December 2012. If this date is in the past then another week will be added, and so on, until a future date for the next charge is determined.

  • Reference Date to schedule a periodic charge based on a specific date. You can specify a reference date that is in the past or in the future. If you specify a future date then this will be the first charge date. If you specify a past date, then the date of the first charge is determined by adding the charge period to the specified reference date, and repeating this process until a date in the future is determined.

You can specify how many times a periodic charge is applied by specifying the number of repeats for the periodic charge in the Number of Repeats field. For periodic charges that are based on a specified reference date, you can select whether to count the number of repeats from the reference date or from the date of the first charge. If you select to count repeats from the reference date, then the charges count from the reference date itself even if this date is in the past.

Number of repeats example:

In this example, the reference date is set to two weeks in the past, the period is set to weekly, and the number of repeats is set to three. If the number of repeats is counted from:

  • The reference date, then two charges will already have been counted, and therefore the next and last charge will occur the following week.

  • The date of the first charge, then the three charges will be applied from the anniversary of the period (the following week).

For more information about how periods are calculated, see Period calculations.

When configuration fields

This table describes the When configuration fields in the Periodic Charge screen.

Field Description
Based On

Sets the type of date to use as a basis for scheduling the periodic charge. Select one of the following:

  • Fixed Date

  • Service Activation

  • Wallet Activation

  • Reference Data

For more information, see About Scheduling Periodic Charges.

Period Sets the frequency with which this periodic charge is run.
Custom Period

Allows you to specify the number of days or months for which a custom periodic charge should apply.

Notes:

  • These fields are available only if you select Custom from the Period list.

  • If the custom period starts on a fixed date, and the month is set to the past, then NCC uses the specified day in the current month to calculate the period for the charge.

Number of Repeats

Sets the number of times to run this periodic charge. After this number of charges, the periodic charge becomes unsubscribed automatically.

Note: The normal behavior for unsubscribing a subscriber for failed charges is not affected.

Notification Hour

Defines when to send pre-charge notifications and grace notifications.

Leave this field blank if you want to send notifications at midnight (as set by the notificationMidnightTZ parameter in the eserv.config file, see CCS Technical Guide for more information).

Note: The actual notification time may be influenced by other factors on the VWS.

Timezone

(Optional) Defines the time zone that will be used when applying the charge. Overrides the default time zone set by the jnlp.sms.TZ Java application property. For more information, see SMS Technical Guide.

Note: The Timezone field applies only to fixed date periodic charges.

Remove Charge

Sets the number of days to allow, after sending the Loss Of Service notification, before deleting the periodic charge from the subscriber's wallet.

Must be more than the number of days specified in the Days After Failed Charge field.

If this field is not set, the periodic charge is removed after 1825 days (5 years).

Existing Subscribers

Whether this periodic charge should apply to existing subscribers. This will apply to all wallets with a specific product type when the periodic charge is applied to that product type.

Note: You cannot apply a period charge to existing subscribers if you set Based On to Service Activation.

Activating Subscribers

Whether a named event should be charged when the wallet is activated.

For more information about named events, see Named Event.

Charge Hour Sets the hour when the charge will be applied on the charge date.
Day of Week

The full name of the day of the week on which the periodic charge should run.

Note: Applies only if Period is set to weekly.

Day of Month

The day of the month the periodic charge should run on. Allowed values: 1-31.

Notes:

  • If the charge is set to 29, 30 or 31, and is applied in a month which does not include the specified day; the charge will be applied on the last day of the month.

  • Applies only if Period is set to monthly, quarterly, half-yearly, annual, or custom.

Trigger Month

The month that the periodic charge's cycle should start on.

Note: Applies only if Period is set to quarterly, half-yearly or annual.

Active Whether or not to run the periodic charge on wallets which are in the active state.
Dormant Whether or not to run the periodic charge on wallets which are in the dormant state.
Frozen Whether or not to run the periodic charge on wallets which are in the frozen state.
Suspended Whether or not to run the periodic charge on wallets which are in the suspended state.
Terminated Whether or not to run the periodic charge on wallets which are in the terminated state.

For more information about wallet states, see Wallet states.

Notes:

  • Periodic charges can be configured to apply only to some wallet states. When the periodic charge is triggered, CCS checks whether the periodic charge is allowed for the wallet state before taking any action. If the wallet state is disallowed, notifications will be skipped but the expiry logic will continue as normal (that is, the periodic charge will be processed as if the charge failed).

  • Periodic charges are never applied to wallets which are in the pre-use state.

Adding When configuration

Follow these steps to configure the frequency and timing of when the periodic charge is triggered.

  1. In the New Periodic Charge screen, select the When option from the left hand list.

    Result: You see the When option.

  2. Configure this record by entering data in the fields on this screen.

    For more information about the fields on this screen, see When configuration fields.

Related topic

When

Editing When configuration

Follow these steps to view or change the frequency and timing of when the periodic charge is triggered.

  1. In the Edit Periodic Charge screen, select the When option from the left hand menu.

    Result: You see the When option.

  2. Check or update the configuration as necessary.

    For more information about the fields in this option, see When configuration fields.

Related topic

When

Notifications

The notifications configuration enables you to configure which notifications are sent when different periodic charge-related events occur.

Note: If a subscriber account's profile sets Suppress Notifications to true, no notifications will be sent, even if they are configured to be sent here. For more information about the Suppress Notifications field, see Details.

Topics:

Notifications fields

Adding Notifications configuration

Editing Notifications configuration

Notifications fields

This table describes the function of each field.

Pre-Charge Notifications

Note: If None is selected in the drop down lists:

  • No notification will be sent.

  • The corresponding Days Before Charge field is cleared and made unavailable.

Field Description
First

A notification to send to the subscriber before the charge is applied. The corresponding Days Before Charge field defines how many days before the charge this notification should be sent.

Note: If the frequency is daily, this field is not available.

Days Before Charge

The number of days before the periodic charge is first applied to send the notification specified in the drop down list which corresponds to this field.

If this field is available, it must have a value between 1 and the periodic charge frequency measured in days, minus 1.

The maximum value in days depends on the value of the Period and Custom Period fields specified in the When option, as follows:

  • Weekly: 6

  • Monthly: 27

  • Quarterly: 88

  • Half-Yearly: 180

  • Annually: 364

  • Custom-Days: Days specified, minus 1

  • Custom-Months: (months specified x 28), minus 1

Each field must have a lower value than the field directly above it.

Second

A notification to send to the subscriber before the charge is applied. The corresponding Days Before Charge field defines how many days before the charge this notification should be sent.

Note: If the frequency is less than every 7 days, this field is not available.

Third

A notification to send to the subscriber before the charge is applied. The corresponding Days Before Charge field defines how many days before the charge this notification should be sent.

Note: If the frequency is less than every 7 days, this field is not available.

Charge Notifications

Note: If None is selected in the drop down lists no notification will be sent.

Field Description
Successful Charge A notification to send to the subscriber when the charge is applied successfully.
Failed Charge A notification to send to the subscriber when the charge is not applied successfully.
Final Success

A notification to send to the subscriber when the charge is applied successfully and it is the last time the periodic charge will run.

Note: This field is only available if the Number of Repeats field in the When option has a value.

Grace Notifications

Notes:

  • If None is selected for the drop down lists, the corresponding Days After Failed Charge field is cleared and made unavailable.

  • If No Notification is selected for the drop down lists, the corresponding Days After Failed Charge field is available, but no notification will be sent.

Field Description
First Grace A notification to send to the subscriber when the periodic charge defined for this service has initially failed. The charges for has entered a grace period (that is, the periodic charge has failed).
Days After Failed Charge

The number of days after the periodic charge has failed to send the notification specified in the drop down list which corresponds to this field.

If this field is available, it must have a value between 1 and the frequency the periodic charge is applied in measured in days -1 as shown in Days Before Charge field.

Notes: This field sets the period before the periodic charge is set to Terminated, and (if there is one) the Loss of Service notification is sent.

Second Grace A notification to send to the subscriber when the service this periodic charge defines the charges for has entered a grace period (that is, the periodic charge has failed).
Recharge Success A notification to send to the subscriber when the subscriber successfully recharges their wallet while in a grace period (that is, the periodic charge has previously failed).
Recharge Failure A notification to send to the subscriber when the subscriber tries to recharge their wallet while in a grace period and the recharge fails (that is, the periodic charge has previously failed and has failed again).

Loss of Service Notification

Notes:

  • If None is selected for the drop down list, the corresponding Days After Failed Charge field is cleared and made unavailable.

  • If No Notification is selected for the drop down list, the corresponding Days After Failed Charge field is available, but no notification will be sent.

Field Description
Loss of Service A notification to send to the subscriber when their service has been discontinued (that is, this periodic charge has failed and exited any available grace period).
Days After Failed Charge The number of days after a subscriber's service has been disabled to send the Loss of Service notification. Must be greater than the Days After Failed Charge for the Second Grace notification (or First Grace if Second Grace is not set).

Note: The drop down lists on this screen are populated by the Type records configured in the CCS Application set in the Notifications tab on the ACS Configuration screen. For more information about the ACS Configuration screen, see ACS User's Guide.

Adding Notifications configuration

Follow these steps to configure the notifications which can be sent out by a periodic charge.

  1. In the New Periodic Charge screen, select the Notifications option from the left hand list.

    Result: You see the Notifications option.

  2. Configure this record by entering data in the fields on this screen.

    For more information about the fields on this screen, see Notifications fields.

Related topic

Notifications

Editing Notifications configuration

Follow these steps to view or change the notifications configuration.

  1. In the Edit Periodic Charge screen, select the Notifications option from the left hand menu.

    Result: You see the Notifications option.

  2. Check or update the notifications as necessary.

    For more information about the fields in this option, see Notifications fields.

Related topic

Notifications

Subscription Pro-Rating

The subscription pro-rating configuration allows periodic services to be seamlessly charged from the subscription start in a manner that is transparent to the service being offered by the operator.

Topics:

Subscription configuration fields

Adding Subscription configuration

Subscription configuration fields

Field matrix

Subscription configuration fields

This table describes the function of each field.

Field Description
Name Name of the periodic charge
Charge Type

The type of charge. The options are:

  • Debit

  • Debit and Credit Plan

  • Debit and Credit

  • Credit

  • Credit Plan

The fields you can use will be defined by the type of charge you have chosen.

Pro-Rating Type

The Pro-rating method to apply. Options are:

  • None - No pro-rating at all, charges are applied without respecting the actual date and periodic charge start time.

  • Proportional - The actual date defines the start of the subscription period, the charge to be applied is defined by calculating the remaining period of the subscription from the start point to the end of the subscription period using the defined granularity units. This is then applied as a percentage reduction to the full subscription charge or subscription elements (for example, bundles).

  • Proportional and Fixed - This is calculated in exactly the same manner as proportional, described above, but an option to add a fixed additional subscription charge or appropriate elements such as SMSs in a bundle is made. This charge has optional units, either in currency or in additional periodic units.

Use Unique First Charge

Allow an initial charge that differs from subsequent charges.

Note: This charge is a substitute for the first charge. It will also be pro-rated if specified, unlike the fixed charge which is not pro-rated.

Event Class

The event class for the charge (used for both first and all subsequent charges).

This field is populated by the named event sets configured on the Named Event tab on the Rating Management screen.

This field is available and mandatory for any Debit charge.

Event Name

The event name for the charge (used for both first and all subsequent charges).

This field is populated by the named events configured on the Named Event tab on the Rating Management screen.

This field is available and mandatory for any Debit charge.

Insufficient Funds Action

Specifies what will happen if there are insufficient funds to cover the charge (used for both first and all subsequent charges). The options are:

  • Take balance negative - The full charge will be applied, even if this results in a negative balance.

  • Do not make charge - No charge is made.

This field is available for any Debit charge.

Adding Subscription configuration

Follow these steps to configure the subscription pro-rating for a periodic charge.

  1. In the New Periodic Charge screen, select the Subscription Pro-Rating option from the left hand list.

    Result: You see the Subscription Pro-Rating option.

  2. Select the Pro-Rating Type from the drop down list. See Subscription configuration fields for the options and their usage.

  3. Configure this record by entering data in the fields on this screen as defined by the type of periodic charge and rating being added.

    For an overview of the fields on this screen, see Subscription configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  4. Select the Use Unique First Charge check box if the initial charge differs from the subsequent charges.

  5. Click Save.

Related topic

Subscription Pro-Rating

Editing Subscription configuration

Follow these steps to view or change the subscription pro-rating configuration.

  1. In the Edit Periodic Charge screen, select the Subscription Pro-Rating option from the left hand menu.

    Result: You see the Subscription Pro-Rating option.

  2. View or update the subscription pro-rating as necessary.

    For more information about the fields in this option, see Subscription configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  3. Click Save.

Related topic

Subscription Pro-Rating

Field matrix

This table describes the relationships between the pro-rating actions and the field sets available.

Charge Type Subscription Charge Alignment Unsubscription Pro-Rating Types

Debit

Debit and Credit Plan

Debit and Credit

First Charge NA NA

None

Proportional

Debit

Debit and Credit Plan

Debit and Credit

First Charge

Fixed Charge

NA Fixed Charge Proportional & Fixed Charge

Credit

Credit Plan

NA NA NA

None

Proportional

Credit

Credit Plan

Fixed Charge Fixed Charge Fixed Charge Proportional & Fixed Charge

Notification Only

Control Plan

NA NA NA

None

Proportional

Proportional & Fixed Charge

Charge Alignment Pro-Rating

Charge Alignment configuration fields

This table describes the function of each field.

Field Description
Name Name of the periodic charge
Charge Type

The type of charge. The available options are:

  • Debit

  • Debit and Credit Plan

  • Debit and Credit

  • Credit

  • Credit Plan

The fields you can use will be defined by the type of charge you have chosen.

Pro-Rating Type

The pro-rating method to apply. If the periodic charge is based on:

  • 'Fixed Date' or 'Wallet Activation' then pro-rating method will be None

  • 'Service Activation' or Reference Date' then all pro-rating methods will be available

The available options are:

  • None

  • Proportional

  • Proportional and Fixed

Note: Charge alignment pro-rating can only be performed for fixed charges. Other options prevent the configuration from being set up.

Event Class

The event class for the charge (used for both first and all subsequent charges).

This field is populated by the named event sets configured on the Named Event tab on the Rating Management screen.

Event Name

The event name for the charge (used for both first and all subsequent charges).

This field is populated by the named events configured on the Named Event tab on the Rating Management screen.

Insufficient Funds Action

Specifies what will happen if there are insufficient funds to cover the charge (used for both first and all subsequent charges). The options are:

  • Take balance negative - The full charge will be applied, even if this results in a negative balance.

  • Do not make charge - No charge is made.

Adding Charge Alignment configuration

Follow these steps to configure the charge alignment pro-rating for a periodic charge subscription.

  1. In the New Periodic Charge screen, select the Charge Alignment Pro-Rating option from the left hand list.

    Result: You see the Charge Alignment Pro-Rating option.

  2. Select the Pro-Rating Type from the drop down list. See Charge Alignment configuration fields for the options and their usage.

  3. Configure this record by entering data in the fields on this screen as defined by the type of periodic charge and rating being added.

    For an overview of the fields on this screen, see Charge Alignment configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  4. Click Save.

Related topic

Charge Alignment Pro-Rating

Editing Charge Alignment configuration

Follow these steps to view or change the charge alignment pro-rating configuration.

  1. In the Edit Periodic Charge screen, select the Charge Alignment Pro-Rating option from the left hand menu.

    Result: You see the see Charge Alignment Pro-Rating option.

  2. View or update the charge alignment pro-rating as necessary.

    For more information about the fields in this option, see Charge Alignment configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  3. Click Save.

Related topic

Charge Alignment Pro-Rating

Unsubscription Pro-Rating

The unsubscription pro-rating configuration sets the rules for refunding "unused" amounts of the periodic charge subscription when a subscription is stopped.

Topics:

Unsubscription configuration fields

Adding Unsubscription configuration

Editing Unsubscription configuration

Unsubscription configuration fields

This table describes the function of each field.

Field Description
Name Name of the periodic charge
Charge Type

The type of charge. The available options are:

  • Debit

  • Debit and Credit

  • Credit

The fields you can use will be defined by the type of charge you have chosen.

Pro-Rating Type

The pro-rating method to apply. The available options are:

  • None

  • Proportional

  • Proportional and Fixed

Note: Unsubscribing can only be performed for fixed charges. Other options prevent the configuration from being set up.

Event Class

The event class for the charge (used for both first and all subsequent charges).

This field is populated by the named event sets configured on the Named Event tab on the Rating Management screen.

Event Name

The event name for the charge (used for both first and all subsequent charges).

This field is populated by the named events configured on the Named Event tab on the Rating Management screen.

Insufficient Funds Action

Specifies what will happen if there are insufficient funds to cover the charge (used for both first and all subsequent charges). The options are:

  • Take balance negative - The full charge will be applied, even if this results in a negative balance

  • Do not make charge - No charge is made

Adding Unsubscription configuration

Follow these steps to configure the unsubscription pro-rating for a periodic charge.

  1. In the New Periodic Charge screen, select the Unsubscription Pro-Rating option from the left hand list.

    Result: You see the Unsubscription Pro-Rating option.

  2. Select the Pro-Rating Type from the drop down list. See Unsubscription configuration fields for the options and their usage.

  3. Configure this record by entering data in the fields on this screen as defined by the type of periodic charge and rating being added.

    For an overview of the fields on this screen, see Unsubscription configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  4. Click Save.

Related topic

Unsubscription Pro-Rating

Editing Unsubscription configuration

Follow these steps to view or change the unsubscription pro-rating configuration.

  1. In the Edit Periodic Charge screen, select the Unsubscription Pro-Rating option from the left hand menu.

    Result: You see the Unsubscription Pro-Rating option.

  2. View or update the unsubscription pro-rating as necessary.

    For more information about the fields in this option, see Unsubscription configuration fields.

    Note: The Charge Type and Pro-Rating Type dictate the fields that can be use for pro-rating. See Field matrix.

  3. Click Save.

Related topic

Unsubscription Pro-Rating