Usage API manages:

• Usage resource
• Usage specification resource

Main attributes of usage are:

• Id: Usage unique identifier
• Date: Date of usage
• Type: Type of usage
• Description: Description of usage
• Usage Specification: A detailed description of a usage event that are of billing system's interest and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage
• Usage Specification Characteristic: A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values
• Status: Status of usage
• Related Party: Party linked to this usage with its role and reference
• Rated product Usage: Describes the characteristics of rated usage
  • Rating Date: Date of usage rating
  • Usage Rating TagTBD
  • Is Billed: Boolean indicating if usage have been billed or not
  • Rating Amount Type: Type of amount
  • Tax Included Rating Amount: All taxes included rated amount
  • Tax Excluded Rating Amount: All taxes excluded rated amount
  • Tax Rate: Tax rate
  • Is Tax Exempt: Indicates if the rated amount is exempt of tax
  • Offer Tariff Type: Type of tariff applied
  • Bucket Value Converted In Amount: Monetary value of bucket
  • Currency Code: A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)
  • Product Ref: Reference of product specification

Main attributes of usage specification are:

• Id : Usage specification unique identifier
• Name: The name of the usage specification.
• Description: A narrative that explains in detail what the product specification is.
• Valid For: Extension to manage start Date and end Date of usage Specification
• Usage Spec Characteristic: A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values
  • Name: The name of the usage characteristic.
  • Description: A narrative that explains the usage characteristic.
  • ConfigurableBoolean indicating if usage Spec Characteristic is configurable or not
  • Usage Spec Characteristic Value: A value that can be assigned to a Usage Spec Characteristic.
    • Value Type: A kind of value that the characteristic can take on, such as numeric, text, and so forth.
    • Default: Indicates if the value is the default value for a characteristic
    • Value: A discrete value that the characteristic can take on.
    • Value From: The low range value that a characteristic can take on
    • Value To: The upper range value that a characteristic can take on.