Beehiiv MCP Server

Overview Schema Source Related Servers Discussions Admin

Update subscription by ID

update_subscription

Destructive

Modify a Beehiiv subscription's state by ID, including tier, email, and custom fields; set confirm=true to execute the change.

Instructions

Update subscription by ID. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require subscriptions:write.

Input Schema

TableJSON Schema

Name	Required	Description
`tier`	No	Optional parameter to set the tier for this subscription.
`email`	No	The new email address for the subscription
`account`	No	Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
`confirm`	No	Set true only when the user asked for exactly this action.
`payload`	No	Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
`unsubscribe`	No	A boolean value specifying whether to unsubscribe this subscription from the publication (not required)
`payload_file`	No	Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
`custom_fields`	No
`premium_tiers`	No
`publication_id`	Yes	The prefixed ID of the publication object
`subscription_id`	Yes	The prefixed ID of the subscription object
`premium_tier_ids`	No
`stripe_customer_id`	No	The Stripe Customer ID of the subscription (not required)
`newsletter_list_ids`	No
`complimentary_gift_id`	No
`unsubscribe_newsletter_list_ids`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed52 schema fields changedv3.0.1Oct 7, 2026

addedInput schema / $defs

Added value: +{
+  "ComplimentaryAccessId": {
+    "description": "The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication.",
+    "pattern": "^(comp_access_[0-9a-fA-F\\-]+)$",
+    "title": "ComplimentaryAccessId",
+    "type": "string"
+  },
+  "custom_fields": {
+    "description": "An array of custom field objects to update",
+    "items": {
+      "additionalProperties": false,
+      "properties": {
+        "delete": {
+          "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
+          "type": "boolean"
+        },
+        "name": {
+          "description": "The name of the existing custom field",
+          "type": "string"
+        },
+        "value": {
+          "description": "The value of the custom field",
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "format": "double",
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "CustomFieldDataType"
+        }
+      },
+      "title": "SubscriptionsPutRequestSubscriptionsItemCustomFieldsItem",
+      "type": "object"
+    },
+    "type": "array"
+  },
+  "newsletter_list_ids": {
+    "description": "An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "premium_tier_ids": {
+    "description": "An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "premium_tiers": {
+    "description": "An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "unsubscribe_newsletter_list_ids": {
+    "description": "An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  }
+}

addedInput schema / properties / complimentary_gift_id / $ref
```
Added value: +"#/$defs/ComplimentaryAccessId"
```

removedInput schema / properties / complimentary_gift_id / description

Removed value: -"The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication."

removedInput schema / properties / complimentary_gift_id / pattern
```
Removed value: -"^(comp_access_[0-9a-fA-F\\-]+)$"
```
removedInput schema / properties / complimentary_gift_id / title
```
Removed value: -"ComplimentaryAccessId"
```
removedInput schema / properties / complimentary_gift_id / type
```
Removed value: -"string"
```

changedInput schema / properties / confirm / description

Previous value: -"Must be true for every account mutation. Confirms only the user-requested action."New value: +"Set true only when the user asked for exactly this action."

addedInput schema / properties / custom_fields / $ref
```
Added value: +"#/$defs/custom_fields"
```

removedInput schema / properties / custom_fields / description

Removed value: -"An array of custom field objects to update"

removedInput schema / properties / custom_fields / items

Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "delete": {
-      "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
-      "type": "boolean"
-    },
-    "name": {
-      "description": "The name of the existing custom field",
-      "type": "string"
-    },
-    "value": {
-      "description": "The value of the custom field",
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "format": "double",
-          "type": "number"
-        },
-        {
-          "type": "boolean"
-        },
-        {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        }
-      ],
-      "title": "CustomFieldDataType"
-    }
-  },
-  "title": "SubscriptionsPutRequestSubscriptionsItemCustomFieldsItem",
-  "type": "object"
-}

removedInput schema / properties / custom_fields / type
```
Removed value: -"array"
```
addedInput schema / properties / newsletter_list_ids / $ref
```
Added value: +"#/$defs/newsletter_list_ids"
```

removedInput schema / properties / newsletter_list_ids / description

Removed value: -"An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`."

removedInput schema / properties / newsletter_list_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / newsletter_list_ids / type
```
Removed value: -"array"
```
addedInput schema / properties / payload / properties / complimentary_gift_id / $ref
```
Added value: +"#/$defs/ComplimentaryAccessId"
```

removedInput schema / properties / payload / properties / complimentary_gift_id / description

Removed value: -"The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication."

removedInput schema / properties / payload / properties / complimentary_gift_id / pattern
```
Removed value: -"^(comp_access_[0-9a-fA-F\\-]+)$"
```
removedInput schema / properties / payload / properties / complimentary_gift_id / title
```
Removed value: -"ComplimentaryAccessId"
```
removedInput schema / properties / payload / properties / complimentary_gift_id / type
```
Removed value: -"string"
```
addedInput schema / properties / payload / properties / custom_fields / $ref
```
Added value: +"#/$defs/custom_fields"
```
removedInput schema / properties / payload / properties / custom_fields / description
```
Removed value: -"An array of custom field objects to update"
```

