Meta tags:
description= Info In previous versions of the API, another endpoint existed to retrieve a subscription by the subscriber ID.;

Headings (most frequently used words):

subscription, by, id, oauth, scope, subscriptions, parameters, get, read, authentication, path, query, response, errors, update, write,

Text of the page (most frequently used words):
badge (202), intent (101), minimal (101), outlined (101), oauth (91), scope (90), info (90), #subscription (67), read (49), #subscriptions (47), list (43), write (40), get (36), the (30), update (21), newsletter (19), create (14), warning (14), beta (14), newsletter_lists (13), returns (12), publications (12), post (11), posts (11), array (10), data (10), email (10), api (10), tiers (9), custom (9), custom_fields (9), 0000 (9), webhooks (9), segment (8), token (8), tier (8), segments (8), this (7), field (7), delete (7), automations (7), that (6), tags (6), endpoint (6), automation (6), with (5), set (5), status (5), publication (5), error (5), polls (5), and (4), have (4), been (4), prefixed (4), stats (4), retrieve (4), exporting (4), page (4), object (4), bearer (4), identify (4), webhook (4), deletion (4), optional (3), values (3), ids (3), subscribed (3), referrals (3), previous (3), subscriber (3), version (3), found (3), request (3), subscriptionid (3), publicationid (3), https (3), com (3), 000000000000 (3), beehiiv (3), data_deletion (3), condition (3), complimentary (3), access (3), bulk (3), resumed (3), paused (3), for (3), expandable (2), objects (2), associated (2), limited (2), these (2), are (2), were (2), referred (2), statistics (2), about (2), actively (2), subscription_premium_tiers (2), single (2), belonging (2), specific (2), versions (2), another (2), existed (2), now (2), deprecated (2), will (2), removed (2), future (2), please (2), use (2), instead (2), can (2), either (2), via (2), csv (2), settings (2), export (2), requests (2), response (2), parameters (2), format (2), required (2), string (2), authentication (2), authorization (2), referral_code (2), utm_campaign (2), created (2), sub_00000000 (2), curl (2), reference (2), demo (2), start (2), trial (2), login (2), add (2), referral (2), program (2), templates (2), poll (2), lists (2), engagements (2), fields (2), condition_sets (2), sets (2), complimentary_access (2), updates (2), journeys (2), authors (2), advertisement (2), opportunities (2), oauth2 (2), survey (2), deleted (2), code (2), integrations (2), rate (2), limiting (2), pagination (2), key (2), getting (2), started (2), put (2), search (2), documentation (2), index (2), level (2), llms (2), txt (2), any (2), built, next, yes, was, helpful, internal, server, 500, too, many, 429, not, 404, unauthorized, 401, bad, 400, errors, allowed, enum, expand, query, sub_, pub_, path, form, where, your, auth, www, blog, referring_site, utm_content, utm_term, website, utm_channel, organic, utm_medium, twitter, utm_source, gold, premium, subscription_premium_tier_names, free, subscription_tier, 1666800076, validating, protected, retrieved, 200, try, pub_00000000, copy, light, workspace, tag, subscribers, recalculate, referral_program, send, test, aggregate, responses, user, emails, journey, author, introspect, revoke, authorize, submitted, added, downgraded, upgraded, confirmed, scheduled, updated, sent, unsubscribed, workspaces, del, patch, users, tokens, authorizations, welcome, ask, agents, available, root, append, url, markdown, developer,

