# SolvaPay Documentation

## Docs

- [Post v1sdkactivate](https://docs.solvapay.com/api-reference/activation/post-v1sdkactivate.md)
- [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 credit balance](https://docs.solvapay.com/api-reference/customers/get-customer-credit-balance.md): Returns the credit balance for a customer identified by reference.
- [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.
- [Update a customer](https://docs.solvapay.com/api-reference/customers/update-a-customer.md): Updates an existing customer identified by reference. Use this to backfill or change fields such as `externalRef`, `name`, or `email`. Only the fields supplied in the body are modified.
- [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.
- [Get merchant identity for the authenticated provider](https://docs.solvapay.com/api-reference/merchant/get-merchant-identity-for-the-authenticated-provider.md): Returns the subset of provider data safe to render in a customer-facing checkout: display name, legal name, support contact, terms and privacy URLs, and logo. Used by SDK components like MandateText and CheckoutSummary.
- [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): Persists each event with recordUsage (same shape as single POST), after shared meter/customer checks.
- [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. Requires an idempotency key to prevent duplicate charges. Returns client secret and publishable key needed for frontend integration.
- [Get a specific payment intent](https://docs.solvapay.com/api-reference/payment-intents/get-a-specific-payment-intent.md): Retrieves detailed information about a specific payment intent including amount, currency, and client secret.
- [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. Polls the database for payment intent status to become succeeded (up to 10 seconds). Returns the current status of the payment intent.
- [Get the default payment method for a customer](https://docs.solvapay.com/api-reference/payment-methods/get-the-default-payment-method-for-a-customer.md): Returns the customer's default card for the authenticated provider. Sourced from stored payment-method records (no Stripe round-trip). Returns `{ kind: 'none' }` when no card is on file.
- [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)
- [Get environment-aware platform config for the authenticated provider](https://docs.solvapay.com/api-reference/platform-config/get-environment-aware-platform-config-for-the-authenticated-provider.md): Returns browser-safe platform values resolved against the provider environment. Today: the SolvaPay platform Stripe publishable key. This endpoint is the canonical home for future platform-wide, environment-gated SDK config (API version hints, feature flags, public hosted URLs) — additions land here…
- [Bootstrap MCP product integration](https://docs.solvapay.com/api-reference/products/bootstrap-mcp-product-integration.md): Creates an MCP-enabled product with a unified plans array, configures origin URL, and maps tools to plans in one request.
- [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.
- [Configure MCP plans on an MCP product](https://docs.solvapay.com/api-reference/products/configure-mcp-plans-on-an-mcp-product.md): Configures plans and optional tool-to-plan mappings for an MCP product.
- [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. In live mode, soft-deletes (preserves data but hides from listings). If the product has purchases in live mode, deactivates 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 reference](https://docs.solvapay.com/api-reference/purchases/get-a-purchase-by-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.
- [Reactivate a cancelled purchase](https://docs.solvapay.com/api-reference/purchases/reactivate-a-cancelled-purchase.md): Reactivates a purchase that was cancelled but has not yet reached its end date. Restores auto-renewal and clears cancellation fields.
- [Record a usage event](https://docs.solvapay.com/api-reference/usage/record-a-usage-event.md): Records a usage event into the Usage timeseries collection.
- [Record bulk usage events](https://docs.solvapay.com/api-reference/usage/record-bulk-usage-events.md): Same persistence rules as POST /sdk/usages for each item: validate batch first, then one insert per event.
- [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.
- [April 2026 release](https://docs.solvapay.com/changelog/2026-04-14.md): Abstract credits, sandbox-first onboarding, Go-Live, usage-based plans, 2FA, cookie consent, and Console improvements.
- [June 2026 release](https://docs.solvapay.com/changelog/2026-06-09.md): OAuth consent for MCP customers, webhook subscriptions, receipts, plan updates, and SDK 1.2.0.
- [Choose your path](https://docs.solvapay.com/get-started/choose-your-path.md): Choose between the CLI-first TypeScript SDK path and the Console-based no-code MCP integration.
- [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 Live mode and start accepting real payments.
- [Test in sandbox](https://docs.solvapay.com/get-started/test-in-sandbox.md): Use sandbox mode to test your integration before or after live activation.
- [Add inline chat checkout with React](https://docs.solvapay.com/guides/add-inline-chat-checkout-react.md): Build inline checkout for agents and apps with SolvaPay React components.
- [Add a paywall to an API or app](https://docs.solvapay.com/guides/add-paywall-to-api-or-app.md): Use the SolvaPay TypeScript SDK to add paywall checks to APIs, apps, and MCP tools with full customization.
- [Handle SolvaPay webhooks safely](https://docs.solvapay.com/guides/handle-webhooks.md): Implement secure webhook verification and event handling for SolvaPay purchases and payments.
- [Manage your account with the admin MCP Server](https://docs.solvapay.com/guides/manage-account-with-admin-mcp.md): Use the SolvaPay admin MCP Server to manage your provider account and create checkout sessions from your AI assistant.
- [Monetize an MCP server without code](https://docs.solvapay.com/guides/monetize-mcp-server-no-code.md): Use the no-code MCP integration to monetize your MCP server without changing server code.
- [Monetize an MCP server with SDK integration](https://docs.solvapay.com/guides/monetize-mcp-server-with-sdk.md): Use the SolvaPay TypeScript SDK to monetize an MCP server with full control over auth, paywall behavior, and tool access.
- [Use the SolvaPay agent skill](https://docs.solvapay.com/guides/use-agent-skill.md): Install the SolvaPay skill with one command in any compatible AI coding tool.
- [SolvaPay documentation](https://docs.solvapay.com/index.md): Documentation for adding authentication, identity, payments, and billing with the no-code MCP integration or the TypeScript SDK.
- [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.
- [Admin MCP Server getting started](https://docs.solvapay.com/mcp-server/getting-started.md): Connect the SolvaPay admin MCP Server to your AI assistant to manage your provider account and generate checkout sessions.
- [Installation](https://docs.solvapay.com/mcp-server/installation.md): Connect the SolvaPay MCP Server to your AI assistant.
- [Test MCP server auth and paywall](https://docs.solvapay.com/mcp-server/testing-auth-and-paywall.md): Validate OAuth authentication and paywall behavior in Claude or Cursor with one shared live-testing flow.
- [Tools](https://docs.solvapay.com/mcp-server/tools.md): Complete reference for the 32 tools exposed by the SolvaPay MCP Server, organised across 8 domains.
- [Authentication](https://docs.solvapay.com/no-code-mcp/authentication.md): The no-code MCP integration 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/no-code-mcp/best-practices.md): This guide covers recommended patterns for configuring your no-code MCP servers, structuring plans, and handling common scenarios.
- [Create a no-code MCP product](https://docs.solvapay.com/no-code-mcp/create-no-code-mcp-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/no-code-mcp/hosted-pages.md): The no-code MCP integration provides fully hosted pages for the complete customer journey—sign-up, checkout, and account management.
- [No-code MCP integration overview](https://docs.solvapay.com/no-code-mcp/overview.md): The no-code MCP integration is SolvaPay's hosted auth and monetization path for MCP servers.
- [No-code MCP quick start](https://docs.solvapay.com/no-code-mcp/quick-start.md): Set up the no-code MCP integration for your MCP server.
- [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 and billing strategy.
- [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.
- [Examples](https://docs.solvapay.com/sdks/typescript/guides/examples.md): Choose the right SolvaPay SDK example project and run it locally.
- [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): Protect Model Context Protocol (MCP) tools with SolvaPay using createSolvaPayMcpServer and registerPayable — the recommended factory that wires the transport, intent tools, paywall, and UI resource for you.
- [MCP App integration guide](https://docs.solvapay.com/sdks/typescript/guides/mcp-app.md): Render SolvaPay checkout and account management inside an MCP host iframe using @solvapay/react and the MCP App adapter.
- [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.
- [Purchase lifecycle management](https://docs.solvapay.com/sdks/typescript/guides/purchase-management.md): Cancel, reactivate, activate plans, and switch between plans using the TypeScript SDK.
- [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.
- [Supabase Edge Functions Guide](https://docs.solvapay.com/sdks/typescript/guides/supabase-edge.md): Deploy SolvaPay payment endpoints as Supabase Edge Functions using @solvapay/server/fetch. Each function is a one-liner.
- [Usage events](https://docs.solvapay.com/sdks/typescript/guides/usage-events.md): Publish usage events from your application for analytics and operational visibility.
- [Webhook Handling](https://docs.solvapay.com/sdks/typescript/guides/webhooks.md): Handle SolvaPay webhooks in your TypeScript application.
- [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.
- [CLI setup](https://docs.solvapay.com/sdks/typescript/setup/cli.md): Set up SolvaPay SDK in your project with a single command.
- [Core concepts](https://docs.solvapay.com/sdks/typescript/setup/core-concepts.md): Understand products, plans, customers, paywall checks, and usage tracking.
- [Installation](https://docs.solvapay.com/sdks/typescript/setup/installation.md): Manual setup for SolvaPay SDK packages and environment variables.
- [Quick start](https://docs.solvapay.com/sdks/typescript/setup/quick-start.md): Set up with CLI and protect your first endpoint in minutes.
- [Webhooks](https://docs.solvapay.com/webhooks.md): Receive real-time notifications when important business events happen in your SolvaPay account.

## OpenAPI Specs

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