Documentation
Documentation
Product Version
Close API 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
    The date and time when the product version was activated.
  • Billing Cycle
    The recurring period of time, typically monthly or annually, for which a subscriber is charged.
  • Billing Cycle Model
  • Comment
    A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
  • Created On
    The date and time when the product version was created.
  • Default Currency
    The three-letter code (ISO 4217 format) of the product version's default currency.
  • Enabled Currencies
    The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
  • ID
    A unique identifier for the object.
  • Increment Number
    Whenever a new version of a product is created, the number is increased and assigned.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Minimal Number Of Periods
    The minimum number of periods the subscription will run before it can be terminated.
  • Name
    The localized name of the product that is displayed to the customer.
  • Number Of Notice Periods
    The number of periods the subscription will keep running after its termination was requested.
  • Obsoleted On
    The date and time when the product version was made obsolete.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Product
    The product that the version belongs to.
  • Reference
    The reference used to identify the product version.
  • Retiring Finished On
    The date and time when the product version was retired.
  • Retiring Started On
    The date and time when the product version's retirement was started.
  • State
    The object's current state.
  • Tax Calculation
    The way taxes are calculated for fees.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
Preprod 2.185.11