Represents the state of a subscriber and what emails they
should or should not be receiving. This type is meant to be fully expressive
so as to consolidate the logic of determining what emails a subscriber should
receive into a single place.
Note that the only types that can be set programmatically are REGULAR, UNSUBSCRIBED,
GIFTED and UNPAID. All other types are meant to be user-visible and cannot
be set programmatically.
Regular
Type
regular
Description
Normal subscribers who have not unsubscribed or deactivated in any way.
Premium
Type
premium
Description
Subscribers with active premium subscriptions.
Trialed
Type
trialed
Description
Subscribers that are temporarily receiving a premium subscription to your newsletter.
Unpaid
Type
unpaid
Description
Subscribers who have not yet purchased a subscription to your newsletter.
Gifted
Type
gifted
Description
Subscribers that have been gifted free premium subscriptions.
Churning
Type
churning
Description
Subscribers who have elected to not renew their subscription to your newsletter and will become unpaid subscribers at the end of their current billing period.
Unactivated
Type
unactivated
Description
Subscribers who have not yet confirmed their email or opted in.
Paused
Type
paused
Description
Subscribers that are on a temporary hold from their premium subscription, but are still subscribed to your newsletter.
Unsubscribed
Type
unsubscribed
Description
Subscribers that have or have been unsubscribed from your newsletter.
Spammy
Type
spammy
Description
Subscribers that have been deemed spammy by Buttondown's automated systems.
Undeliverable
Type
undeliverable
Description
Subscribers who have been unable to receive their email.
Complained
Type
complained
Description
Subscribers that have registered a complaint with their email provider. Buttondown will not try to send them any future emails; no action is required on your part.
Type
malformed
Description
Subscribers whose email appears to be invalid.
Removed
Type
removed
Description
Subscribers who have been explicitly removed by the newsletter (notably, this does not mean unsubscribers: use /v1/unsubscribers for that!)
Disabled
Type
disabled
Description
Subscribers who have been disabled by the newsletter.
Disposable
Type
disposable
Description
Subscribers who have been deemed disposable by Buttondown's automated systems.
Past due
Type
past_due
Description
Subscribers who technically have active paid subscriptions, but have not paid their invoices in time.
Churned
Type
churned
Description
Subscribers which were previously premium subscribers, but have since churned but are not unsubscribed.
Referenced by
Creating a subscriberTypes of automation filtersCFBLHow to send a teaser