Backend

Integrating PriceOS on your backend is the most secure way to use PriceOS and gives you access to all of our API capabilities.

Node.js
API

Install

Create an API key in the PriceOS dashboard and add to your environment variables.

.env

PRICEOS_API_KEY=pos_ab234cdef...

npm i priceos

pnpm add priceos

yarn add priceos

bun add priceos

Generate types (optional, but highly recommended)

npx priceos generate-types

pnpm dlx priceos generate-types

yarn dlx priceos generate-types

bunx priceos generate-types

This will generate a local types file that you can include so all of your features are fully typed.Run with the --help option to see more configuration options.

Remember to regenerate types any time you create a new feature.

Create SDK client

import { PriceOS } from "priceos";
import type { MyFeatures } from "./priceos.types";

export const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY);

import { PriceOS } from "priceos";

export const priceos = new PriceOS(process.env.PRICEOS_API_KEY!);

Evaluate feature access

const { hasAccess } = await priceos.features.getAccess(
  "customer_123", // Your internal customer ID
  "premium_support" // Feature key
);

if (hasAccess) {
  // Allow action
}

const { hasAccess, usage } = await priceos.features.getAccess(
  "customer_123", // Your internal customer ID
  "credits" // Feature key
);

if (hasAccess && !usage.hasReachedLimit) {
  // Allow access
}

For optimized performance, we recommend implementing a cache if feature access is evaluated frequently (or use our React hooks, which has a built-in cache).

Be sure to read Linking Stripe Customers to learn how to link Stripe customers to your own internal ID.

For more details, see Evaluating Feature Access.

Track usage (optional)

Only if you’re using PriceOS to track your customers’ usage for limit features.

await priceos.usage.track({
  customerId: "customer_123",
  featureKey: "team_seats",
  amount: 1,
});

For more details, see Tracking Usage.

Create API key

Create an API key in the PriceOS dashboard and add to your environment variables.

.env

PRICEOS_API_KEY=pos_ab234cdef...

Evaluate feature access

curl -X GET "https://api.priceos.com/v1/feature-access?customerId=customer_123" \
  -H "x-api-key: PRICEOS_API_KEY"

const response = await fetch(
  "https://api.priceos.com/v1/feature-access?customerId=customer_123",
  {
    headers: {
      "x-api-key": process.env.PRICEOS_API_KEY,
    },
  }
);

const featureAccess = await response.json();

import requests

response = requests.get(
  "https://api.priceos.com/v1/feature-access",
  params={"customerId": "customer_123"},
  headers={"x-api-key": "PRICEOS_API_KEY"},
)

feature_access = response.json()

For more details, see Evaluating Feature Access and Linking Stripe Customers.

Track usage

curl -X POST "https://api.priceos.com/v1/usage" \
  -H "x-api-key: PRICEOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "customer_123",
    "featureKey": "team_seats",
    "amount": 1
  }'

const response = await fetch("https://api.priceos.com/v1/usage", {
  method: "POST",
  headers: {
    "x-api-key": process.env.PRICEOS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    customerId: "customer_123",
    featureKey: "team_seats",
    amount: 1,
  }),
});

const result = await response.json();

import requests

response = requests.post(
  "https://api.priceos.com/v1/usage",
  headers={
    "x-api-key": "PRICEOS_API_KEY",
    "Content-Type": "application/json",
  },
  json={
    "customerId": "customer_123",
    "featureKey": "team_seats",
    "amount": 1,
  },
)

result = response.json()

For more details, see Tracking Usage.

Getting Started

Features

Products

Customers

Usage

Bonuses

Overrides

Account