# Docs

- [Introduction](/docs): A personal developer payment platform for all your projects.
- Getting started
  - [Getting started](/docs/getting-started): Start your first vantezzen/pay integration with Stripe, credit codes, and one product.
  - [5-minute quickstart](/docs/getting-started/quickstart): From a fresh project to a paid test checkout.
  - [Hosted or self-hosted?](/docs/getting-started/choose-setup): Choose the right vantezzen/pay deployment before integrating your app.
  - [Set up vantezzen/pay and Stripe](/docs/getting-started/dashboard): Create the project, provider, product, price, and publishable key.
  - [Install the SDK](/docs/getting-started/install): Add the shadcn components and wire the provider into your app.
  - [Gate your first feature](/docs/getting-started/first-feature): Show the balance, offer checkout, and deduct credits when work starts.
  - [Not using the Next.js App Router?](/docs/getting-started/frameworks): Use vantezzen/pay with Vite, the Next.js Pages Router, or Remix.
  - [Test your first payment](/docs/getting-started/test-payment): Verify checkout, webhook fulfillment, and the balance update end to end.
  - [Go live checklist](/docs/getting-started/go-live): The practical checks before real users buy credits.
- Common workflows
  - [Common workflows](/docs/workflows): Practical recipes for subscriptions, billing, refunds, and support work.
  - [Connect a payment provider](/docs/workflows/providers): Set up Stripe or Polar so vantezzen/pay can create checkout and receive payment events.
  - [Provider capability matrix](/docs/workflows/provider-capabilities): What vantezzen/pay handles directly and what Stripe or Polar handle.
  - [Subscriptions and feature gates](/docs/workflows/subscriptions): Sell recurring plans, unlock features, and handle plan changes.
  - [Build a pricing page](/docs/workflows/pricing-page): Render subscription tiers, highlight a recommendation, and manage the current plan.
  - [Customer billing portal](/docs/workflows/billing-portal): Let customers view invoices, update payment methods, and cancel subscriptions.
  - [Lost wallet recovery](/docs/workflows/lost-wallets): How to help anonymous buyers who lost their credit-code wallet.
  - [Refunds](/docs/workflows/refunds): Process provider refunds and understand how vantezzen/pay updates wallets.
  - [Support adjustments](/docs/workflows/support-adjustments): Grant credits or feature access without sending a customer through checkout.
- Core concepts
  - [Core concepts](/docs/concepts): The few vantezzen/pay ideas you need before integrating.
  - [Projects, products, and prices](/docs/concepts/projects-products-prices): Model what users buy and unlock.
  - [Access & features](/docs/concepts/access-and-features): Unlock features with subscriptions and one-time purchases.
  - [Credit codes](/docs/concepts/credit-codes): Anonymous wallets that work without login.
  - [External auth](/docs/concepts/external-auth): Attach credits to your own user ids instead of a browser code.
  - [Checkout flow](/docs/concepts/checkout-flow): What happens from purchase click to credited wallet.
- Components
  - [Components](/docs/components): shadcn registry components and utilities for adding credits to your app.
  - [Installation](/docs/components/install): Install individual registry items or the common component set.
  - [PayProvider](/docs/components/provider): React context that loads balances and resumes checkout confirmation.
  - [useCredits](/docs/components/use-credits): Read, check, refresh, and deduct credits from React components.
  - [RemainingCredits](/docs/components/remaining-credits): Inline balance display for the current wallet.
  - [CreditGate](/docs/components/credit-gate): Render UI only when the wallet has enough credits.
  - [FeatureGate](/docs/components/feature-gate): Render UI only when the wallet has unlocked a feature.
  - [PurchaseButton and PurchaseDialog](/docs/components/purchase): Show available prices and start popup or redirect checkout.
  - [WalletButton](/docs/components/wallet-button): Let users manage a code wallet or logged-in billing account.
  - [createPayClient](/docs/components/client): Browser client for custom credit, checkout, and wallet UI.
  - [createPayServerClient](/docs/components/server): Server-only client for external auth, grants, deductions, and checkout.
- HTTP API
  - [Public REST API](/docs/api): Endpoints used by the client and components.
  - [Server-side users](/docs/api/server-side-users): Use secret keys when your app already has accounts.
  - [Consumer webhooks](/docs/api/webhooks): Receive normalized payment events in your own backend.
  - [Errors](/docs/api/errors): Common API and client errors.
- [Troubleshooting](/docs/troubleshooting): Fast checks for common vantezzen/pay integration and payment issues.
- Security
  - [Security model](/docs/security): How vantezzen/pay protects provider credentials and payment state.
  - [Provider service](/docs/security/provider-service): Run provider operations outside the public Next.js web process.
- Self-host
  - [Self-host vantezzen/pay](/docs/self-host): Run vantezzen/pay on your own domain with your own database and provider accounts.
  - [Environment variables](/docs/self-host/environment): Required configuration for a self-hosted vantezzen/pay instance.
  - [Database](/docs/self-host/database): Set up Postgres and run migrations.
  - [Provider service](/docs/self-host/provider-service): Deploy the secure provider service for self-hosted instances.
  - [Registry URL](/docs/self-host/registry): Serve shadcn registry files from your own vantezzen/pay domain.
  - [Deployment](/docs/self-host/deployment): Deploy the vantezzen/pay Next.js app and connect it to the provider service.
  - [Operations](/docs/self-host/operations): Day-to-day checks for a self-hosted vantezzen/pay instance.
- [AI agent guide](/docs/agent): Instructions for coding agents that integrate vantezzen/pay into an existing app.