beehiiv

beehiiv Subscriptions API

The Subscriptions API from beehiiv — 3 operation(s) for subscriptions.

Documentation GitHub OpenAPI

Business capability

Subscription & Entitlement Management BC-3750.20

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /publications/{publicationId}/subscriptions Subscribe a new reader · Create subscription OAuth Scope: subscriptions:write #

Ask an LLM

“How do I add a new subscriber to my newsletter from my signup form?”

“Can I skip the welcome email when adding a subscriber?”

Tell an agent

Subscribe {email} to publication {publication}.

Add new subscriber {email} with UTM source {utm_source}.

GET /publications/{publicationId}/subscriptions List a publication's subscribers · List subscriptions OAuth Scope: subscriptions:read #

Ask an LLM

“Who subscribes to my newsletter?”

“Can I list only premium subscribers or only active ones?”

Tell an agent

List subscriptions on publication {publication}.

Show {status} subscribers on {publication}.

GET /publications/{publicationId}/subscriptions/by_email/{email} Look up a subscriber by email · Get subscription by email OAuth Scope: subscriptions:read #

Ask an LLM

“Is a given email address subscribed to my newsletter?”

“Do I need to URL-encode the email when looking up a subscriber?”

Tell an agent

Look up the subscription for {email} on publication {publication}.

Check whether {email} is subscribed, including {expand}.

PUT /publications/{publicationId}/subscriptions/by_email/{email} Update a subscriber found by email · Update subscription by email OAuth Scope: subscriptions:write #

Ask an LLM

“How do I change a subscriber's tier when I only know their email?”

“Can I unsubscribe someone by their email address?”

Tell an agent

Update the subscriber with email {email} on {publication} to tier {tier}.

Unsubscribe the reader whose email is {email}.

GET /publications/{publicationId}/subscriptions/{subscriptionId} Get a subscriber by subscription ID · Get subscription by ID OAuth Scope: subscriptions:read #

Ask an LLM

“Can I fetch one subscriber's details by their subscription ID?”

“What replaced the old lookup by subscriber ID?”

Tell an agent

Get subscription {subscription} on publication {publication}.

Show subscriber {subscription} with {expand} expanded.

PUT /publications/{publicationId}/subscriptions/{subscriptionId} Update a subscriber by ID (PUT) · Update subscription by ID OAuth Scope: subscriptions:write #

Ask an LLM

“How do I PUT changes to a subscriber's tier or custom fields by subscription ID?”

“Can I use PUT to unsubscribe a subscriber by ID?”

Tell an agent

PUT tier {tier} on subscription {subscription} in publication {publication}.

Unsubscribe subscription {subscription} using the PUT update.

PATCH /publications/{publicationId}/subscriptions/{subscriptionId} Update a subscriber by ID (PATCH) · Update subscription by ID OAuth Scope: subscriptions:write #

Ask an LLM

“Can I PATCH a subscriber's custom fields using their subscription ID?”

“What's the PATCH way to change one subscriber's email or Stripe customer?”

Tell an agent

PATCH subscription {subscription} on {publication} with custom fields {custom_fields}.

PATCH the Stripe customer on subscription {subscription} to {stripe_customer_id}.

DELETE /publications/{publicationId}/subscriptions/{subscriptionId} Permanently delete a subscriber · Delete subscription OAuth Scope: subscriptions:write #

Ask an LLM

“How do I permanently delete a subscriber and all their data?”

“Does deleting a premium subscriber stop their billing?”

Tell an agent destructive · confirm first

Permanently delete subscription {subscription} from publication {publication}.

Erase subscriber {subscription} and all their data for good.

beehiiv Subscriptions API

Operations 8

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification