Plans

Plans describe what your customers buy from your product. Create them in your Nozle workspace; a new workspace does not automatically contain the example plan codes used in these docs. Your own Nozle platform subscription is separate from this customer plan catalog.

Create a first plan

Open the dashboard and create a metered Feature with a stable code, such as api_calls. For the quickstart, use count aggregation so each unique event contributes one unit.
Create a plan with a unique code such as quickstart_free, a monthly interval and a zero subscription price. Add the Feature entitlement with a usage limit of 10,000.
Create a customer with an external ID from your application, then activate a subscription to this plan. A plan alone does not grant a customer access.
Submit events with the matching Feature code and check the customer’s usage after asynchronous processing. See the quickstart.

For a paid plan, configure currency, subscription amount, billing interval and any usage charges explicitly. A Feature entitlement controls access; it does not by itself define a monetary usage charge. Configure your payment provider and checkout flow before accepting payment. For a sum-based meter, choose a numeric aggregation property such as tokens and send that property on every event. Keep the documented event code, aggregation and entitlement aligned.

Read your catalog

The Engine GET /api/v1/plans endpoint returns your organization’s plan catalog: all top-level plans, with their charges, taxes, minimums, entitlements and credit grants. A publishable pk_ key can read it, which makes everything in a plan public. Nozle platform prices and feature availability are not returned as your customer plans. See the public plan catalog for the full response, which plans are included and how to keep sensitive pricing out of it.

import { usePlans } from '@nozle-js/react'

const { plans, isLoading, error } = usePlans();

Use React 0.10.1 or later (0.11.0 is the current release) and handle error before rendering a pricing table. Configure BillingProvider with a publishable key as shown in React setup.

import { Nozle } from '@nozle-js/node'

const nozle = new Nozle() // reads NOZLE_SECRET_KEY

const plans = await nozle.plans();

from nozle import Nozle

nozle = Nozle()  # reads NOZLE_SECRET_KEY

plans = nozle.plans()

See subscriptions for activation and lifecycle changes, and the production integration checklist for features requiring additional setup.

Getting Started

Billing

Product Credits

Margin Intelligence

Entitlements

Create a first plan

Read your catalog

​Create a first plan

​Read your catalog

Create a first plan

Read your catalog