beehiiv Developer Documentation

curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/tiers/tier_00000000-0000-0000-0000-000000000000 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Gold",
  "description": "Our premium tier with exclusive benefits",
  "prices_attributes": [
    {
      "id": "price_00000000-0000-0000-0000-000000000000",
      "currency": "usd",
      "amount_cents": 500,
      "interval": "month",
      "interval_display": "Monthly",
      "cta": "Subscribe Now",
      "features": [
        "Exclusive content"
      ],
      "delete": true
    }
  ]
}'

{
  "data": {
    "id": "tier_00000000-0000-0000-0000-000000000000",
    "name": "Gold",
    "status": "active",
    "description": "description",
    "stats": {
      "active_subscriptions": 1
    },
    "prices": [
      {
        "id": "price_00000000-0000-0000-0000-000000000000",
        "amount_cents": 500
      }
    ]
  }
}

Update an existing tier belonging to a specific publication

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

tierIdstringRequiredformat: "^(tier_[0-9a-fA-F\-]+)$"

The prefixed ID of the tier object

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

prices_attributeslist of objectsOptional

Response

dataobject

The subscription tier object.

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error