# SolvaPay Documentation

## Docs

- [Create a checkout session](https://docs.solvapay.com/api-reference/checkout-sessions/create-a-checkout-session.md): Creates a hosted checkout session for a customer to purchase a product plan. Returns a session ID and checkout URL for redirect.
- [Create a customer session](https://docs.solvapay.com/api-reference/customers/create-a-customer-session.md): Creates a customer session URL that can be used to redirect customers to the customer page. Returns the customer URL and session ID. The session is short-lived (15 minutes) for security reasons.
- [Create a new customer](https://docs.solvapay.com/api-reference/customers/create-a-new-customer.md): Creates a new customer record for the authenticated provider. Customers represent end-users who will purchase your products. Email is required and must be unique per provider. The name field is optional but recommended for better tracking.
- [Get customer by reference](https://docs.solvapay.com/api-reference/customers/get-customer-by-reference.md): Retrieves a customer's details using their unique reference ID. Returns the customer's name, email, and active purchases. Only customers owned by the authenticated provider can be accessed.
- [Get customer by reference, externalRef, or email](https://docs.solvapay.com/api-reference/customers/get-customer-by-reference-externalref-or-email.md): Retrieves a customer's details using their unique reference ID, externalRef, or email. Use query parameter 'reference' to look up by customer reference, 'externalRef' for external auth ID, or 'email' for customer email. Exactly one parameter must be provided. Returns the customer's name, email, and…
- [Get customer session by sessionId](https://docs.solvapay.com/api-reference/customers/get-customer-session-by-sessionid.md): Retrieves a customer session by its sessionId with all data hydrated including customer details and purchases. The session must belong to the authenticated provider.
- [Check usage limits for a customer and product](https://docs.solvapay.com/api-reference/limits/check-usage-limits-for-a-customer-and-product.md): Checks whether a customer has an active purchase for a product and is within their usage limits. Returns a checkout URL if payment is required.
- [Record a meter event](https://docs.solvapay.com/api-reference/meter-events/record-a-meter-event.md): Records a single usage event against a named meter.
- [Record meter events in bulk](https://docs.solvapay.com/api-reference/meter-events/record-meter-events-in-bulk.md): Records multiple usage events in a single request for high throughput.
- [Create a payment intent](https://docs.solvapay.com/api-reference/payment-intents/create-a-payment-intent.md): Creates a new payment intent for a customer to purchase a plan. Payment intents are used with Stripe.js to process payments. Requires an idempotency key to prevent duplicate charges. Returns client secret and publishable key needed for frontend integration.
- [Get a specific payment intent by ID](https://docs.solvapay.com/api-reference/payment-intents/get-a-specific-payment-intent-by-id.md): Retrieves detailed information about a specific payment intent including amount, currency, and client secret for Stripe integration.
- [List payment intents for the provider](https://docs.solvapay.com/api-reference/payment-intents/list-payment-intents-for-the-provider.md): Retrieves a paginated list of all payment intents created by the authenticated provider. Supports pagination through limit and offset query parameters.
- [Process payment intent after client-side confirmation](https://docs.solvapay.com/api-reference/payment-intents/process-payment-intent-after-client-side-confirmation.md): Processes a payment intent that has been confirmed on the client-side using Stripe.js. Polls the database for payment intent status to become succeeded (up to 10 seconds). Returns the current status of the payment intent.
- [Create a plan for a product](https://docs.solvapay.com/api-reference/plans/create-a-plan-for-a-product.md)
- [Delete a plan from a product](https://docs.solvapay.com/api-reference/plans/delete-a-plan-from-a-product.md)
- [Get a plan for a product](https://docs.solvapay.com/api-reference/plans/get-a-plan-for-a-product.md)
- [List plans for a product](https://docs.solvapay.com/api-reference/plans/list-plans-for-a-product.md)
- [Update a plan for a product](https://docs.solvapay.com/api-reference/plans/update-a-plan-for-a-product.md)
- [Clone a product](https://docs.solvapay.com/api-reference/products/clone-a-product.md): Deep-copies a product including all its plans. Generates new references for the clone.
- [Create a product](https://docs.solvapay.com/api-reference/products/create-a-product.md): Creates a new product for the authenticated provider.
- [Delete a product](https://docs.solvapay.com/api-reference/products/delete-a-product.md): Deletes a product permanently in sandbox or when no purchases exist. In live mode with purchases, the product is deactivated instead.
- [Get a product by reference](https://docs.solvapay.com/api-reference/products/get-a-product-by-reference.md): Retrieves a product by its reference or ID, including embedded plans.
- [List products](https://docs.solvapay.com/api-reference/products/list-products.md): Retrieves a paginated list of products for the authenticated provider. Supports filtering by status, search term, and MCP Pay flag.
- [Update a product](https://docs.solvapay.com/api-reference/products/update-a-product.md): Updates an existing product. Only provided fields are updated.
- [Cancel a purchase](https://docs.solvapay.com/api-reference/purchases/cancel-a-purchase.md): Cancels an active purchase. For recurring purchases, cancellation takes effect at the end of the current billing period.
- [Get a purchase by ID or reference](https://docs.solvapay.com/api-reference/purchases/get-a-purchase-by-id-or-reference.md): Retrieves a single purchase including plan snapshot, usage, and billing details.
- [Get purchases for a customer](https://docs.solvapay.com/api-reference/purchases/get-purchases-for-a-customer.md): Retrieves all purchases for a specific customer. Useful for billing history and access checks.
- [Get purchases for a product](https://docs.solvapay.com/api-reference/purchases/get-purchases-for-a-product.md): Retrieves all purchases for a specific product. Each billing period creates a new purchase document.
- [List purchases for provider](https://docs.solvapay.com/api-reference/purchases/list-purchases-for-provider.md): Retrieves all purchases for the authenticated provider with optional filtering by status, product, or customer.
- [Record a usage event](https://docs.solvapay.com/api-reference/usage/record-a-usage-event.md): Records a usage event against a named meter. Events are stored in a high-performance timeseries collection.
- [Record bulk usage events](https://docs.solvapay.com/api-reference/usage/record-bulk-usage-events.md): Records multiple meter events in a single request.
- [Get user info and purchase status](https://docs.solvapay.com/api-reference/user-info/get-user-info-and-purchase-status.md): Returns customer profile, active purchase details including usage and plan info, and a customer portal URL.
- [Choose Your Path](https://docs.solvapay.com/get-started/choose-your-path.md): SolvaPay offers two ways to monetize your services.
- [Create Your Account](https://docs.solvapay.com/get-started/create-account.md): Get started with SolvaPay by creating your provider account.
- [Create a Product](https://docs.solvapay.com/get-started/create-product.md): Create a product to monetize your API, MCP server, or AI-powered service.
- [Go Live](https://docs.solvapay.com/get-started/go-live.md): Once you've tested your integration in sandbox mode, you're ready to switch to production and start accepting real payments.
- [Test in Sandbox](https://docs.solvapay.com/get-started/test-in-sandbox.md): When you create a SolvaPay account, it starts in sandbox mode automatically.
- [SolvaPay Documentation](https://docs.solvapay.com/index.md): Learn how to launch SolvaPay for MCP Pay, wallet features, MCP Server, and the TypeScript SDK.
- [Authentication](https://docs.solvapay.com/mcp-pay/authentication.md): MCP Pay includes a full OAuth 2.0 server with PKCE support, enabling MCP clients like Cursor, Claude Desktop, and other AI tools to securely connect to your paywalled MCP servers.
- [Best Practices](https://docs.solvapay.com/mcp-pay/best-practices.md): This guide covers recommended patterns for configuring your MCP Pay servers, structuring plans, and handling common scenarios.
- [Create a Hosted MCP Pay Product](https://docs.solvapay.com/mcp-pay/create-hosted-mcp-pay-product.md): Use this flow when you want the no-code setup: SolvaPay hosts authentication, identity, billing, and payment.
- [Hosted Pages](https://docs.solvapay.com/mcp-pay/hosted-pages.md): MCP Pay provides fully hosted pages for the complete customer journey—sign-up, checkout, and account management.
- [MCP Pay Overview](https://docs.solvapay.com/mcp-pay/overview.md): MCP Pay is SolvaPay's monetization layer for MCP (Model Context Protocol) servers.
- [MCP Pay Quick Start](https://docs.solvapay.com/mcp-pay/quick-start.md): This quick start helps you choose the right setup flow in SolvaPay's new product-first model.
- [Examples](https://docs.solvapay.com/mcp-server/examples.md): Real-world examples of managing SolvaPay through your AI assistant.
- [FAQ](https://docs.solvapay.com/mcp-server/faq.md): Frequently asked questions about the SolvaPay MCP Server.
- [Getting Started](https://docs.solvapay.com/mcp-server/getting-started.md): Connect SolvaPay MCP Server to your AI assistant to manage customers, plans, purchases, and payments.
- [Installation](https://docs.solvapay.com/mcp-server/installation.md): Connect the SolvaPay MCP Server to your AI assistant.
- [Tools](https://docs.solvapay.com/mcp-server/tools.md): The SolvaPay MCP Server exposes 27 tools across 8 domains.
- [Usage Records](https://docs.solvapay.com/meters/events.md): Record and query usage data — the raw data points that power billing, limits, and analytics.
- [Meters](https://docs.solvapay.com/meters/overview.md): Meters define how usage is measured and aggregated for billing and access control.
- [Billing](https://docs.solvapay.com/plans/billing.md): How SolvaPay handles billing cycles, usage-based billing, and end-of-period processing.
- [Plans](https://docs.solvapay.com/plans/overview.md): Plans define pricing models and access tiers for your products. Each plan type supports different billing strategies.
- [SolvaPay SDK Examples Overview](https://docs.solvapay.com/sdks/typescript/examples/overview.md): This document provides an overview of all available examples in the SolvaPay SDK repository.
- [Core Concepts](https://docs.solvapay.com/sdks/typescript/getting-started/core-concepts.md): Understanding the key concepts in SolvaPay SDK will help you build effective monetization strategies.
- [Installation](https://docs.solvapay.com/sdks/typescript/getting-started/installation.md): This guide covers installing and setting up SolvaPay SDK packages in your project.
- [Introduction](https://docs.solvapay.com/sdks/typescript/getting-started/introduction.md): Learn how to use SolvaPay TypeScript SDK.
- [Quick Start](https://docs.solvapay.com/sdks/typescript/getting-started/quick-start.md): Get up and running with SolvaPay SDK in minutes.
- [Architecture](https://docs.solvapay.com/sdks/typescript/guides/architecture.md): Goal: Clean runtime boundaries, great DX, and focused packages.
- [Custom Authentication Adapters Guide](https://docs.solvapay.com/sdks/typescript/guides/custom-auth.md): This guide shows you how to create custom authentication adapters for SolvaPay SDK to integrate with your authentication system.
- [Error Handling Strategies](https://docs.solvapay.com/sdks/typescript/guides/error-handling.md): This guide covers error handling patterns and best practices for SolvaPay SDK across different frameworks and use cases.
- [Express.js Integration Guide](https://docs.solvapay.com/sdks/typescript/guides/express.md): This guide shows you how to integrate SolvaPay SDK with Express.js to protect your API endpoints with paywall protection and purchase management.
- [MCP Server Integration Guide](https://docs.solvapay.com/sdks/typescript/guides/mcp.md): Add paywall protection, usage tracking, and self-service tools to any MCP server using the SolvaPay TypeScript SDK.
- [Next.js Integration Guide](https://docs.solvapay.com/sdks/typescript/guides/nextjs.md): This guide shows you how to integrate SolvaPay SDK with Next.js App Router to protect your API routes and add payment flows to your application.
- [Performance Optimization](https://docs.solvapay.com/sdks/typescript/guides/performance.md): This guide covers performance optimization strategies for SolvaPay SDK, including caching, request deduplication, and best practices.
- [React Integration Guide](https://docs.solvapay.com/sdks/typescript/guides/react.md): This guide shows you how to integrate SolvaPay React components and hooks into your React application to build payment flows and purchase management UIs.
- [Testing with Stub Mode](https://docs.solvapay.com/sdks/typescript/guides/testing.md): This guide shows you how to test SolvaPay SDK using stub mode, which simulates the SolvaPay backend without making real API calls.
- [Usage Events](https://docs.solvapay.com/sdks/typescript/guides/usage-events.md): Publish usage events from your application to track consumption, enforce limits, and power analytics.
- [Webhook Handling](https://docs.solvapay.com/sdks/typescript/guides/webhooks.md): This guide shows you how to handle SolvaPay webhooks to keep your application in sync with purchase and payment events.
- [TypeScript SDK](https://docs.solvapay.com/sdks/typescript/intro.md): SolvaPay SDK is a modern TypeScript SDK for monetizing APIs, AI agents, and MCP (Model Context Protocol) servers with paywall protection and purchase management.
- [Publishing & Releasing](https://docs.solvapay.com/sdks/typescript/publishing.md): This document describes the automated publishing and release process for SolvaPay SDK packages.
- [How It Works](https://docs.solvapay.com/wallet/how-it-works.md): This page explains the token lifecycle from top-up through to provider settlement, including the ledger system, locking mechanics, and settlement flow.
- [Wallet & Tokens Overview](https://docs.solvapay.com/wallet/overview.md): SolvaPay's token wallet enables prepaid microtransactions for AI agents and API services.
- [Provider Integration](https://docs.solvapay.com/wallet/provider-integration.md): This guide covers how providers accept token payments, track earnings, and receive fiat payouts through Stripe Connect.
- [SDK Integration](https://docs.solvapay.com/wallet/sdk-integration.md): This guide shows how to integrate token-based payments into your service using the SolvaPay SDK.
- [Security & Compliance](https://docs.solvapay.com/wallet/security.md): This page covers the security model, audit capabilities, chargeback handling, and compliance considerations for the SolvaPay token system.
- [Vouchers](https://docs.solvapay.com/wallet/vouchers.md): Vouchers are prepaid, multi-use payment tokens that consumers create from their wallet.

## OpenAPI Specs

- [openapi](https://docs.solvapay.com/api-reference/openapi.json)


Built with [Mintlify](https://mintlify.com).