Subscribers are the main way you collect email addresses and recipients on Buttondown. They're what you see on your subscribers page.
Relevant changes to the schema:
subscriber_type and email to type and email_address respectively.external_url in favor of absolute_url.A unique TypeID associated with the object.
The date and time at which the object was first created.
URL of the subscriber's avatar image (e.g. a Gravatar URL), if available.
The date of the subscriber's most recent bounce event. May be set even if the subscriber has not yet been marked as undeliverable.
The reason of the subscriber's most recent bounce event. May be set even if the subscriber has not yet been marked as undeliverable.
When the subscriber cancelled their paid subscription, if applicable.
Whether this subscriber is prevented from commenting.
The email address of the subscriber.
When the subscriber's gift subscription expires, if applicable.
A custom message that was sent to the subscriber when the gift subscription was created.
The IP address recorded when the subscriber signed up, if available.
When the subscriber most recently clicked a link in an email.
When the subscriber most recently opened an email.
The subscriber's delivered count.
The subscriber's open count.
The subscriber's clicked count.
The subscriber's open rate, computed from engagement counts. Null if delivered_count is 0 or null.
The subscriber's click rate, computed from engagement counts. Null if delivered_count is 0 or null.
A structured key-value blob that you can use to store arbitrary data on the object. Metadata can be nested — you can store objects and arrays within your metadata. (You can read more about metadata.)
Any notes you want to attach to the subscriber. These are not publicly visible.
The email address of the individual who purchased this subscription on behalf of the subscriber.
A custom message that was sent to the subscriber when the subscription was purchased on behalf of the subscriber.
The subscriber's unique referral code, used to attribute referred signups.
The URL the subscriber was referred from (e.g. where they submitted the subscription form).
The risk score of the subscriber. Positive numbers represent a higher risk; negative numbers represent a lower risk.
A human-readable sequential identifier, unique within the newsletter.
The Stripe coupon applied to the subscriber's paid subscription, if any.
The Stripe customer ID associated with the subscriber, if any.
The ID of the subscriber import that created this subscriber, if any.
A list of tag names applied to the subscriber. Tags that don't already exist will be created.
The history of subscriber type transitions (e.g. regular → premium).
The history of email address changes for this subscriber.
The ID of the registration form the subscriber signed up through, if any.
Information collected by Buttondown's firewall about this subscriber. See the firewall for more information.
The subscriber's lifecycle state — e.g. regular (active), premium (paid), unactivated (pending confirmation), unsubscribed, removed.
When the subscriber was marked as undeliverable, if applicable.
The reason the subscriber is undeliverable. (Only populated for undeliverable subscribers.)
When the subscriber unsubscribed, if applicable.
Free-text reason the subscriber unsubscribed, if provided.
When the subscriber upgraded to a paid subscription, if applicable.
The UTM campaign the subscriber was attributed to at signup.
The UTM medium the subscriber was attributed to at signup.
The UTM source the subscriber was attributed to at signup.