Nube Auth's licensing system lets you implement any business model.

Concepts

Concept	Description
Plan	A pricing tier (Free, Pro, Enterprise)
License	A user's subscription to a plan
Entitlement	A feature or capability
Limit	Usage quotas (API calls, storage, etc.)

Basic Usage

// Check if user has a feature
const canExport = await nube-auth.hasEntitlement('export');

if (canExport) {
  // Show export button
}

// Get user's current plan
const license = await nube-auth.getLicense();
console.log(license.plan); // 'pro'

// Check usage limits
const usage = await nube-auth.getUsage('api_calls');
console.log(usage.current, usage.limit); // 450, 1000

License Structure

interface License {
  id: string;
  userId: string;
  plan: string;
  status: 'active' | 'canceled' | 'expired' | 'trial';
  entitlements: string[];
  limits: Record<string, { current: number; max: number }>;
  trialEndsAt: Date | null;
  expiresAt: Date | null;
  createdAt: Date;
}

Auto-Provisioning

New users automatically get a license:

# Default plan for new users
DEFAULT_PLAN=free

# Enable trial for new users
ENABLE_TRIAL=true
TRIAL_DAYS=14
TRIAL_PLAN=pro

Checking Entitlements

// Single entitlement
if (await nube-auth.hasEntitlement('advanced_analytics')) {
  showAnalyticsDashboard();
}

// Multiple entitlements (all required)
if (await nube-auth.hasEntitlements(['export', 'api_access'])) {
  enableAPIExport();
}

// Any of multiple entitlements
if (await nube-auth.hasAnyEntitlement(['export_csv', 'export_pdf'])) {
  showExportMenu();
}

Gating Features

React example:

function FeatureGate({ feature, children, fallback }) {
  const { hasEntitlement, loading } = useEntitlement(feature);
  
  if (loading) return <Skeleton />;
  if (!hasEntitlement) return fallback || <UpgradePrompt />;
  
  return children;
}

// Usage
<FeatureGate feature="advanced_reports">
  <AdvancedReports />
</FeatureGate>

Webhooks

Get notified of license changes:

// In your webhook handler
app.post('/webhooks/nube-auth', (req, res) => {
  const { event, data } = req.body;
  
  switch (event) {
    case 'license.upgraded':
      // User upgraded their plan
      break;
    case 'license.canceled':
      // User canceled subscription
      break;
    case 'license.expired':
      // License expired
      break;
  }
});

Next Steps

• Plans & Tiers - Configure your pricing