Skip to main content

What are Subscriptions?

Subscriptions define the billing plans available for premises monitoring. Each partner is configured with one or more active subscription offerings (for example monthly or annual). When a premises monitorable is created for a partner that has active subscriptions, the platform generates a SUBSCRIPTION requirement that must be fulfilled before activation.

Person and vehicle monitorables do not use subscriptions.

Subscription Types​

ValueDescription
MONTHLYBilled on a monthly period (P1M)
ANNUALBilled on an annual period (P1Y)

Fee Items​

Each subscription includes one or more fee items. Item types must match the subscription type:

ValueDescription
MONTHLY_SUBSCRIPTION_FEERecurring monthly monitoring subscription fee
MONTHLY_GUARD_FEERecurring monthly guard / verified response fee
ANNUAL_SUBSCRIPTION_FEERecurring annual monitoring subscription fee
ANNUAL_GUARD_FEERecurring annual guard / verified response fee

Each item has an amount with a numeric value and an ISO 4217 currency (for example USD).

How Subscriptions Appear in Service Availability​

For premises checks, each municipality in the response may include:

  1. A SUBSCRIPTION requirement with stage: PRE_ACTIVATION and an options array listing the available subscription types
  2. A subscriptions array with pricing details for each active offering

Guard fee items (MONTHLY_GUARD_FEE, ANNUAL_GUARD_FEE) are included in the pricing only when the municipality requires patrol / verified response services (for example a PATROL_SERVICES_REQUIRED notice). Otherwise those items are omitted from the response.

If the partner has no active subscriptions, the SUBSCRIPTION requirement and subscriptions array are omitted.

See Check Service Availability for response examples.

Subscription Requirement Lifecycle​

  1. Discover — A premises service availability check returns available subscription options and pricing.
  2. Create — When the partner has active subscriptions, creating a premises monitorable generates a SUBSCRIPTION requirement. If you pass subscription on create and it matches an allowed option, the requirement is created as COMPLETE. Otherwise it is INCOMPLETE.
  3. Fulfill — If incomplete, set the subscription with PATCH /monitorables/:id using a value from the requirement options.
  4. Activate — All pre-activation requirements, including SUBSCRIPTION, must be COMPLETE before the monitorable can be activated.

Passing subscription when the partner has no active subscriptions returns a 400 error. Subscription cannot be changed after the monitorable has been activated.

Guides​

Concepts​