Update subscription

PATCH

Update a single subscription.

Path parameters

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

The prefixed ID of the publication object

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

The prefixed ID of the subscription object

Request

This endpoint expects an object.

tier"free" or "premium"Optional

Allowed values: freepremium

Optional parameter to set the tier for this subscription.

stripe_customer_idstringOptional

The Stripe Customer ID of the subscription (not required)

unsubscribebooleanOptional

A boolean value specifying whether to unsubscribe this subscription from the publication (not required)

custom_fieldslist of objectsOptional

An array of custom field objects to update

Response

dataobject

The subscription object

Errors

PATCH

1 curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/subscriptions/sub_00000000-0000-0000-0000-000000000000 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "tier": "premium",
6   "stripe_customer_id": "cus_12345abcde",
7   "custom_fields": [
8     {
9       "name": "First Name",
10       "value": "Bruce"
11     },
12     {
13       "name": "Last Name",
14       "value": "Wayne"
15     }
16   ]
17 }'

200Updated

1 {
2   "data": {
3     "id": "sub_00000000-0000-0000-0000-000000000000",
4     "email": "[email protected]",
5     "status": "active",
6     "created": 1666800076,
7     "subscription_tier": "premium",
8     "subscription_premium_tier_names": [
9       "Premium",
10       "Gold"
11     ],
12     "utm_source": "Twitter",
13     "utm_medium": "organic",
14     "utm_channel": "",
15     "utm_campaign": "utm_campaign",
16     "referring_site": "https://www.blog.com",
17     "referral_code": "referral_code"
18   }
19 }

Built with

1	curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/subscriptions/sub_00000000-0000-0000-0000-000000000000 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"tier": "premium",
6	"stripe_customer_id": "cus_12345abcde",
7	"custom_fields": [
8	{
9	"name": "First Name",
10	"value": "Bruce"
11	},
12	{
13	"name": "Last Name",
14	"value": "Wayne"
15	}
16	]
17	}'

1	{
2	"data": {
3	"id": "sub_00000000-0000-0000-0000-000000000000",
4	"email": "[email protected]",
5	"status": "active",
6	"created": 1666800076,
7	"subscription_tier": "premium",
8	"subscription_premium_tier_names": [
9	"Premium",
10	"Gold"
11	],
12	"utm_source": "Twitter",
13	"utm_medium": "organic",
14	"utm_channel": "",
15	"utm_campaign": "utm_campaign",
16	"referring_site": "https://www.blog.com",
17	"referral_code": "referral_code"
18	}
19	}