Documentation
Product Version
States
  • Pending
    The version is pending and can be changed.
  • Active
    The product version is active.
  • Obsolete
    The version is obsolete. It cannot be subscribed any more.
  • Retiring
    The version is retiring; it cannot be subscribed and existing customers must migrate away from it.
  • Retired
    The version is retired and it has no existing subscriptions.
Properties
  • Activated On
  • Billing Cycle
    The billing cycle determines the rhythm with which the subscriber is billed. The charging may have different rhythm.
  • Comment
    The comment allows to provide a internal comment for the version. It helps to document why a product was changed. The comment is not disclosed to the subscriber.
  • Created On
  • Default Currency
    The default currency has to be used in all fees.
  • Enabled Currencies
    The currencies which are enabled can be selected to define component fees. Currencies which are not enabled cannot be used to define fees.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Increment Number
    The increment number represents the version number incremented whenever a new version is activated.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Minimal Number Of Periods
    The minimal number of periods determines how long the subscription has to run before the subscription can be terminated.
  • Name
    The product version name is the name of the product which is shown to the user for the version. When the visible product name should be changed for a particular product a new version has to be created which contains the new name of the product.
  • Number of Notice Periods
    The number of notice periods determines the number of periods which need to be paid between the request to terminate the subscription and the final period.
  • Obsoleted On
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Product
    Each product version is linked to a product.
  • Reference
    The product version reference helps to identify the version. The reference is generated out of the product reference.
  • Retiring Finished On
  • Retiring Started On
  • State
  • Tax calculation
    Strategy that is used for tax calculation in fees.
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.