Viewing billing reports and usage metrics

Tip: Billing reports are available for commercial accounts. See Choosing your account type for more information about the other benefits of commercial accounts and how to upgrade a free account to a commercial account.

If you have a commercial account, you can view billing and usage metrics for all teams in your account. Billing is based on active device or API calls, depending on the business model chosen by your account administrator. 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 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.
• Billing reports don't provide any management actions; you need to contact your system administrator or your tenants to resolve any issues.
• The billing information doesn't show monetary sums. It shows the usage that forms the basis for billing, not the bill itself.

Active devices

A device is active if it has connected to the server at least once 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.

You can view a list of active devices, sorted by:

• Account ID.
• Timestamp.
• Device ID.
• Endpoint name.

In Portal: viewing active devices

To view all active devices:

1. Go to Billing Reports > My billing in Device Management Portal.

2. Click the Download active devices report button.

   This downloads a gzipped .csv file to your local drive.

Using the API: viewing active devices

Firmware updates

You can view a list of firmware updates, sorted by:

• Account ID.
• Time stamp.
• Campaign name.
• Device ID.
• Endpoint name.

In Portal: viewing firmware updates

To view all firmware updates:

1. Go to Billing Reports > My billing in Device Management Portal.

2. Click the Download firmware report button.

   This downloads a gzipped .csv file to your local drive.

Using the API: viewing firmware updates

Service package history

A quota is the number of devices you can update, as set in your service package. You can't update more devices than your quota allows.

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 either:

• The tokens have run out. (For every device the account updates, a token is removed from the quota.)
• The package has expired (even if it still has tokens).

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

You can view the history of all service package quota usage for your commercial account, including:

• Time: The creation time of an update campaign reservation.
• Campaign name: The update campaign that consumed your quota.
• Type: Type of the campaign, continuous or one-shot.
• Amount: The amount of quota left.

In Portal: viewing service package history

To view all service package history:

1. Go to Billing Reports > Service package history in Device Management Portal.

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

2. (Optional) Filter the table by searching for a specific campaign or an event type.

Using the API: service package history

Usage metrics

You can view device management usage broken down by tenant.

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.

You can view data usage for:

• Device-to-service messages:
  • Registrations.
  • Registration updates, which keep registrations alive in the service.
  • Registration deletes, which unregister devices.
  • Observations, which are resource change events.
  • EST requests, which are requests for keys signed by the device.
  • Proxy responses, which are responses to requests to read, write or execute a resource from a device.
  • Bootstrap requests.
• Service-to-device message:
  • Proxy requests, which are requests to read, write or execute resources from a device.
  • Subscriptions (of resources), which happen when devices register and match presubscription rules.
• Edge premium services:
  • Tunneling to and from the device.
  • Terminal sessions to and from the device.
  • Logging from the device.

In Portal: viewing usage metrics

To view all usage metrics:

1. Go to Billing Reports > My billing in Device Management Portal.

2. Click the Usage report (online with CSV download) button.

3. Click the download icon in the top right corner.

   This downloads a .csv file to your local drive.

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

To view usage metrics for a specific tenant:

1. Go to Billing Reports > My billing in Device Management Portal.

2. Click the Usage report (online with CSV download) button.

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

3. (Optional) Filter the table by searching for specific tenants. By default, the report shows all tenants for the reported period.

4. 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: Tenant account information.
   • Billing details: Service package and usage information. This is the same information you can see in the 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.

Using the API: viewing usage metrics