Difference between revisions of "ServicePlans/ServicePlans/Included Value"
(→Service Subscription Cap Threshold Notification Event) |
(→Service Subscription Cap Threshold Notification Event) |
||
| Line 51: | Line 51: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+Service Subscription Notification Variables | |+Service Subscription Notification Variables | ||
| − | |Cap variable || Corresponding Included Value Variable || Description and Notes | + | |'''Cap variable''' || '''Corresponding Included Value Variable''' || '''Description and Notes''' |
|- | |- | ||
|Cap Base Amount || Included value || This is the raw included value amount. It not take into account any prorata amount. Regardless of the included value type, it displays a numerical figure. | |Cap Base Amount || Included value || This is the raw included value amount. It not take into account any prorata amount. Regardless of the included value type, it displays a numerical figure. | ||
Revision as of 18:41, 19 February 2015
Contents
Included Value Overview
As of Tuesday 24th February 2015, Emersion will remove support for 'caps' on Package Plans and Service Plans and replaced it with 'included value'. While included value is similar in nature to plan caps, they are not identical. Included value includes additional features not supported under 'caps'.
The upgrade also requires important updates to the Subscription threshold notification (TCP Alert) events.
- Service Subscription Cap Threshold Notification Event
- Service Bolt-on Subscription Cap Threshold Notification Event
You will need to review and update these event templates after the release. Failure to do so may result in incorrect information being sent to your customers.
Features of Included Value
Under caps, Emersion provided support for a single dollar-based cap against a plan. There was no support for multiple caps, or caps that were not dollar-based amounts. Included value introduces multiple included value amounts. Furthermore, you can have different types of included value. The types of included value are:
- dollar
- kilobytes
- units
- seconds (converted to HH:MM:SS when presented to users)
For each plan, Emerson can support up to 4 included value amounts. By default, Emersion will enable 1 included value amount for you to use. If you would like to have additional included value amounts for your plans, please raise a sales ticket in the Emersion Support portal and the sales team will be glad to provide a quote.
Included Value Plan Settings
The settings page of Package Plans and Service plans is updated so that cap settings are replaced with Included value settings.
Below is a screenshot of the Package Plan configuration screen showing support for caps.
Below is a screenshot of the Package Plan configuration screen showing the 4 available Included Value options. By default, Emersion offers a single included value option with all types (dollar, kilobytes, units, seconds).
Changes to Subscription Events
In order for the subscription threshold notification events to support included value and bolt-on add-ons, Emersion has upgraded the two existing events and will shortly release an additional event for clients who subscribe to bolt-on add-ons.
Service Subscription Cap Threshold Notification Event
The following changes apply to this event:
- The name of this event has changed to Service Included Value Threshold Notification.
- Some variables will undergo a name change to make them consistent across events and better describe their function and purpose.
- Ex-Tax versions of dollar-based variables are no longer supported.
- New variables have been added.
- Some variables can no longer be supported and will be deprecated.
Variable changes are highlighted in the table below
| Cap variable | Corresponding Included Value Variable | Description and Notes |
| Cap Base Amount | Included value | This is the raw included value amount. It not take into account any prorata amount. Regardless of the included value type, it displays a numerical figure. |
| Cap Amount | Included value prorata | This is the total included value amount (Included value) converted to a client-friendly format based on the type. Takes into account any prorata amount. |
| Cap Amount Left | Included value remaining | The included value remaining taking into account any prorata period. |
| Cap Base Amount Inc Tax | Included value | Templates found using this deprecated variable will be automatically transitioned to the Included Value equivalent variable. |
| Cap Amount Inc Tax | Included value prorata | The included value taking into account any prorata period. Templates found using Cap Amount Inc Tax will be automatically migrated to use this replacement variable. |
| Cap Amount Left Inc Tax | Included value remaining | The included value remaining taking into account any prorata period. Templates found using Cap Amount Left Inc Tax will be automatically transitioned to the Included Value equivalent variable. |
| Service name | New variable | External name of the Service |
| Included value name | New variable | External Name of the Included Value |
| Included value used | New variable | The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type. |
| Included value type | New variable | The type of included value (Dollars, Kilobytes, Seconds & Units) |
| Included value type shortcode | New variable | The standard display based on the included value type.
|
I have plan caps now - What do I have to do?
As part of the upgrade, Emersion will migrate your existing plan cap settings to the new included value equivalent settings. This will ensure a seamless transition so you can continue selling plan subscriptions with no interruption.
If you are using the subscription threshold notification events you will need to ensure that your template is reviewed carefully and updated.
