Evaluating Feature Access

Be sure to check out Linking Stripe Customers to learn more about how to identify Stripe customers with your own internal customer ID.

Evaluating access for a single feature

Boolean features
Limit features

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

export function PrioritySupportButton() {
  const { hasAccess, isLoading } = useFeatureAccess<MyFeatures>("priority_support");

  const onClick = () => {
    if (!hasAccess){
      // Customer does not have access
    }

    // Allow action
  }

  if (isLoading) return <div>Loading...</div>;

  return (
    <button onClick={onClick}>
      Contact support
    </button>
  );
}

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

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

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

if (hasAccess) {
  // Allow action
}

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

usage will be included if you’re using PriceOS to track usage for that feature.

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

export function CreateNewButton() {
  const { 
    hasAccess, 
    usage, 
    limit, 
    isLoading 
  } = useFeatureAccess<MyFeatures>("credits");

  const onClick = () => {
    if (!hasAccess){
      // Customer does not have access
    }

    // If using PriceOS to track usage...
    if (usage?.hasReachedLimit){
      // Customer has hit usage limit
    }

    // If using your own system to track usage...
    if (currentUsage >= limit){
      // Customer has hit usage limit
    }

  }

  return (
    <button onClick={onClick}>
      Create new
    </button>
  );
}

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

const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY!);
const { hasAccess, usage, limit } = await priceos.features.getAccess(
  "customer_123", // Your internal customer ID
  "credits"
);

if (!hasAccess){
  // Customer does not have access
}

// If using PriceOS to track usage...
if (usage?.hasReachedLimit){
  // Customer has hit usage limit
}

// If using your own system to track usage...
if (currentUsage >= limit){
  // Customer has hit usage limit
}

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

The hasAccess field indicates whether the customer has access to the feature in general. It does not indicate that the usage limit has been reached. Use the usage.hasReachedLimit field for that.

Evaluate access for all features

Boolean features
Limit features

Boolean features are simple on/off checks using hasAccess.

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

export function PrioritySupportButton() {
  const { featureAccess, isLoading } = useFeatureAccess<MyFeatures>();

  const onClick = () => {
    const hasAccess = featureAccess.priority_support.hasAccess;

    if (hasAccess){
      // Allow action
    }
 
  }

  if (isLoading) return <div>Loading...</div>;

  return <button onClick={onClick}>Contact support</button>;
}

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

const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY!);
const featureAccess = await priceos.features.getAccess(
  "customer_123" // Your internal customer ID
);

if (featureAccess.priority_support.hasAccess) {
  // Allow action
}

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

Limit features return usage data and the current limit window.

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

export function CreateNewButton() {
  const { featureAccess, isLoading } = useFeatureAccess<MyFeatures>();

  const onClick = () => {
    const { hasAccess, usage, limit } = featureAccess.credits ?? {}
    
    if (!hasAccess){
      // Customer does not have access
    }

    // If using PriceOS to track usage...
    if (usage?.hasReachedLimit){
      // Customer has hit usage limit
    }

    // If using your own system to track usage...
    if (currentUsage >= limit){
      // Customer has hit usage limit
    }
  }

  if (isLoading) return <div>Loading...</div>;

  return <button onClick={onClick}>Create new</button>;
}

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

const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY!);
const featureAccess = await priceos.features.getAccess(
  "customer_123" // Your internal customer ID
);

const { hasAccess, usage, limit } = featureAccess.credits;

if (!hasAccess){
  // Customer does not have access
}

// If using PriceOS to track usage...
if (usage?.hasReachedLimit){
  // Customer has hit usage limit
}

// If using your own system to track usage...
if (currentUsage >= limit){
  // Customer has hit usage limit
}

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

The hasAccess field indicates whether the customer has access to the feature in general. It does not indicate that the usage limit has been reached. Use the usage.hasReachedLimit field for that.

​Evaluating access for a single feature

​Evaluate access for all features

Evaluating access for a single feature

Evaluate access for all features