Skip to main content
Glama
thenavidm
by thenavidm

Update a tier

update_tier
Destructive

Edit an existing subscription tier's pricing, name, or description in Beehiiv. Set confirm=true to apply the change; requires tiers:write scope for OAuth integrations.

Instructions

Update a tier. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require tiers:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
tier_idYesThe prefixed ID of the tier object
descriptionNo
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
publication_idYesThe prefixed ID of the publication object
prices_attributesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "prices_attributes": {
      +    "items": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "amount_cents": {
      +          "type": "integer"
      +        },
      +        "cta": {
      +          "type": "string"
      +        },
      +        "currency": {
      +          "enum": [
      +            "usd",
      +            "aud",
      +            "cad",
      +            "eur",
      +            "gbp",
      +            "inr",
      +            "brl",
      +            "mxn",
      +            "nzd",
      +            "dkk"
      +          ],
      +          "title": "TierPriceCurrency",
      +          "type": "string"
      +        },
      +        "delete": {
      +          "default": false,
      +          "description": "Optionally delete the price when updating the tier.",
      +          "type": "boolean"
      +        },
      +        "features": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "id": {
      +          "description": "ID of the existing price.",
      +          "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      +          "title": "PriceId",
      +          "type": "string"
      +        },
      +        "interval": {
      +          "enum": [
      +            "month",
      +            "quarter",
      +            "year",
      +            "one_time",
      +            "donation"
      +          ],
      +          "title": "TierPriceInterval",
      +          "type": "string"
      +        },
      +        "interval_display": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "currency",
      +        "amount_cents",
      +        "interval"
      +      ],
      +      "title": "UpdateTierPriceRequest",
      +      "type": "object"
      +    },
      +    "type": "array"
      +  }
      +}
    • 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 / payload / properties / prices_attributes / $ref
      Added value: +"#/$defs/prices_attributes"
    • removedInput schema / properties / payload / properties / prices_attributes / items
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "amount_cents": {
      -      "type": "integer"
      -    },
      -    "cta": {
      -      "type": "string"
      -    },
      -    "currency": {
      -      "enum": [
      -        "usd",
      -        "aud",
      -        "cad",
      -        "eur",
      -        "gbp",
      -        "inr",
      -        "brl",
      -        "mxn",
      -        "nzd",
      -        "dkk"
      -      ],
      -      "title": "TierPriceCurrency",
      -      "type": "string"
      -    },
      -    "delete": {
      -      "default": false,
      -      "description": "Optionally delete the price when updating the tier.",
      -      "type": "boolean"
      -    },
      -    "features": {
      -      "items": {
      -        "type": "string"
      -      },
      -      "type": "array"
      -    },
      -    "id": {
      -      "description": "ID of the existing price.",
      -      "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      -      "title": "PriceId",
      -      "type": "string"
      -    },
      -    "interval": {
      -      "enum": [
      -        "month",
      -        "quarter",
      -        "year",
      -        "one_time",
      -        "donation"
      -      ],
      -      "title": "TierPriceInterval",
      -      "type": "string"
      -    },
      -    "interval_display": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "id",
      -    "currency",
      -    "amount_cents",
      -    "interval"
      -  ],
      -  "title": "UpdateTierPriceRequest",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / properties / prices_attributes / type
      Removed value: -"array"
    • addedInput schema / properties / prices_attributes / $ref
      Added value: +"#/$defs/prices_attributes"
    • removedInput schema / properties / prices_attributes / items
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "amount_cents": {
      -      "type": "integer"
      -    },
      -    "cta": {
      -      "type": "string"
      -    },
      -    "currency": {
      -      "enum": [
      -        "usd",
      -        "aud",
      -        "cad",
      -        "eur",
      -        "gbp",
      -        "inr",
      -        "brl",
      -        "mxn",
      -        "nzd",
      -        "dkk"
      -      ],
      -      "title": "TierPriceCurrency",
      -      "type": "string"
      -    },
      -    "delete": {
      -      "default": false,
      -      "description": "Optionally delete the price when updating the tier.",
      -      "type": "boolean"
      -    },
      -    "features": {
      -      "items": {
      -        "type": "string"
      -      },
      -      "type": "array"
      -    },
      -    "id": {
      -      "description": "ID of the existing price.",
      -      "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      -      "title": "PriceId",
      -      "type": "string"
      -    },
      -    "interval": {
      -      "enum": [
      -        "month",
      -        "quarter",
      -        "year",
      -        "one_time",
      -        "donation"
      -      ],
      -      "title": "TierPriceInterval",
      -      "type": "string"
      -    },
      -    "interval_display": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "id",
      -    "currency",
      -    "amount_cents",
      -    "interval"
      -  ],
      -  "title": "UpdateTierPriceRequest",
      -  "type": "object"
      -}
    • removedInput schema / properties / prices_attributes / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, but the description adds genuinely new behavioral context: the confirm=true gate, the tiers:write OAuth scope, and that the call changes account state. It stops short of disclosing that price entries can be removed via the delete flag or whether changes are reversible.

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 the critical confirm requirement; nothing is padded. The first sentence is largely redundant with the title, which keeps it from a 5.

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 nested objects and no output schema, the description covers the safety gate and auth scope but omits what fields can be changed and the fact that price deletion is possible through prices_attributes. Adequate for safe invocation, but thin given the tool's complexity.

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

Parameters2/5

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

With 9 parameters and only 67% schema description coverage, the description should compensate, but it names only 'confirm' and merely echoes the schema's own description of that field. It adds no meaning for the payload vs. payload_file vs. body-flag mutual exclusivity or for the nested prices_attributes structure, leaving a third of parameters undocumented in both places.

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

Purpose3/5

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

The opening sentence 'Update a tier' is a verb+resource but is essentially a restatement of the tool name and title, adding no detail about what is updatable (name, description, prices). It also fails to distinguish this from the sibling replace_tier, which an agent would need to choose between. Purpose is inferable but under-specified.

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?

It gives two concrete usage constraints: confirm=true must be set for the user-requested action, and OAuth integrations require the tiers:write scope. However, there is no guidance on when to use this versus replace_tier or create_tier, and no statement of preconditions such as needing an existing tier_id.

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

Deploy Server

Other Tools