Documentation
Documentation
    • English (United States)
Account
Close API Documentation
Account
States
  • Create
    The account is in creation.
  • Restricted Active
    The account is active however no payment information has been provided.
  • Active
    The account is active.
  • Inactive
    The account is not active.
  • Deleting
    The deleting state indicates that the account is in the process to be deleted.
  • Deleted
    The account has been deleted.
Properties
  • Active
    Active means that this account and all accounts in the hierarchy are active.
  • Active Or Restricted Active
    This property is true when all accounts in the hierarchy are active or restricted active.
  • Created By
    The ID of the user who created this entity.
  • Created On
    The date and time when this entity was created.
  • Deleted By
    The ID of a user that deleted this entity.
  • Deleted On
    The date and time when this entity was deleted.
  • ID
    A unique identifier for the object.
  • Last Modified Date
    The date and time when the object was last modified.
  • Name
    The name of the account identifies the account within the administrative interface.
  • Parent Account
    The account which is responsible for administering the account.
  • 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.
  • Restricted Active
    Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.
  • Scope
    This is the scope to which the account belongs to.
  • State
    The object's current state.
  • Subaccount Limit
    This property restricts the number of subaccounts which can be created within this account.
  • Type
    The account type defines which role and capabilities it has.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.