Skip to main content

API v2 - Explanation for some parameters in offering items and usages

Posts: 5
Comments: 1

There are a few parameters in the offering item and usage entities for which I'd like an explanation:

  • In offering item:
    • locked: purpose of this parameter and how to use it (can I change it with the api, etc).
  • In usage:
    • value and absolute_value: what's the difference between them, and which one holds the real usage value.
    • range_start: purpose of this date and how to use it (can I change it with the api, etc).

Besides, I'd like to know how often the usages are updated, to take that time into account when testing.

Acronis Program Manager
Posts: 7
Comments: 163

Hi Eduardo,


Sure, I'll be glad to explain.

Locked property

Most offering items can be enabled or disabled separately from the application within which they exist. However, some applications should always have some offering items enabled, and their status (on/off) should not be changed.

Say, you can enable or disable Websites within Backup and Disaster Recover ("locked": false). But you cannot separately disable Sync & Share Cloud storage or users ("locked": true).

It's a property, it cannot be modified.



Most offering items always have absolute values that change with time, but do not depend on period when it was measured. For these offering items absolute value is always equal to value.

One offering item (compute_points) is, in opposite, cumulative, and should be released at each billing cycle. This offering item is available only for DR service.

So, for compute_points the starting point is the 1st day of the month (a default billing date), and the fields would show:

"range_start" >> date when "value" is set to 0

"absolute_value" >> cumulative value of all times since offering item was enabled

"value" >> cumulative value since "range_start"


Different usages are updated at different times. Some (protected devices) - within seconds, some (cloud storage) - within up to ~6 hours (depending on the datacenter you are working with). This behavior is valid for current version of the platform and may change in future.