removedInput schema / properties / payload / properties / custom_fields / items

Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "delete": {
-      "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
-      "type": "boolean"
-    },
-    "name": {
-      "description": "The name of the existing custom field",
-      "type": "string"
-    },
-    "value": {
-      "description": "The value of the custom field",
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "format": "double",
-          "type": "number"
-        },
-        {
-          "type": "boolean"
-        },
-        {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        }
-      ],
-      "title": "CustomFieldDataType"
-    }
-  },
-  "title": "SubscriptionsPutRequestSubscriptionsItemCustomFieldsItem",
-  "type": "object"
-}

removedInput schema / properties / payload / properties / custom_fields / type
```
Removed value: -"array"
```
addedInput schema / properties / payload / properties / newsletter_list_ids / $ref
```
Added value: +"#/$defs/newsletter_list_ids"
```

removedInput schema / properties / payload / properties / newsletter_list_ids / description

Removed value: -"An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`."

removedInput schema / properties / payload / properties / newsletter_list_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / payload / properties / newsletter_list_ids / type
```
Removed value: -"array"
```
addedInput schema / properties / payload / properties / premium_tier_ids / $ref
```
Added value: +"#/$defs/premium_tier_ids"
```

removedInput schema / properties / payload / properties / premium_tier_ids / description

Removed value: -"An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter."

removedInput schema / properties / payload / properties / premium_tier_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / payload / properties / premium_tier_ids / type
```
Removed value: -"array"
```
addedInput schema / properties / payload / properties / premium_tiers / $ref
```
Added value: +"#/$defs/premium_tiers"
```

removedInput schema / properties / payload / properties / premium_tiers / description

Removed value: -"An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter."

removedInput schema / properties / payload / properties / premium_tiers / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / payload / properties / premium_tiers / type
```
Removed value: -"array"
```
addedInput schema / properties / payload / properties / unsubscribe_newsletter_list_ids / $ref
```
Added value: +"#/$defs/unsubscribe_newsletter_list_ids"
```

removedInput schema / properties / payload / properties / unsubscribe_newsletter_list_ids / description

Removed value: -"An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`."

removedInput schema / properties / payload / properties / unsubscribe_newsletter_list_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / payload / properties / unsubscribe_newsletter_list_ids / type
```
Removed value: -"array"
```
addedInput schema / properties / premium_tier_ids / $ref
```
Added value: +"#/$defs/premium_tier_ids"
```

removedInput schema / properties / premium_tier_ids / description

Removed value: -"An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter."

removedInput schema / properties / premium_tier_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / premium_tier_ids / type
```
Removed value: -"array"
```
addedInput schema / properties / premium_tiers / $ref
```
Added value: +"#/$defs/premium_tiers"
```

removedInput schema / properties / premium_tiers / description

Removed value: -"An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter."

removedInput schema / properties / premium_tiers / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / premium_tiers / type
```
Removed value: -"array"
```
addedInput schema / properties / unsubscribe_newsletter_list_ids / $ref
```
Added value: +"#/$defs/unsubscribe_newsletter_list_ids"
```

removedInput schema / properties / unsubscribe_newsletter_list_ids / description

Removed value: -"An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`."

removedInput schema / properties / unsubscribe_newsletter_list_ids / items
```
Removed value: -{
-  "type": "string"
-}
```
removedInput schema / properties / unsubscribe_newsletter_list_ids / type
```
Removed value: -"array"
```

First observedv2.0.0Oct 3, 2026

TDQS

A3.6/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely new context: that it changes account state, that confirm=true is a hard gate, and that OAuth callers need subscriptions:write. It stops short of saying what is lost or how to preview a change.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the action and followed by the two operational constraints. Efficient, though the opening clause duplicates the tool title verbatim rather than adding information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, non-idempotent mutation with 16 parameters and no output schema, the description covers auth and confirmation but omits the mutually exclusive body-input modes and the consequences of the destructive fields (unsubscribe, delete flags). An agent can call it, but only by reading the schema closely.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 16 parameters at 63% schema description coverage, the schema carries most of the semantic load, and the description only restates the confirm flag, whose schema description is already explicit. It offers nothing about the payload-vs-body-flags mutual exclusivity or the precedence rules among tier, premium_tiers and premium_tier_ids.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource plus the identifier scope ('by ID'), which distinguishes it from the sibling update_subscription_by_email and get_subscription_by_email. It does not, however, differentiate itself from patch_subscription, which operates on the same resource.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives one concrete usage condition ('requires confirm=true for the user-requested action') and an auth prerequisite (OAuth scope subscriptions:write), which is real guidance. It never says when to prefer this over patch_subscription or update_subscription_by_email, nor when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Update subscription by ID

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools