Usage Guide

You can add usage through the API, a CSV file, or manually. The sections below explain how usage rating works and how usage can be imported or entered in the interface.

Usage Rating

Usage rating defines how imported quantities are calculated for billing. The rating is set on the charge and applied per price period. 

Note: Usage charges are always invoiced in arrears, and the price period for usage can never be longer than the billing period.

Usage rating types include:

  • SUM. All imported usage quantities within the price period are added together.

  • AVERAGE. The average of all imported quantities within the price period is calculated.

  • MAX. Only the highest imported quantity within the price period is used.

Example: If several usage entries exist for the same price period and the usage rating is MAX, only the highest quantity is invoiced. The quantities are not summed.

Importing Usage with a CSV File

Preparing the file

Use the import template attached at the end of the article. Create one file that contains all usage for the period.

The file must include:

  • Usage key. A unique key that determines where the usage will be mapped.

  • Quantity. The amount of usage.

  • From date. The date the usage occurred, or the first day of the usage period, for example 2019-07-01 for July 2019.

  • Unit code. The unit of the usage quantity, for example hours. The value must match the unit of measure on the order charge.

Importing the file

Go to Usage
Select Import
Choose File and upload your CSV

Select the key you will use to map the usage.

  • Account key

  • Order key

  • Product key

  • Charge key

You can use one or multiple keys. For example, account name as Account key, order number as Order key, and charge number as Charge key.

Verify that all fields are mapped correctly. Each header in the CSV must match a corresponding field in Younium. For example, the column header UsageKey must be mapped to the usage key field.

Select Import Data to complete the import.

Error file

If the import contains errors, Younium generates an error file. This file includes only the rows that failed. You can continue with the successfully processed rows, correct the errors in the file, and reimport the error file.

Adding Usage Manually

Go to Usage
Select Add New Usage

Assign the usage to the correct charge by selecting:

  • Account

  • Order

  • Product

  • Charge

Then enter the usage details:

  • From date. The date the usage was produced. For monthly usage, the first day of the month is recommended, for example 2020-01-01 for January 2020.

  • Quantity. The amount used.

  • Unit of measure. What the usage is measured in.

Fields required only for rated usage:

  • Unit price currency

  • Unit price

  • Description

Save the usage entry when all fields are completed.

 

Delete Usage

You can delete usage that has not yet been processed. Usage can be removed one entry at a time by selecting the bin icon on each row. You can also delete usage in groups by selecting the checkboxes for the entries you want to remove.

When deleting usage in groups, you are taken to a page that shows which entries can be deleted and which cannot. The page also explains the reason when an entry cannot be removed. For example, “It is not possible to delete usage that has already been processed”.