Documentation Index
Fetch the complete documentation index at: https://docs.priceos.com/llms.txt
Use this file to discover all available pages before exploring further.
You can create two types of features in PriceOS:
You can create features on the features page, product details page, or with
the create feature API.
Boolean features
Boolean features are on/off access to a feature (e.g. Priority support, Advanced analytics, API access, etc)
To create one:
- Go to Features
- Click the New Feature button
- Add a feature name and key
- Select Boolean as the feature type
- Click the Create Feature button
Limit features
Limit features are a numeric cap (e.g. Credits, Team Seats, API requests, etc.).
You can optionally use PriceOS to track usage for your limit features.
To create one:
No usage tracking
With usage tracking
- Go to Features
- Click the New Feature button
- Add a feature name and key
- Select Limit as the feature type
- Click the Create Feature button
Unlike boolean features, you can track usage for your limit feature to keep track of when customers hit limits.
-
Go to Features
-
Click the New Feature button
-
Add a feature name and key
-
Select Limit as the feature type
-
Click the Track usage with PriceOS switch
-
Select a reset interval
- Never - Usage will never reset
- Monthly - Usage will reset monthly for customers based on
resets when
You can choose daily, weekly, and yearly reset intervals by clicking the
More … button
-
Select a resets when
- Billing period start - Usage will reset based on their Stripe subscription date OR their
usageStartedAt date if not a Stripe customer.
- Start of month - Usage will reset at the start of the month for all customers regardless of when they signed up
Billing-period resets apply to Stripe-linked customers. For non-Stripe
customers, define usage start using
usageStartedAt
(defaults to the date the customer was created if not provided).
-
Click the Create Feature button
Create features with the API
Use the API when you want to create features from your own provisioning flow or internal tools.
import { PriceOS } from "priceos";
const priceos = new PriceOS(process.env.PRICEOS_API_KEY!);
await priceos.features.create({
name: "API Calls",
featureKey: "api_calls",
type: "limit",
tracksUsage: true,
usageResetInterval: "month",
usageResetAnchor: "calendar",
});
