Documentation
Documentation
    • English (United States)
Subscriber
Close API 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
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • ID
    A unique identifier for the object.
  • 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 ID of the space this object belongs to.
  • Meta Data
    Meta data allow to store additional data along the object.
  • 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.
  • Reference
    The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
  • Shipping Address
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.