Get subscription by email
get_subscription_by_emailLook up a Beehiiv subscription using a publication ID and email address, returning subscriber status, stats, tags, custom fields, or referrals as needed.
Instructions
Get subscription by email. Reads account data. OAuth integrations require subscriptions:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | The ID of the subscriber object | ||
| expand | No | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with. `referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription. `stats` - Returns statistics about the subscription(s). `custom_fields` - Returns an array of custom field values that have been set on the subscription. `tags` - Returns an array of tags that have been set on the subscription. `newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| publication_id | Yes | The prefixed ID of the publication object |