Documentation
Suspension
States
  • Running
    The subscription is currently suspended.
  • Ended
    The suspension is not active anymore.
Properties
  • Created On
    The date and time when the object was created.
  • Effective End Date
  • End Action
    When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.
  • ID
    A unique identifier for the object.
  • Language
    The language that is linked to the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Note
    The note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.
  • Period Bill
  • Planned End Date
    The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
  • 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.
  • Reason
    The suspension reason indicates why a suspension has been created.
  • State
    The object's current state.
  • Subscription
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.