Update business monitoring event types
Update the event types, metadata, or status of a business subscription. Status may only be set to active or paused — to cancel a subscription, use the DELETE endpoint.
Authorizations
Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx
Path Parameters
Portfolio business ID
"987e6543-e21a-45b6-c789-012345678901"
Body
Updated list of webhook event types to subscribe to (replaces existing)
1business.registration.updated, business.filing.due, business.filing.overdue Update subscription status. Only active and paused are accepted: pausing stops event delivery while keeping the monitoring registration, and setting active resumes delivery. To cancel a subscription, use the DELETE endpoint.
active, paused "paused"
Update custom metadata for the subscription
Response
Subscription updated successfully
Unique identifier for the subscription
"123e4567-e89b-12d3-a456-426614174000"
Object type identifier
subscription "subscription"
Type of resource being monitored
user, business "business"
ID of the user or business being monitored
"987e6543-e21a-45b6-c789-012345678901"
List of webhook event types subscribed to for monitoring notifications
business.registration.updated, business.filing.due, business.filing.overdue Current status of the subscription
active, paused, expired, cancelled "active"
Whether the subscription belongs to test or live mode, determined by the API key used to create it
test, live "live"
Custom metadata for the subscription
ISO 8601 timestamp when the subscription was created
"2025-10-24T10:30:00Z"
ISO 8601 timestamp when the subscription was last updated
"2025-10-24T15:45:00Z"
ISO 8601 timestamp when the subscription expires (for paid subscriptions)
"2026-10-24T10:30:00Z"

