Update a tier

PUT

Update an existing tier belonging to a specific publication

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

dataobjectOptional

The subscription tier object.

Errors

PUT

1 curl -X PUT https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/tiers/tier_00000000-0000-0000-0000-000000000000 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Gold",
6   "description": "Our premium tier with exclusive benefits",
7   "prices_attributes": [
8     {
9       "id": "price_00000000-0000-0000-0000-000000000000",
10       "currency": "usd",
11       "amount_cents": 500,
12       "interval": "month",
13       "interval_display": "Monthly",
14       "cta": "Subscribe Now",
15       "features": [
16         "Exclusive content"
17       ],
18       "delete": true
19     }
20   ]
21 }'

200Updated

1 {
2   "data": {
3     "id": "tier_00000000-0000-0000-0000-000000000000",
4     "name": "Gold",
5     "status": "active",
6     "description": "description",
7     "stats": {
8       "active_subscriptions": 1
9     },
10     "prices": [
11       {
12         "id": "price_00000000-0000-0000-0000-000000000000",
13         "amount_cents": 500
14       }
15     ]
16   }
17 }

Built with

1	curl -X PUT https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/tiers/tier_00000000-0000-0000-0000-000000000000 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Gold",
6	"description": "Our premium tier with exclusive benefits",
7	"prices_attributes": [
8	{
9	"id": "price_00000000-0000-0000-0000-000000000000",
10	"currency": "usd",
11	"amount_cents": 500,
12	"interval": "month",
13	"interval_display": "Monthly",
14	"cta": "Subscribe Now",
15	"features": [
16	"Exclusive content"
17	],
18	"delete": true
19	}
20	]
21	}'

1	{
2	"data": {
3	"id": "tier_00000000-0000-0000-0000-000000000000",
4	"name": "Gold",
5	"status": "active",
6	"description": "description",
7	"stats": {
8	"active_subscriptions": 1
9	},
10	"prices": [
11	{
12	"id": "price_00000000-0000-0000-0000-000000000000",
13	"amount_cents": 500
14	}
15	]
16	}
17	}