Documentation
Documentation
    • English (United States)
Charge Flow Level Configuration
Close API Documentation
Charge Flow Level Configuration

A flow level configuration is a single step of the charge flow.

To determine the next level configuration the following steps are taken:

  • The priority of the current level configuration is selected.

  • All level configuration of a particular flow are sorted ascending.

  • We choose the level configuration with the next higher priority as the one of the current level configuration. In case there is no such level configuration the transaction is considered as Failed.

States
  • Create
    The create state indicates that the Charge Flow Level Configuration is in creation.
  • Active
    The active state indicates that the Charge Flow Level Configuration is active and may be used.
  • Inactive
    The inactive state indicates that the Charge Flow Level Configuration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Charge Flow Level Configuration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Charge Flow
    The charge flow level configuration to which the flow is associated.
  • Configuration Name
    The charge flow level configuration name is used internally to identify the charge flow level configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Period
    The duration of the level before switching to the next one.
  • 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.
  • Priority
    The priority indicates the sort order of the level configurations. A low value indicates that the level configuration is executed before any level with a higher value. Any change to this value affects future level configuration selections.
  • State
    The object's current state.
  • Type
    The type determines how the payment link is delivered to the customer. Once the type is defined it cannot be changed anymore.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.