Update subscriptions

PATCH

https://api.beehiiv.com/v2/publications/:publicationId/subscriptions/bulk_actions

PATCH

/v2/publications/:publicationId/subscriptions/bulk_actions

1 import requests
2 
3 url = "https://api.beehiiv.com/v2/publications/publicationId/subscriptions/bulk_actions"
4 
5 payload = { "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 headers = {
40     "Authorization": "Bearer <token>",
41     "Content-Type": "application/json"
42 }
43 
44 response = requests.patch(url, json=payload, headers=headers)
45 
46 print(response.json())

Try it

200Updated

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

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

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.

subscriptionslist of objectsOptional

An array of objects representing the subscriptions to be updated (max 1000).

Response

dataobject

Authentication

Path parameters

Request

Response

Errors