Documentation
Subscriber

A subscriber represents everyone who is subscribed to a product.

States
  • Create
    The create state indicates that the Subscriber is in creation.
  • Active
    The active state indicates that the Subscriber is active and may be used.
  • Inactive
    The inactive state indicates that the Subscriber is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Subscriber is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Additional Allowed Payment Methods
    Those payment methods which are allowed additionally will be available even when the product does not allow those methods.
  • Billing Address
  • Description
    The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.
  • Disallowed Payment Methods
    Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.
  • Email Address
    The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
  • External ID
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Language
    The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Meta Data
    Meta data allow to store additional data along the object.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Reference
    The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
  • Shipping Address
  • State
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.