How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
beehiiv

beehiiv Subscriptions API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

beehiiv Subscriptions API is one of 30 APIs that beehiiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 2 JSON Schemas.

This API exposes 8 operations across 3 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.beehiiv.com/v2.

8 operations 3 paths 37 schemas 1 DELETE3 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.beehiiv.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

beehiiv Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 8

Across 3 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 8
POST
/publications/{publicationId}/subscriptions
Create subscription OAuth Scope: subscriptions:write
create 2 params body → 200400401404429500
GET
/publications/{publicationId}/subscriptions
List subscriptions OAuth Scope: subscriptions:read
index 14 params → 200400401404429500
GET
/publications/{publicationId}/subscriptions/by_email/{email}
Get subscription by email OAuth Scope: subscriptions:read
get-by-email 4 params → 200400401404429500
PUT
/publications/{publicationId}/subscriptions/by_email/{email}
Update subscription by email OAuth Scope: subscriptions:write
update-by-email 3 params body → 200400401404429500
GET
/publications/{publicationId}/subscriptions/{subscriptionId}
Get subscription by ID OAuth Scope: subscriptions:read
get-by-id 4 params → 200400401404429500
PUT
/publications/{publicationId}/subscriptions/{subscriptionId}
Update subscription by ID OAuth Scope: subscriptions:write
put 3 params body → 200400401404429500
PATCH
/publications/{publicationId}/subscriptions/{subscriptionId}
Update subscription by ID OAuth Scope: subscriptions:write
patch 3 params body → 200400401404429500
DELETE
/publications/{publicationId}/subscriptions/{subscriptionId}
Delete subscription OAuth Scope: subscriptions:write
delete 3 params → 204400401404429500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are type__SubscriptionRequest (20 properties), type__Subscription (19 properties), type_subscriptions_SubscriptionsListResponse (7 properties), type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem (3 properties). Each schema is shown below with its type and property counts.

type__SubscriptionsCreateRequestTier
string
The tier for this subscription.
type__CustomFieldType
string
The type of value being stored in the custom field.
type_subscriptions_SubscriptionDeleteResponse
object
1 property
type__SubscriptionCustomFieldList
array
Optional list of custom fields for a subscription. Retrievable by including expand: [customfield] in the request body.
type__Error
object
The top level error response.
3 properties 3 required
type__SubscriptionTierList
array
Optional list of tiers for a subscription. Retrievable by including expand: [subscriptionpremiumtiers] in the request body.
type__SubscriptionTierInfoStatus
string
Returns whether or not the tier has any active prices.
type_subscriptions_SubscriptionsListRequestOrderBy
string
type_subscriptions_SubscriptionsListResponse
object
7 properties 1 required
type__SubscriptionTags
array
Optional list of tags for a subscription. Retrievable by including expand: [tags] in the request body. Max limit of 100 unique tags per publication.
type_ids_OptionalStripeCustomerId
string
The prefixed ID of the Stripe customer.
type__SubscriptionTierInfo
object
3 properties 3 required
type__SubscriptionStats
object
Optional list of stats for a subscription. Retrievable by including expand: [stats] in the request body.
3 properties
type__RequestDirection
string
The direction of the request. Defaults to asc.
type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemTier
string
The Tier of the Subscription (not required)
type__SubscriptionExpandedStatus
string
The status of the subscription. validating - The email address is being validated. invalid - The email address is invalid. pending - The email address is valid…
type__CustomField
object
3 properties
type__CustomFieldDataType
type_ids_ComplimentaryAccessId
string
The prefixed ID of the complimentary access object.
type__ErrorDetail
object
2 properties 2 required
type__CustomFieldValue
object
The object required for setting custom field values on a subscription
2 properties
type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem
object
3 properties
type__SubscriptionExpandedUtmChannel
string
The acquisition channel
type_subscriptions_SubscriptionResponse
object
The response containing subscription data
1 property 1 required
type__SubscriptionRequest
object
20 properties 1 required
type_subscriptions_SubscriptionsGetRequestExpandItem
string
type_subscriptions_SubscriptionsListRequestExpandItem
string
type__DoubleOptOverride
string
Override publication double-opt settings for this subscription.
type_bulkSubscriptionUpdates_SubscriptionsPutRequestSubscriptionsItemCustomFieldsItem
object
3 properties
type_subscriptions_SubscriptionsListRequestTier
string
type__SubscriptionExpandedSubscriptionTier
string
The current tier of the subscription.
type_ids_PublicationId
string
The prefixed ID of the publication.
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type_bulkSubscriptionUpdates_SubscriptionsPutRequestSubscriptionsItemTier
string
The Tier of the Subscription (not required)
type_subscriptions_SubscriptionsListRequestStatus
string
type__Subscription
object
The subscription object
19 properties 14 required
type_ids_TierId
string
The prefixed ID of the tier.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-subscriptions-api-openapi.yml Raw ↑

Other APIs beehiiv publishes across the network.

beehiiv Authorizations API
AE Profile APIs.io
beehiiv Tokens API
AE Profile APIs.io
beehiiv Webhooks API
AE Profile APIs.io
beehiiv Ad Network Offers API
AE Profile APIs.io
beehiiv Ad Network Reports API
AE Profile APIs.io
beehiiv Advertisement Opportunities API
AE Profile APIs.io
beehiiv Authors API
AE Profile APIs.io
beehiiv Automation Journeys API
AE Profile APIs.io
beehiiv Automations API
AE Profile APIs.io
beehiiv Bulk Subscription Updates API
AE Profile APIs.io
beehiiv Bulk Subscriptions API
AE Profile APIs.io
beehiiv Complimentary Access API
AE Profile APIs.io
#Subscription
← Back to B APIs
API Details
ID
beehiiv:beehiiv-subscriptions-api
Base URL
https://api.beehiiv.com/v2
Docs
https://developers.beehiiv.com/api-reference/publications
Provider
beehiiv
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=beehiiv-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/beehiiv-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of beehiiv Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.