Managing billing in Portal

Users of commercial accounts can review their quota use, active devices and use by API calls for their own team and all their tenants. Billing is based either on active devices or API calls.

• A service package creates a quota of firmware update tokens and is valid for 12 months. Commercial accounts can only perform firmware updates if they have a valid service package with enough tokens. Updates are disabled for an account if the tokens have run out (for every device the account updates, a token is removed from the quota) or if the package has expired (even if it still has tokens).
• A quota is the number of devices you can update, as set in your service package. You cannot update more devices than your quota allows.
• A device is active if it has connected to the server one or more times during the month. Only one connection event is counted for a device in a single month, even if the device connected multiple times during that month. There is no limit on how many active devices you can have.
• If the billing is based on the API calls, notifications and incoming and outgoing device messages are counted in addition to the API calls.

Note: Your tenants use your firmware update quotas, and you are billed for their connected devices.

Note that:

• Billing reports for the previous month are generated automatically during the third business day of the current month (business days are always Monday to Friday, irrespective of local variations and holidays). The reports are usually available by 02:00 AM UTC.
• The Billing report pages do not provide any management actions; you need to contact your system administrator or your tenants to resolve any issues.
• The billing information does not show monetary sums. It shows the usage that forms the basis for billing, not the bill itself.

Tip: You can view billing information with the Billing API.

My billing

To see your billing report, go to Billing reports > My billing.

The My billing page gives a complete overview of a billing period (a calendar month) for your team and all your tenants. If you need to see information for a particular tenant, please use the Usage report page.

By default, the report shows the previous month. To see information for a different month, select a month to view. The page is fully updated, including the number of tenants and the service package.

General information

The page shows:

Account snapshot (LIVE)

This information is for the current account only. It does not include tenant information.

• Devices: The number of devices active on the billing period. (The view directory link takes you to the Devices page that lists the active devices.)
• Transactions: The number of transactions during the past 30 days.
• Tenants: If you have tenants on your account, the number of tenants. (The view tenants link takes you to the Usage report page that lists all tenants.)

Service package

• Remaining quota: The number of remaining updates available. (The view history link takes you to the Service package history page that lists the events that consumed your quota.)
• Expires: The expiration date of your service package.

There will be a warning text about the expiry three months before the expiration date.

Aggregated monthly usage - period ending Month Year

• Business model: The business model selected (by your account administrator) for the account. Either Active devices or API calls.
• Active devices: The number of active devices on the account.
• Firmware updates: The number of firmware updates performed on the account.

If the business model is API calls, you will also see the summary of the API usage:

• Device to service API calls: The total number of API calls to services on the account, followed by detailed events.
• Service to device API calls: The total number of API calls to devices on the account, followed by detailed events.
• Integration API calls: The total number of other API calls on the account, followed by detailed events.

Detailed reports for the selected period

Links to three types of reports:

• Active devices report (downloads a gzipped .cvs file to your local drive). The report contains the following information about the active devices:
  • Account ID.
  • Timestamp.
  • Device ID.
  • Endpoint name.
• Firmware updates report (dowloads a gzipped .cvs file to your local drive). The report contains the following information about the firmware updates:
  • Account ID.
  • Timestamp.
  • Campaign name.
  • Device ID.
  • Endpoint name.
• Usage report takes you to the Usage reports page.

Service package history

This page shows you the history of the service package usage. It lists the update events and their effect on the quota. It also shows when a service package is renewed. The event types are:

• Reservation: Quota was reserved for an update campaign.
• Reservation release: Unused quota from an update campaign was returned to the quota.
• Reservation termination: A service package expired, so an update campaign was terminated. You cannot use the unused quota because it is still part of the expired service package.
• Package creation: A new service package and its quota.
• Package renewal: A service package was renewed before it expired.
• Package termination: A service package expired. You cannot use any unused quota because it is still part of the expired service package.

By default, the list shows the previous month. To see information for a different month, select a month above the table.

You can filter the table by searching for a specific campaign or an event type.

To export the table information as a .csv file, click the Download button. Any filters you apply to the table also apply to the report.

Usage reports

The Usage reports page shows your billing information broken down by tenant. The page lists the logged in aggregator account and any tenants.

Note: A tenant appears in a month’s report if its aggregator had a service package that month, even if it didn’t use its quota or connect devices that month.

To see tenant use:

1. Go to Billing reports > Usage reports.

   By default, the report shows the previous month. To see information for a different month:

   • Select a month to view.
   • The page is fully updated, including the number of tenants and the service package.

   By default, the report shows all tenants for the reported period. To view specific tenants, search by team name or organization.

2. To see more information for a tenant, click the tenant’s team name in the list.

   The Tenant usage pane opens. It has four tabs:

   • Summary: Basic tenant account information.
   • Billing details: Service package and usage information. This is the same information you can see in My billing page.
   • Quota history: Update events and their effect on the quota (as explained in Service package history).
   • Attributes: Full tenant account information, as returned by the API.

To export the listed tenant information as a .csv file, click the Download button.

Note: Any filters you apply to the table also apply to the report.