# FlexPrice

## Docs

- [Authentication](https://mintlify.wiki/flexprice/flexprice/api/authentication.md): Authenticate requests to the FlexPrice API
- [Grant Credits](https://mintlify.wiki/flexprice/flexprice/api/credits/grant.md): Use when giving a customer or plan credits (e.g. prepaid balance or promotional credits). Scope can be plan or subscription; supports start/end dates.
- [List Credit Grants](https://mintlify.wiki/flexprice/flexprice/api/credits/list.md): Retrieve a list of credit grants with optional filtering by scope, plan, or subscription.
- [Create Customer](https://mintlify.wiki/flexprice/flexprice/api/customers/create.md): Create a new billing customer in FlexPrice
- [Delete Customer](https://mintlify.wiki/flexprice/flexprice/api/customers/delete.md): Delete a customer from FlexPrice
- [Get Customer](https://mintlify.wiki/flexprice/flexprice/api/customers/get.md): Retrieve a single customer by ID
- [List Customers](https://mintlify.wiki/flexprice/flexprice/api/customers/list.md): Retrieve a paginated list of customers
- [Update Customer](https://mintlify.wiki/flexprice/flexprice/api/customers/update.md): Update an existing customer's details
- [Error Handling](https://mintlify.wiki/flexprice/flexprice/api/errors.md): Understanding FlexPrice API error codes and formats
- [Batch Ingest Events](https://mintlify.wiki/flexprice/flexprice/api/events/batch.md): Send multiple usage events to FlexPrice in a single request
- [Ingest Event](https://mintlify.wiki/flexprice/flexprice/api/events/ingest.md): Send a single usage event to FlexPrice for metering and billing
- [Query Events](https://mintlify.wiki/flexprice/flexprice/api/events/query.md): Retrieve and filter ingested usage events
- [Check Feature Access](https://mintlify.wiki/flexprice/flexprice/api/features/check-access.md): Use when checking what a customer can access (e.g. feature gating or usage limits). Supports optional filters (feature_ids, subscription_ids).
- [Create Feature](https://mintlify.wiki/flexprice/flexprice/api/features/create.md): Use when defining a new feature or capability to gate or meter (e.g. feature flags or usage-based limits). Ideal for boolean or usage features.
- [List Features](https://mintlify.wiki/flexprice/flexprice/api/features/list.md): Use when listing or searching features (e.g. catalog or entitlement setup). Returns a paginated list; supports filtering and sorting.
- [Finalize Invoice](https://mintlify.wiki/flexprice/flexprice/api/invoices/finalize.md): Use when locking an invoice for payment (e.g. after review). Once finalized, line items are locked; invoice can be paid or voided.
- [Get Invoice](https://mintlify.wiki/flexprice/flexprice/api/invoices/get.md): Use when loading an invoice for display or editing (e.g. portal or reconciliation). Supports group_by for usage breakdown and force_runtime_recalculation.
- [List Invoices](https://mintlify.wiki/flexprice/flexprice/api/invoices/list.md): Use when listing or searching invoices (e.g. admin view or customer history). Returns a paginated list; supports filtering by customer, status, date range.
- [Create Meter](https://mintlify.wiki/flexprice/flexprice/api/meters/create.md): Create a new meter to track usage events with configurable aggregation and filtering.
- [Get Meter](https://mintlify.wiki/flexprice/flexprice/api/meters/get.md): Retrieve details of a specific meter by ID.
- [List Meters](https://mintlify.wiki/flexprice/flexprice/api/meters/list.md): Retrieve a paginated list of all meters in your environment.
- [Update Meter](https://mintlify.wiki/flexprice/flexprice/api/meters/update.md): Update a meter's filters. Other properties are immutable after creation.
- [API Overview](https://mintlify.wiki/flexprice/flexprice/api/overview.md): Introduction to the FlexPrice API
- [Pagination](https://mintlify.wiki/flexprice/flexprice/api/pagination.md): Working with paginated list responses in the FlexPrice API
- [Create Plan](https://mintlify.wiki/flexprice/flexprice/api/plans/create.md): Create a new pricing plan. Use when defining a new pricing tier (e.g. Free, Pro, Enterprise). Attach prices and entitlements; customers subscribe to plans.
- [Get Plan](https://mintlify.wiki/flexprice/flexprice/api/plans/get.md): Retrieve details of a specific plan by ID. Use when you need to load a single plan for display or to create a subscription.
- [List Plans](https://mintlify.wiki/flexprice/flexprice/api/plans/list.md): Retrieve a paginated list of all plans in your environment. Use when listing or searching plans for a plan picker or admin catalog.
- [Update Plan](https://mintlify.wiki/flexprice/flexprice/api/plans/update.md): Update plan details. Use when changing plan name, description, or metadata. Partial update supported.
- [Cancel Subscription](https://mintlify.wiki/flexprice/flexprice/api/subscriptions/cancel.md): Cancel a subscription. Use when a customer churns or downgrades. Supports immediate or end-of-period cancellation with optional proration.
- [Create Subscription](https://mintlify.wiki/flexprice/flexprice/api/subscriptions/create.md): Create a new subscription for a customer. Use when onboarding a customer to a plan or starting a new subscription. Supports draft subscriptions (activate later) or active from start.
- [Get Subscription](https://mintlify.wiki/flexprice/flexprice/api/subscriptions/get.md): Retrieve details of a specific subscription by ID. Use when you need to load a single subscription for a billing portal or to check status.
- [List Subscriptions](https://mintlify.wiki/flexprice/flexprice/api/subscriptions/list.md): Retrieve a paginated list of subscriptions. Supports filtering by customer, plan, and status.
- [Update Subscription](https://mintlify.wiki/flexprice/flexprice/api/subscriptions/update.md): Update subscription details. Use when changing subscription status, cancellation date, or parent relationship. Supports partial updates.
- [Create Wallet](https://mintlify.wiki/flexprice/flexprice/api/wallets/create.md): Create a prepaid or postpaid wallet for a customer to manage credits and usage-based billing.
- [Get Wallet](https://mintlify.wiki/flexprice/flexprice/api/wallets/get.md): Retrieve details of a specific wallet by its ID.
- [Architecture Overview](https://mintlify.wiki/flexprice/flexprice/architecture.md): Understanding FlexPrice's system architecture and technology stack
- [Discount Coupons](https://mintlify.wiki/flexprice/flexprice/billing/coupons.md): Create and manage discount coupons for subscriptions and invoices in FlexPrice
- [Credit Notes & Refunds](https://mintlify.wiki/flexprice/flexprice/billing/credit-notes.md): Issue credit notes, process refunds, and handle billing adjustments in FlexPrice
- [Invoice Generation](https://mintlify.wiki/flexprice/flexprice/billing/invoices.md): Understand invoice structure, generation, and lifecycle management in FlexPrice
- [Payment Processing](https://mintlify.wiki/flexprice/flexprice/billing/payments.md): Handle payment transactions, methods, and retry logic in FlexPrice
- [Subscription Lifecycle](https://mintlify.wiki/flexprice/flexprice/billing/subscriptions.md): Manage subscription states, billing cycles, and lifecycle events in FlexPrice
- [Credits & wallets](https://mintlify.wiki/flexprice/flexprice/concepts/credits.md): Managing prepaid and promotional credits in FlexPrice
- [Customers](https://mintlify.wiki/flexprice/flexprice/concepts/customers.md): Managing customers in FlexPrice's billing system
- [Billing & invoicing](https://mintlify.wiki/flexprice/flexprice/concepts/invoicing.md): How FlexPrice generates invoices and processes payments
- [Usage metering](https://mintlify.wiki/flexprice/flexprice/concepts/metering.md): How FlexPrice tracks and aggregates usage for billing
- [Pricing models](https://mintlify.wiki/flexprice/flexprice/concepts/pricing.md): Understanding FlexPrice's flexible pricing and plan system
- [Multi-tenancy & environments](https://mintlify.wiki/flexprice/flexprice/concepts/tenancy.md): Understanding FlexPrice's tenant and environment isolation model
- [Credit Expiration](https://mintlify.wiki/flexprice/flexprice/credits/expiration.md): Manage credit expiration policies and expired credit processing
- [Credit Grants](https://mintlify.wiki/flexprice/flexprice/credits/grants.md): Automatically allocate credits to customers through plans or subscriptions
- [Auto Top-Up](https://mintlify.wiki/flexprice/flexprice/credits/top-ups.md): Automatically replenish wallet credits when balance falls below a threshold
- [Wallets](https://mintlify.wiki/flexprice/flexprice/credits/wallets.md): Manage customer credit wallets for prepaid and postpaid billing
- [Integrations Overview](https://mintlify.wiki/flexprice/flexprice/integrations/overview.md): Connect FlexPrice with payment providers, CRMs, and accounting platforms
- [Stripe Integration](https://mintlify.wiki/flexprice/flexprice/integrations/stripe.md): Integrate FlexPrice with Stripe for payment processing and subscription management
- [Webhook Configuration](https://mintlify.wiki/flexprice/flexprice/integrations/webhooks.md): Configure webhooks to receive real-time updates from FlexPrice
- [Introduction to FlexPrice](https://mintlify.wiki/flexprice/flexprice/introduction.md): Monetization infrastructure built for AI-native companies
- [Usage Aggregation Methods](https://mintlify.wiki/flexprice/flexprice/metering/aggregations.md): Understand FlexPrice's aggregation types for transforming events into billable usage
- [Event Ingestion](https://mintlify.wiki/flexprice/flexprice/metering/events.md): Send usage events to FlexPrice for metering and billing
- [Meter Configuration](https://mintlify.wiki/flexprice/flexprice/metering/meters.md): Configure meters to transform events into billable usage metrics
- [Metering Overview](https://mintlify.wiki/flexprice/flexprice/metering/overview.md): Understand FlexPrice's usage metering system for tracking and billing customer usage
- [Add-ons](https://mintlify.wiki/flexprice/flexprice/pricing/addons.md): Create optional add-ons to extend plan capabilities
- [Features](https://mintlify.wiki/flexprice/flexprice/pricing/features.md): Manage feature access and usage limits across plans
- [Plans](https://mintlify.wiki/flexprice/flexprice/pricing/plans.md): Define and manage pricing plans for your products
- [Prices](https://mintlify.wiki/flexprice/flexprice/pricing/prices.md): Configure pricing models with flexible billing strategies
- [Tiered Pricing](https://mintlify.wiki/flexprice/flexprice/pricing/tiers.md): Implement volume-based and graduated pricing models
- [Quickstart](https://mintlify.wiki/flexprice/flexprice/quickstart.md): Get FlexPrice running locally and ingest your first usage event
- [Go SDK](https://mintlify.wiki/flexprice/flexprice/sdks/go.md): Type-safe Go client for FlexPrice billing and metering
- [MCP Server](https://mintlify.wiki/flexprice/flexprice/sdks/mcp.md): Model Context Protocol server for AI assistants (Claude, Cursor, VS Code)
- [SDK Overview](https://mintlify.wiki/flexprice/flexprice/sdks/overview.md): Choose the right FlexPrice SDK for your stack
- [Python SDK](https://mintlify.wiki/flexprice/flexprice/sdks/python.md): Type-safe Python client with sync and async support
- [TypeScript SDK](https://mintlify.wiki/flexprice/flexprice/sdks/typescript.md): Type-safe TypeScript/JavaScript client with ESM and CommonJS support
- [Configuration](https://mintlify.wiki/flexprice/flexprice/self-hosting/configuration.md): Configure FlexPrice for your environment
- [Deployment](https://mintlify.wiki/flexprice/flexprice/self-hosting/deployment.md): Deploy FlexPrice in different modes for production
- [Installation](https://mintlify.wiki/flexprice/flexprice/self-hosting/installation.md): Install and set up FlexPrice for self-hosting
- [Scaling](https://mintlify.wiki/flexprice/flexprice/self-hosting/scaling.md): Scale FlexPrice for high availability and performance

## OpenAPI Specs

- [openapi](https://mintlify.wiki/flexprice/flexprice/api-reference/openapi.json)