Add subscriber tags to an existing subscriber.

Adds a subscription to a newsletter list.

Deletes a subscriber from your publication.

Deletes (a draft) or archives (a published) a post.

Triggers a recalculation for a segment.

Updates a newsletter list subscription (for example, unsubscribe from the list).

Updates custom fields and/or unsubscribes a subscriber.

Retrieve a list of authors available for the publication.

Returns a list of all automations.

Returns a list of custom fields.

List all subscriptions for a newsletter list.

Retrieve a list of post templates available for the publication.

Retrieve all complimentary access offers belonging to a specific publication.

List subscriber IDs for a segment. Returns a lightweight array of subscription IDs only, without additional subscriber details.

Returns a list of publications with their publication IDs.

Retrieve details about the publication's referral program, including milestones and rewards.

Retrieve all subscriptions belonging to a specific publication.

Views the details of a single author.

Views the details of a single automation journey.

Views the details of a single custom field.

Retrieve a single newsletter list subscription belonging to a specific newsletter list.

View the details of a single post.

Retrieve all publications in the workspace that have a subscription for the specified email address.

Shows the details of a single subscriber using their email address.

View the details of a single tier.

Triggers when a payment attempt fails.

Triggers when a payment is successfully completed.

Approve a waitlist application.

Cancel an active membership so it will no longer renew and access can be revoked.

Create a checkout session for a plan and get a unique checkout link. Optionally embed metadata (like an external user ID) that is returned in the payment webhook when the customer completes their purchase.

Add a prospect to track interest before they purchase. Leads can be company-wide or product-specific.

Create a new pricing plan for a product. Plans define how customers purchase a product, including price, billing period, and availability.

Deny a waitlist application.

Refund a payment.

Reactivate an archived affiliate so they can earn commissions on new referrals again.

Update a lead's referrer or metadata for tracking.

Void an invoice.

Find a member by ID, email, username, or name.

Search for products.

Retrieve an invoice by its unique ID. Invoices are bills sent to customers for payment.

Retrieve a membership by its unique ID. A membership represents a user's access to a purchased product.

Retrieve a plan by its unique ID. Plans define pricing, billing behavior, and how a product is sold.

Retrieve a refund by its unique ID. Refunds represent money returned to customers.

Creates a custom field in your beehiiv account.

Creates a segment from subscription IDs, email addresses, or custom field filters.

Deletes a custom field from your beehiiv account.

Deletes a particular segment.

Updates a custom field for a publication.

Updates a newsletter list subscription using the publication subscription ID when you do not have the newsletter list subscription ID.

Retrieve a single complimentary access offer belonging to a specific publication.

Returns a list of all automation journeys for a specific automation. This will include the status of the journey, the start time, and the completion time.

Returns a list of condition sets.

Retrieve all newsletter lists belonging to a specific publication.

Retrieve all polls belonging to a specific publication. Poll choices are always included.

Retrieve all tiers belonging to a specific publication.

Retrieve all individual subscriber responses for a specific poll with cursor-based pagination.

Return a list of members from a specific segment.

Returns a list of posts for a particular publication.

Return a list of segments from a publication.

Retrieve aggregate stats for all posts.

Views the details of a single automation.

Views the details of a single condition set.

Retrieve a single newsletter list belonging to a specific publication.

Retrieve detailed information about a specific poll belonging to a publication. Use

Retrieve the details of a single publication.

Shows the details of a single segment.

Shows the details of a single subscriber.

Triggers when a membership becomes active.

Triggers when a membership is canceled, expired, or past due.

Triggers when a payment is initiated but not yet completed (e.g., ACH/bank transfer processing, crypto confirmation pending).

Extend a membership by adding free days to the renewal or expiration date. Useful for promotions, rewards, or customer support adjustments.

Archive an affiliate to stop them from earning commissions on new referrals.

Find an existing affiliate or create a new one from a Whop username, email, or user ID.

Creates an invoice for any recipient, including existing members or external customers.

Create a new payment by charging a member's saved payment method.

Create a promo code that applies discounts or free periods to selected plans or all plans.

Pause payment collection on a membership. The member keeps access but billing stops.

Resume payment collection on a paused membership. Billing will restart.

Reverse a scheduled cancellation. The membership will continue to renew instead of ending.

Modify a membership's metadata.

Retrieve the fee breakdown for a payment. Shows platform fees, processing fees, and net amount.

Search for waitlist entries with optional filters.

Find a entry by ID.

Retrieve a lead by its unique ID. Leads are potential customers who have shown interest.

Retrieve a payment by its unique ID. Payments represent completed or attempted transactions.

Retrieve a product by its unique ID. Products represent what customers purchase from your organization.