Services Overview

Internal Documentation Only: If you’re not a Null Tools developer, you can close this documentation or visit the Apps section to learn more about using Null Pass in your applications.

Overview

Null Pass manages access to multiple services through a unified entitlement system. Each user can have entitlements for different services with tier-based access control, custom limits, and subscription integration.

Supported Services

DROP

File storage and sharing service

MAILS

Email management service

VAULT

Crypto payment processor

DB

Database service access

Service Entitlement Model

Each service entitlement (UserServiceEntitlement) contains:

string

Unique entitlement ID

string

User ID

ServiceIdentifier

Service identifier: DROP, MAILS, VAULT, or DB

string

default:"free"

Access tier (e.g., “free”, “premium”, “enterprise”)

boolean

default:"false"

Premium access flag

object

Custom access flags (JSON object). Used for fine-grained permission control.Example (DROP):

{
  "isNullDropTeam": Boolean,
  "nullDropTeamRole": "Role",
  "accessFilesPreview": Boolean,
  "accessFilesDownload": Boolean
}

accessFlags Values:

"founder" - Founder role
"dev" - Developer role
"moderator" - Moderator role
"" - Empty for regular member (default)

object

Service-specific metadata (JSON object). Stores user preferences and service configuration.Example (DROP):

{
  "onboarding": {
    "onboarding_completed": Boolean,
    "onboarding_uploads_completed": Boolean
  },
  "blurGalleryMedia": Boolean,
  "userAcceptedCookies": Boolean,
  "userHideProfileInfo": Boolean,
  "defaultUploadVisibility": Boolean
}

number

Custom storage limit in bytes (null for default)

number

Custom API key limit (null for default)

boolean

default:"true"

Whether service is connected/enabled

string

Polar customer ID (for subscription integration)

string

Polar subscription ID

string

Polar subscription status

string

Entitlement creation timestamp

string

Last update timestamp

Database Schema

model UserServiceEntitlement {
  id                      String            @id @default(cuid())
  userId                  String
  service                 ServiceIdentifier
  tier                    String            @default("free")
  isPremium               Boolean           @default(false)
  accessFlags             Json?
  metadata                Json?
  connected               Boolean           @default(true)
  customStorageLimit      Int?
  customApiKeyLimit       Int?
  polarCustomerId         String?
  polarSubscriptionId     String?
  polarSubscriptionStatus String?
  createdAt               DateTime          @default(now())
  updatedAt               DateTime          @updatedAt
  user                    User              @relation(fields: [userId], references: [id], onDelete: Cascade)
}

Service Identifiers

enum ServiceIdentifier {
  DROP
  MAILS
  VAULT
  DB
}

Access Control

Service access is checked through:

Tier-based: Free, premium, enterprise tiers
Premium flag: Boolean premium access
Custom limits: Storage and API key limits
Connection status: Whether service is connected
Access flags: Custom JSON flags for fine-grained control

Get Service Access

Retrieve user’s service entitlements

Update Service

Update service entitlement

Get Started

Authentication

Services

Webhooks

Account Management

Service Connection

Polar Integration

Admin

Advanced

Library

Overview

Supported Services

DROP

MAILS

VAULT

DB

Service Entitlement Model

Database Schema

Service Identifiers

Access Control

Get Service Access

Update Service

​Overview

​Supported Services

DROP

MAILS

VAULT

DB

​Service Entitlement Model

​Database Schema

​Service Identifiers

​Access Control

​Related Endpoints

Get Service Access

Update Service

Overview

Supported Services

Service Entitlement Model

Database Schema

Service Identifiers

Access Control

Related Endpoints