Buttondown Documentation
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.
Normal subscribers who have not unsubscribed or deactivated in any way.
Subscribers with active premium subscriptions.
Subscribers that are temporarily receiving a premium subscription to your newsletter.
Subscribers who have not yet purchased a subscription to your newsletter.
Subscribers that have been gifted free premium subscriptions.
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.
Subscribers who have not yet confirmed their email or opted in.
Subscribers that are on a temporary hold from their premium subscription, but are still subscribed to your newsletter.
Subscribers that have voluntarily unsubscribed from your newsletter.
Subscribers that have been deemed spammy by Buttondown's automated systems.
Subscribers that have registered a complaint with their email provider.
Subscribers whose email appears to be invalid.
Subscribers who have been explicitly removed by the newsletter (notably, this does not mean unsubscribers: use /v1/unsubscribers for that!)
Subscribers who have been disabled by the newsletter.
Subscribers who have been deemed disposable by Buttondown's automated systems.
Subscribers who technically have active paid subscriptions, but have not paid their invoices in time.
Subscribers which were previously premium subscribers, but have since churned but are not unsubscribed.