# Orvlin

- [Introduction](https://docs.orvlin.com/introduction.md): What Orvlin is, what it does, and where to start
- [Quickstart](https://docs.orvlin.com/quickstart.md): Create a customer, define a price, and send your first usage event
- [Core concepts](https://docs.orvlin.com/core-concepts.md): The objects in Orvlin and how they relate
- [Glossary](https://docs.orvlin.com/glossary.md): Definitions of the billing terms used across Orvlin
- [Pricing models](https://docs.orvlin.com/pricing-models.md): Choose how a price turns usage into an amount
- [Pricing as code](https://docs.orvlin.com/pricing-manifest.md): Declare metrics, prices, and plans in a pricing.yaml file
- [Meter your first API](https://docs.orvlin.com/tutorials/meter-your-first-api.md): Build a complete billing setup for a metered API, from catalog to first invoice
- [Gate features with entitlements](https://docs.orvlin.com/tutorials/gate-features-with-entitlements.md): Block requests for customers who are out of allowance, with a fast cached check
- [Sell prepaid credits](https://docs.orvlin.com/tutorials/sell-prepaid-credits.md): Sell credit packs, check balances before each AI generation, and top up automatically
- [Receive webhooks securely](https://docs.orvlin.com/tutorials/receive-webhooks-securely.md): Verify signatures, process each event once, and recover from failed deliveries
- [Launch a customer portal](https://docs.orvlin.com/tutorials/launch-customer-portal.md): Let customers see usage and invoices, and change plans, inside your own app
- [Test billing with test clocks](https://docs.orvlin.com/tutorials/test-billing-with-test-clocks.md): Simulate a full billing cycle in minutes: usage, renewal, invoice, and payment retry
- [Usage metering](https://docs.orvlin.com/guides/usage-metering.md): Send events reliably and design them so metrics stay accurate
- [Entitlements](https://docs.orvlin.com/guides/entitlements.md): Gate features and enforce limits in your application without slowing requests
- [Prepaid credits](https://docs.orvlin.com/guides/prepaid-credits.md): Sell credit packs, grant credits, and top up balances automatically
- [Invoicing and collection](https://docs.orvlin.com/guides/invoicing-and-collection.md): How invoices are issued, paid, retried, voided, and credited
- [Customer portal](https://docs.orvlin.com/guides/customer-portal.md): Let customers see usage, invoices, and plans, and change their own plan
- [Integrations](https://docs.orvlin.com/guides/integrations.md): Connect tax, CRM, accounting, data warehouses, and cloud marketplaces
- [Single sign-on](https://docs.orvlin.com/guides/sso.md): Sign your team in through your identity provider with OIDC or SAML
- [Security model](https://docs.orvlin.com/enterprise/security-model.md): How Orvlin authenticates people and services, protects credentials, and signs webhooks
- [Approvals](https://docs.orvlin.com/enterprise/approvals.md): Require a second person to approve high-impact billing actions
- [Audit logs](https://docs.orvlin.com/enterprise/audit-logs.md): Find and export a record of every change made in your workspace
- [Environments and sandbox](https://docs.orvlin.com/enterprise/environments.md): Keep test and live billing separate, and promote changes safely
- [Reliability](https://docs.orvlin.com/enterprise/reliability.md): How webhooks, retries, idempotency, and failures behave, and what your systems should do
- [Node.js SDK](https://docs.orvlin.com/sdks/node.md): Check entitlements, track usage, and manage credits from a Node.js server
- [Python SDK](https://docs.orvlin.com/sdks/python.md): Check entitlements, track usage, and manage credits from Python
- [React SDK](https://docs.orvlin.com/sdks/react.md): Show features, balances, and plan options in a React app with the customer portal
- [CLI](https://docs.orvlin.com/sdks/cli.md): The orvlin command-line tool for local development, pricing manifests, and simulations
- [API overview](https://docs.orvlin.com/api-reference/overview.md): Base URL, versioning, authentication, pagination, and how the API is organised
- [Authentication](https://docs.orvlin.com/api-reference/authentication.md): Authenticate API requests with API keys, and manage dashboard sessions
- [API keys](https://docs.orvlin.com/api-reference/api-keys.md): Create, list, and revoke API keys, and choose the right role for each one
- [Errors](https://docs.orvlin.com/api-reference/errors.md): Error responses and how to handle them
- [Events](https://docs.orvlin.com/api-reference/events.md): Send usage events and list them
- [Customers](https://docs.orvlin.com/api-reference/customers.md): Create, read, update, and delete customers, and read their entitlements
- [Metrics](https://docs.orvlin.com/api-reference/metrics.md): Define how events are aggregated into billable quantities
- [Prices](https://docs.orvlin.com/api-reference/prices.md): Charge for a metric or a flat fee, using one of the pricing models
- [Plans](https://docs.orvlin.com/api-reference/plans.md): Bundle prices into plans that customers subscribe to, and publish new versions
- [Subscriptions](https://docs.orvlin.com/api-reference/subscriptions.md): Subscribe customers to plans, change them, and cancel them
- [Invoices](https://docs.orvlin.com/api-reference/invoices.md): List, approve, pay, void, and credit invoices, and read their payment history
- [Credits](https://docs.orvlin.com/api-reference/credits.md): Define credit types, and grant, sell, and track credits in customer wallets
- [Licenses](https://docs.orvlin.com/api-reference/licenses.md): Allocate and deactivate per-seat licenses for customers
- [Webhooks](https://docs.orvlin.com/api-reference/webhooks.md): Receive signed notifications when invoices, subscriptions, and credits change
- [Customer portal API](https://docs.orvlin.com/api-reference/portal.md): Create portal sessions and call customer-facing endpoints with a portal token
- [Approvals](https://docs.orvlin.com/api-reference/approvals.md): Read and change approval policies, and approve or reject requests
- [Audit logs](https://docs.orvlin.com/api-reference/audit-logs.md): List and export audit log entries for your workspace
- [Development](https://docs.orvlin.com/development.md): Run and extend the Orvlin monorepo locally


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.