Documentation
Documentation
Suspension
Close
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
    The date and time when the suspension ended.
  • End Action
    Whether the subscription should be terminated or reactivated after the suspension has reached its 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
    A note that contains details about the suspension. It is not disclosed to the subscriber.
  • Period Bill
    The period bill that led to the suspension of the subscription.
  • Planned End Date
    The date and time when the suspension is planned to end.
  • 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 reason why the subscription was suspended.
  • State
    The object's current state.
  • Subscription
    The subscription that this suspension belongs to.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.