Usage Rates and Usage Programs
Rev.io offers several ways to create rate plans and apply them for call rating. Rates can be added manually using a form in the UI. This is useful if only a few call type/rates will be included in the plan. The other option is to import the rates using a template file. This option is great for importing international rate decks or updating a large file of rates. The information below covers all of those options including how to upload different versions of rate decks in to the same plan and set the effective dates for when those should begin. Usage Rates (rate plans) are grouped in to a Usage Program and assigned to the line/service, used individually in the Special Rates section on the customer profile, or added at a product level in the Product Catalog.
Creating a New Usage Rate Plan Manually
- Usage Rates are the rates that apply to the individual call record based on call type. To create a new Usage Rate, go to Settings > Usage Rates and click Add.
- Add a description and click Save to access the remaining fields on this page.
- Complete the fields in the Rate section to add a new rate. The following fields are required:
- Description - Use a name that will describe the content in the rate.
- Rate or Surcharge - Two separate fields that can be used independently to define the rate per call or a flat surcharge. Both fields can be used on a line item if desired.
- Country/Area/State - Typically used to specify International Dialing Codes (Country), Telephone City Dialing Codes (Area) or State or Province Abbreviations (State) for calls outside of the U.S. Depending on how calls are rated for this plan at least one of these fields may be required but not all.
- Product Type 1 - This field is used to tell Rev.io what type of call this rate will apply. Specifying this field requires some knowledge about Product Types in Rev.io and how calls are assigned a call type. A full list of usage Product Types can be found under Settings > Product Types. Sort by the Description header in this table to see all Usage call types and tax classes associated with them.
- Initial/Increment - Specifies the initial billing minimum call length and how it will incrementally bill after that. Here's an example of each - 30/6: This indicates that there is a minimum billing length of 30 seconds followed by 6 second increments. For example, a 15 second call will be billed at 30 seconds because it is within the 30 second minimum. A 43 second call will be billed at 48 seconds. A helpful way to view this would be 30+6+6+6.
- Call Direction - Specifies the direction of the call. This field accepts BOTH, INBOUND, and OUTBOUND as the call direction
- A Rate Plan can have one or many line items. Press the Save button once all rates have been added to the table on this page.A Rate Plan set to capture and rate domestic calls at a certain rate might look like the example below. This Rate Plan contains 4 entries; interstate, intralata, intrastate and local. Each rate is set to 0.00 indicating that these calls will be rated but the customer will not incur a charge. This Rate Plan can be placed at the Product or in Special Rates on the Customer Profile. It may be combined with other Rate Plans to create a Rate Program and used on a Line/Service level.
Editing an Existing Rate Plan Manually
- If editing an existing Rate, go to Settings > Usage Rates.
- Click Edit next to the Rate Plan that requires editing.
- Scroll to the bottom of the page to the rate table and click Edit on the selected rate from the table at the bottom of the page that requires the edit. The link is in the last column on the right side of the table for each line item. Update the information in the Rate section of the screen and click Save.
- Alternatively, the rate from can be completed and saved to add a brand new rate to the existing plan.
Importing a New Usage Plan
- To import a new .csv file of rates, go to Settings > Usage Rates.
- Click Add.
- Add a Description for the Plan and click Save.
- Select the Import Rates button.
- The importer page, when adding a new usage plan, will show Create New Version as the Plan Version.
5.b If the Plan Version drop-down is blank (doesn't display: "Create new Version") then the Plan Rate Versioning module will need to be activated.
To do so go to Admin > Settings > Enabled_Modules > Select "Plan Rate Versioning" in the drop down > click Add > click Save > log in/out of your Rev.io session to see the change.
- Set the Effective Date for when the rates will begin. The Effective Date allows for uploading rate decks for future use and also allows for version management of rate plans. A rate plan may also be added with a date from the past. All rate plans in Rev.io prior to the release of this feature (release date: 03/18/2016), are considered initial versions and remain in effect until a new version is uploaded to replace them. If backdating a file, any records that were not previously rated and are fairly recent calls (last 30 days or so) will be automatically reviewed each night. Files that were previously rated will require rerating. The Rev.io Client Success Manager will need to assist with this.
- Choose a pre-formatted file or select Download Template for the file format. Select the Upload button once the file is ready for import. Files that are not in the appropriate format will fail to upload. See the section titled Formatting a File Using the Rate Plan Template for tips.
- Select Post Valid Rates to complete this process. If this is a new rate plan, it is now ready for use based on the Effective Date set for the file. This Rate Plan can be used with a Usage Program or it can be added at an account level under the Special Rates link.
Importing a New Plan Version or Appending to a Plan Version on an Existing Rate Plan
- To import a New Plan Version to an existing Rate, go to Settings > Usage Rates.
- Click Edit next to the Rate Plan that requires editing.
- Select the Import Rates button.
- Select a plan version to append the rates to or click Create New Version to add a new file with a new effective date.
- If creating a new version, specify the Effective Date.
- Once the Effective Date has been specified, select Choose File and Upload.
- Once the file uploads a table of rates will appear at the bottom of the screen.
- Select Post Valid Rates and OK to confirm and complete the process.
- A message will appear at the top of the screen to confirm success.
- Start and End dates will be set on each table of rates depending on the effective dates. No end date will be specified on the file with the latest effective date until a new file is added with an effective date beyond the start of the previous file.
Formatting a File Using the Rate Plan Template
The Usage Rate template contains the fields in the table below. Each line item represents a rate for a specific type of call.
|Description||This is a description that defines the type of call this rate will apply. Some examples of descriptions used in Rev.io today are a country and city name like Alberta-Canada, a type of call like Outbound Interstate Traffic or an NPA NXX like 770-415.||Yes|
|Type 1||This field is used to tell Rev.io what type of call this rate will apply to. These types must match the Product Type exactly. Usage - LD - 800 - Intrastate or Usage - LD - International are examples of the data this field requires. Adding this information can be tricky due to the naming convention and spacing of this information. Each type begins with the word Usage. There is a space before and after each dash and the dashes are required. A full list of usage types can be found under Settings > Product Types. These must be copied exactly.||Yes|
|Type 2||This field is no longer used today but may still be in use with older Rev.io implementations.||No|
|Country||This field accepts the International Dialing Code that needs to match with the rate provided. For example, the International Dialing Code for the US is 1 and the International Dialing Code for Algeria is 213.||Yes|
|State||This field accepts the state or province code that needs to match with the rate provided. For example, Antigua has a country code of 1 and a State code of AN.||Varies|
|Area||This field accepts the area code or Telephone City Code that needs to match with the rate provided. Barcelona may have an entry in the Country field of 93 and then an entry in this field of 34. This number is the Telephone City Dialing Code.||Varies|
|Rate||This field stores the per minute rate for the specified call type.||Varies|
|Increment||This field is used to designate the incremental billing length of a call. Here is an example: 30/6: This indicates that there is a minimum billing call length of 30 seconds followed by 6 second increments. For example, a 15 second call will be billed at 30 seconds because it is within the 30 second minimum. A 43 second call will be billed at 48 seconds. A helpful way to view this would be 30+6+6+6. A second example might look like this: 60/60: This indicates that there is a minimum billing length of 60 seconds followed by 60 second increments. For example, a 3 second call will be billed at 1 minute. A 75 second call will be billed at 2 minutes.||Yes|
|Initial||This field is used to designate the minimum billing length of a call. In the first example above, the 30 represents the Initial and the 6 represents the Increment.||Yes|
|Line Type||If an Rev.io Line Type is specified, Rev.io can apply a specific rate by the line type associated with the call.||No|
|Direction||Specifies the direction of the call in relation to your customer. Each call has origination & termination aspects to it, but this is specifically categorizing a call based on who dials. For example, if your customer dials a number, the call will be considered OUTBOUND. If your customer dials an outside party, toll free number, local, international, etc, it will always be considered OUTBOUND. If your customer receives a call, it will be considered INBOUND. Calls from an outside party to your customer’s DID, toll free number, etc are considered INBOUND. Field accepts BOTH, INBOUND, and OUTBOUND as the call direction. The entry must be in CAPS in the file template.||Yes|
|LATA||This field is used to create a rates by Local Access and Transport Area (LATA).|
|OCN||This field can define a specific rate by Operating Company Number.||Varies|
|Tier||This field is no longer used today but may still be in use with older Rev.io implementations.||No|
|Zone||This is a field used to identify a rate for a specific zone in a local calling area.||Varies|
|Surcharge||This field is for adding a surcharge in lieu or in addition to the rate per minute charge. This field is typically used on Directory Assistance type calls.||Optional|
|Carrier Code||A field used for other rating needs. It looks at which carrier handled the call.||Varies|
This field is no longer used today but may still be in use with older Rev.io implementations.
|Source Type||This field is no longer used today but may still be in use with older Rev.io implementations.||No|
|Start Date||This field is set at the rate level when entered as an individual line item on the rate plan or it is set by the Effective Dates when added through the import. This field cannot be edited if controlled by the Plan Version.||No|
|End Date||This field is set at the rate level when entered as an individual line item on the rate plan or it is set by the Effective Dates when added through the import. This field cannot be edited if controlled by the Plan Version.||No|
|Buy Rate Flag||This field is no longer used today but may still be in use with older Rev.io implementations.||No|
Creating a Usage Program
- Usage Programs are a group of Usage Rates applied to a customer's line or service. To create a Usage Program, Go to Settings tab > Usage Program.
- Complete the Description field. This will be the description Rev.io users see in the dropdown list when selecting the rates to apply to the account. Long Description and PIC/LPIC are optional fields.
- Description - This is the name that will appear in the UI referencing this program.
- Long Description - This information is for internal use only and can be seen on this screen or available in a report from the table containing this data.
- PIC/LPIC/IPIC - Not typically used by today's Rev.io users. Formerly used when two separate carriers were delivering the local and long distant service.
- To add a plan to the program, select the Plan and click Add. Programs can contain as many Plans as needed to create a comprehensive rating tool for the customer's line. Type, Restrict Type and Line Type are all optional fields. The default settings for these fields are acceptable if not using them.
- Plan - Plans available for grouping in the Usage Program. These are configured under Settings > Usage Plans.
- Type - Retail is traditionally checked for the rates that apply to the customer. Wholesale can be checked if a secondary plan will be used to rate the call a second time and capture a cost that can be used in reporting and comparing against what the customer was actually charged.
- Restrict Type - This field is no longer used in Rev.io rating.
- Line Type - This field creates a restriction by Line Type and will only show this program as an available option if the Line Type is selected for the line being created.
- Click Save to complete the Program.
- Repeat Process until all plans have been added and then click Save.