Text of the page (random words):
get subscription by id oauth scope subscriptions read beehiiv developer documentation for ai agents a documentation index is available at the root level at llms txt append llms txt to any url for a page level index or md for the markdown version of any page search ask ai login start trial get a demo search welcome getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription post subscription survey oauth2 authorizations tokens api reference advertisement opportunities authors automation journeys automations bulk subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post templates publications referral program segments subscriptions post create subscription badge intent info minimal outlined oauth scope subscriptions write badge get list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge put update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge patch update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge put update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge del delete subscription badge intent info minimal outlined oauth scope subscriptions write badge subscription tags tiers webhooks workspaces getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription subscribed badge intent warning minimal outlined beta badge newsletter list subscription unsubscribed badge intent warning minimal outlined beta badge newsletter list subscription paused badge intent warning minimal outlined beta badge newsletter list subscription resumed badge intent warning minimal outlined beta badge post sent post updated post scheduled subscription created subscription confirmed subscription deleted subscription upgraded subscription downgraded subscription paused subscription resumed subscription tier paused subscription tier resumed subscription tier added subscription tier deleted survey response submitted oauth2 authorize create token revoke token introspect token get token info get advertisement opportunities badge intent info minimal outlined oauth scope posts read badge list authors get author add subscription to an automation badge intent info minimal outlined oauth scope automations write badge list automation journeys badge intent info minimal outlined oauth scope automations read badge get automation journey badge intent info minimal outlined oauth scope automations read badge list automations badge intent info minimal outlined oauth scope automations read badge get automation badge intent info minimal outlined oauth scope automations read badge list automation emails bulk create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscription updates badge intent info minimal outlined oauth scope subscriptions read badge get subscription update badge intent info minimal outlined oauth scope subscriptions read badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge list complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge get complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge list condition sets badge intent info minimal outlined oauth scope condition_sets read badge get condition set badge intent info minimal outlined oauth scope condition_sets read badge create custom field badge intent info minimal outlined oauth scope custom_fields write badge get custom field badge intent info minimal outlined oauth scope custom_fields read badge list custom fields badge intent info minimal outlined oauth scope custom_fields read badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge delete custom field badge intent info minimal outlined oauth scope custom_fields write badge create data deletion request badge intent info minimal outlined oauth scope data_deletion write badge get data deletion request badge intent info minimal outlined oauth scope data_deletion read badge list data deletion requests badge intent info minimal outlined oauth scope data_deletion read badge get publication engagements badge intent info minimal outlined oauth scope publications read badge list newsletter lists badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge create newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge delete newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge create newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge list newsletter list subscriptions badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge update newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list subscription by subscription id badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge identify user badge intent info minimal outlined oauth scope identify read badge list polls badge intent info minimal outlined oauth scope polls read badge get poll badge intent info minimal outlined oauth scope polls read badge list poll responses badge intent info minimal outlined oauth scope polls read badge create post badge intent info minimal outlined oauth scope posts write badge update post badge intent info minimal outlined oauth scope posts write badge list posts badge intent info minimal outlined oauth scope posts read badge get aggregate stats badge intent info minimal outlined oauth scope posts read badge get post badge intent info minimal outlined oauth scope posts read badge delete post badge intent info minimal outlined oauth scope posts write badge send test email badge intent info minimal outlined oauth scope posts badge get post templates badge intent info minimal outlined oauth scope posts read badge list publications badge intent info minimal outlined oauth scope publications read badge get publication badge intent info minimal outlined oauth scope publications read badge get referral program badge intent info minimal outlined oauth scope referral_program read badge create segment list segments badge intent info minimal outlined oauth scope segments read badge get segment badge intent info minimal outlined oauth scope segments read badge recalculate segment badge intent info minimal outlined oauth scope segments write badge list segment subscribers badge intent info minimal outlined oauth scope segments read badge list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge delete segment badge intent info minimal outlined oauth scope segments write badge create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge delete subscription badge intent info minimal outlined oauth scope subscriptions write badge add subscription tag badge intent info minimal outlined oauth scope subscriptions write badge create a tier badge intent info minimal outlined oauth scope tiers write badge list tiers badge intent info minimal outlined oauth scope tiers read badge get tier badge intent info minimal outlined oauth scope tiers read badge update a tier badge intent info minimal outlined oauth scope tiers write badge update a tier badge intent info minimal outlined oauth scope tiers write badge create a webhook badge intent info minimal outlined oauth scope webhooks write badge list webhooks badge intent info minimal outlined oauth scope webhooks read badge get webhook badge intent info minimal outlined oauth scope webhooks read badge update webhook badge intent info minimal outlined oauth scope webhooks write badge delete a webhook badge intent info minimal outlined oauth scope webhooks write badge identify workspace badge intent info minimal outlined oauth scope identify read badge get publications by subscription email badge intent info minimal outlined oauth scope publications read badge login start trial get a demo light api reference subscriptions get subscription by id oauth scope subscriptions read copy page get https api beehiiv com v2 publications publicationid subscriptions subscriptionid get v2 publications publicationid subscriptions subscriptionid curl curl https api beehiiv com v2 publications pub_00000000 0000 0000 0000 000000000000 subscriptions sub_00000000 0000 0000 0000 000000000000 h authorization bearer token try it 200 retrieved 1 2 data 3 id sub_00000000 0000 0000 0000 000000000000 4 email email protected 5 status validating 6 created 1666800076 7 subscription_tier free 8 subscription_premium_tier_names 9 premium 10 gold 11 12 utm_source twitter 13 utm_medium organic 14 utm_channel website 15 utm_campaign utm_campaign 16 utm_term 17 utm_content 18 referring_site https www blog com 19 referral_code referral_code 20 21 info in previous versions of the api another endpoint existed to retrieve a subscription by the subscriber id this endpoint is now deprecated and will be removed in a future version of the api please use this endpoint instead the subscription id can be found by exporting a list of subscriptions either via the settings publications export data or by exporting a csv in a segment info retrieve a single subscription belonging to a specific publication authentication authorization bearer bearer authentication of the form bearer token where token is your auth token path parameters publicationid string required format pub_ 0 9a fa f the prefixed id of the publication object subscriptionid string required format sub_ 0 9a fa f the prefixed id of the subscription object query parameters expand enum optional optional list of expandable objects br subscription_premium_tiers returns an array of tiers the subscription is associated with br referrals returns an array of subscriptions with limited data id email and status these are the subscriptions that were referred by this subscription br stats returns statistics about the subscription s br custom_fields returns an array of custom field values that have been set on the subscription br tags returns an array of tags that have been set on the subscription br newsletter_lists returns an array of newsletter list prefixed ids the subscription is actively subscribed to allowed values stats custom_fields referrals tags newsletter_lists response ok data object the subscription object errors 400 bad request error 401 unauthorized error 404 not found error 429 too many requests error 500 internal server error was this page helpful yes no previous update subscription by id oauth scope subscriptions write next built with in previous versions of the api another endpoint existed to retrieve a subscription by the subscriber id this endpoint is now deprecated and will be removed in a future version of the api please use this endpoint instead the subscription id can be found by exporting a list of subscriptions either via the settings publications export data or by exporting a csv in a segment retrieve a single subscription belonging to a specific publication 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