Update subscriptions

PATCH

Bulk update multiple subscriptions fields, including status, custom fields, and tiers.

Path parameters

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

The prefixed ID of the publication object

Request

This endpoint expects an object.

subscriptionslist of objectsOptional

An array of objects representing the subscriptions to be updated

Response

dataobject

Errors

PATCH

1 curl -X PATCH https://api.beehiiv.com/v2/publications/publicationId/subscriptions/bulk_actions \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "subscriptions": [
6     {
7       "subscription_id": "sub_1234-5678-9012-3456-7890",
8       "tier": "premium",
9       "stripe_customer_id": "cus_1234567890",
10       "unsubscribe": false,
11       "custom_fields": [
12         {
13           "name": "custom_field_name",
14           "value": "custom_field_value"
15         },
16         {
17           "name": "custom_field_name_2",
18           "value": "custom_field_value_2"
19         }
20       ]
21     },
22     {
23       "subscription_id": "sub_9876-5432-1098-7654-3210",
24       "tier": "free",
25       "stripe_customer_id": "cus_1234567890",
26       "unsubscribe": true,
27       "custom_fields": [
28         {
29           "name": "custom_field_name_3",
30           "value": "custom_field_value_3"
31         },
32         {
33           "name": "custom_field_name_4",
34           "value": "custom_field_value_4"
35         }
36       ]
37     }
38   ]
39 }'

200Updated

1 {
2   "data": {
3     "subscription_update_id": "subscription_update_id"
4   }
5 }

Built with

1	curl -X PATCH https://api.beehiiv.com/v2/publications/publicationId/subscriptions/bulk_actions \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"subscriptions": [
6	{
7	"subscription_id": "sub_1234-5678-9012-3456-7890",
8	"tier": "premium",
9	"stripe_customer_id": "cus_1234567890",
10	"unsubscribe": false,
11	"custom_fields": [
12	{
13	"name": "custom_field_name",
14	"value": "custom_field_value"
15	},
16	{
17	"name": "custom_field_name_2",
18	"value": "custom_field_value_2"
19	}
20	]
21	},
22	{
23	"subscription_id": "sub_9876-5432-1098-7654-3210",
24	"tier": "free",
25	"stripe_customer_id": "cus_1234567890",
26	"unsubscribe": true,
27	"custom_fields": [
28	{
29	"name": "custom_field_name_3",
30	"value": "custom_field_value_3"
31	},
32	{
33	"name": "custom_field_name_4",
34	"value": "custom_field_value_4"
35	}
36	]
37	}
38	]
39	}'

1	{
2	"data": {
3	"subscription_update_id": "subscription_update_id"
4	}
5	}