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
Allow the subscriber to use these payment methods even if subscription products do not accept them.
Billing Address
The address associated with the subscriber for invoicing and transaction processing purposes.
Description
The description used to identify the subscriber.
Disallowed Payment Methods
Prevent the subscriber from using these payment methods even if subscription products do accept them.
Email Address
The email address that 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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
ID
A unique identifier for the object.
Language
The language that is used when communicating with the subscriber via emails and documents.
Linked Space ID
The ID of the space this object belongs to.
Meta Data
Allow to store additional information about 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 merchant's reference used to identify the subscriber.
Shipping Address
The address to where orders will be shipped.
State
The object's current state.
Version
The version is used for optimistic locking and incremented whenever the object is updated.