Create a tier

POST

https://api.beehiiv.com/v2/publications/:publicationId/tiers

POST

/v2/publications/:publicationId/tiers

1 import requests
2 
3 url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/tiers"
4 
5 payload = {
6     "name": "Gold Tier",
7     "description": "Our premium tier with exclusive benefits",
8     "prices_attributes": [
9         {
10             "currency": "usd",
11             "amount_cents": 500,
12             "interval": "month",
13             "enabled": True,
14             "interval_display": "Monthly",
15             "cta": "Subscribe Now",
16             "features": ["Exclusive content", "Ad-free experience", "Priority support"]
17         }
18     ]
19 }
20 headers = {
21     "Authorization": "Bearer <token>",
22     "Content-Type": "application/json"
23 }
24 
25 response = requests.post(url, json=payload, headers=headers)
26 
27 print(response.json())

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 }

Create a new tier for a 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

Request

This endpoint expects an object.

namestringRequired

descriptionstringOptional

prices_attributeslist of objectsOptional

Response

Created

dataobject or null

The subscription tier object.

Authentication

Path parameters

Request

Response

Errors