Skip to main content
POST
/
v1
/
business
/
{business_id}
/
subscription
Subscribe to business monitoring events
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_types: ['business.registration.updated', 'business.filing.due'],
    metadata: {customer_tier: 'premium', monitoring_level: 'enhanced'}
  })
};

fetch('https://api.getpalm.com/v1/business/{business_id}/subscription', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "subscription",
  "resource_type": "business",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "status": "active",
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "expires_at": "2026-10-24T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

​
business_id
string
required

Business ID

Body

application/json
​
event_types
enum<string>[]
required

List of webhook event types to subscribe to for monitoring notifications

Minimum array length: 1
Available options:
business.registration.updated,
business.filing.due,
business.filing.overdue
Example:
[
  "business.registration.updated",
  "business.filing.due"
]
​
metadata
object

Custom metadata for the subscription

Example:
{
  "customer_tier": "premium",
  "monitoring_level": "enhanced"
}

Response

Subscription created successfully

​
id
string<uuid>
required

Unique identifier for the subscription

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
object
enum<string>
required

Object type identifier

Available options:
subscription
Example:

"subscription"

​
resource_type
enum<string>
required

Type of resource being monitored

Available options:
user,
business
Example:

"business"

​
resource_id
string
required

ID of the user or business being monitored

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
event_types
enum<string>[]
required

List of webhook event types subscribed to for monitoring notifications

Available options:
business.registration.updated,
business.filing.due,
business.filing.overdue
Example:
[
  "business.registration.updated",
  "business.filing.due"
]
​
status
enum<string>
required

Current status of the subscription

Available options:
active,
paused,
expired,
cancelled
Example:

"active"

​
metadata
object
required

Custom metadata for the subscription

Example:
{
  "customer_tier": "premium",
  "monitoring_level": "enhanced"
}
​
created_at
string<date-time>
required

ISO 8601 timestamp when the subscription was created

Example:

"2025-10-24T10:30:00Z"

​
updated_at
string<date-time>
required

ISO 8601 timestamp when the subscription was last updated

Example:

"2025-10-24T15:45:00Z"

​
expires_at
object
required

ISO 8601 timestamp when the subscription expires (for paid subscriptions)

Example:

"2026-10-24T10:30:00Z"