# Flexprice

## Docs

- [Create addon](https://docs.flexprice.io/api-reference/addons/create-addon.md): Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.
- [Delete addon](https://docs.flexprice.io/api-reference/addons/delete-addon.md): Use when retiring an addon (e.g. end-of-life). Returns 200 with success message.
- [Get addon](https://docs.flexprice.io/api-reference/addons/get-addon.md): Use when you need to load a single addon (e.g. for display or to attach to a subscription).
- [Get addon by lookup key](https://docs.flexprice.io/api-reference/addons/get-addon-by-lookup-key.md): Use when resolving an addon by external id (e.g. from your product catalog). Ideal for integrations.
- [Query addons](https://docs.flexprice.io/api-reference/addons/query-addons.md): Use when listing or searching addons (e.g. catalog or subscription builder). Returns a paginated list; supports filtering and sorting.
- [Update addon](https://docs.flexprice.io/api-reference/addons/update-addon.md): Use when changing addon details (e.g. name, pricing, or metadata).
- [Query alert logs](https://docs.flexprice.io/api-reference/alerts/query-alert-logs.md): Use when viewing or searching alert history (e.g. support triage or customer-facing alert log). Returns a paginated list; supports filtering by type, customer, subscription.
- [Create costsheet](https://docs.flexprice.io/api-reference/costs/create-costsheet.md): Use when setting up a new pricing configuration (e.g. a new product or region). Costsheets group prices and define the default for the environment.
- [Delete costsheet](https://docs.flexprice.io/api-reference/costs/delete-costsheet.md): Use when retiring a costsheet (e.g. end-of-life product). Soft-deletes; status set to deleted.
- [Get active costsheet](https://docs.flexprice.io/api-reference/costs/get-active-costsheet.md): Use when you need the tenant's default pricing configuration (e.g. for checkout or plan display). Returns the active costsheet for the environment.
- [Get combined revenue and cost analytics](https://docs.flexprice.io/api-reference/costs/get-combined-revenue-and-cost-analytics.md): Use when building dashboards or reports that need revenue vs cost, ROI, and margin over a time period (e.g. finance views or executive summaries).
- [Get combined revenue and cost analytics (V2)](https://docs.flexprice.io/api-reference/costs/get-combined-revenue-and-cost-analytics-v2.md): Use when you need the same revenue/cost/ROI analytics but computed from the costsheet usage-tracking pipeline (e.g. for consistency with usage-based cost data).
- [Get costsheet](https://docs.flexprice.io/api-reference/costs/get-costsheet.md): Use when you need to load a single costsheet (e.g. for editing or display). Supports optional expand for related prices.
- [Query costsheets](https://docs.flexprice.io/api-reference/costs/query-costsheets.md): Use when listing or searching costsheets (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.
- [Update costsheet](https://docs.flexprice.io/api-reference/costs/update-costsheet.md): Use when changing costsheet name or metadata.
- [Create coupon](https://docs.flexprice.io/api-reference/coupons/create-coupon.md): Use when creating a discount (e.g. promo code or referral). Ideal for percent or fixed value, with optional validity and usage limits.
- [Delete coupon](https://docs.flexprice.io/api-reference/coupons/delete-coupon.md): Use when retiring a coupon (e.g. campaign ended). Returns 200 with success message.
- [Get coupon](https://docs.flexprice.io/api-reference/coupons/get-coupon.md): Use when you need to load a single coupon (e.g. for display or to validate a code).
- [Query coupons](https://docs.flexprice.io/api-reference/coupons/query-coupons.md): Use when listing or searching coupons (e.g. promo management). Returns a paginated list; supports filtering and sorting.
- [Update coupon](https://docs.flexprice.io/api-reference/coupons/update-coupon.md): Use when changing coupon config (e.g. value, validity, or usage limits).
- [Create credit grant](https://docs.flexprice.io/api-reference/credit-grants/create-credit-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.
- [Delete credit grant](https://docs.flexprice.io/api-reference/credit-grants/delete-credit-grant.md): Use when removing or ending a credit grant (e.g. revoke promo or close prepaid). Plan-scoped grants are archived; subscription-scoped supports optional effective_date in body.
- [Get credit grant](https://docs.flexprice.io/api-reference/credit-grants/get-credit-grant.md): Use when you need to load a single credit grant (e.g. for display or to check balance).
- [Get plan credit grants](https://docs.flexprice.io/api-reference/credit-grants/get-plan-credit-grants.md): Use when listing credits attached to a plan (e.g. included prepaid or promo credits).
- [Update credit grant](https://docs.flexprice.io/api-reference/credit-grants/update-credit-grant.md): Use when changing a credit grant (e.g. amount or end date). Request body contains the fields to update.
- [Create credit note](https://docs.flexprice.io/api-reference/credit-notes/create-credit-note.md): Use when issuing a refund or adjustment (e.g. customer dispute or proration). Links to an invoice; create as draft then finalize.
- [Finalize credit note](https://docs.flexprice.io/api-reference/credit-notes/finalize-credit-note.md): Use when locking a draft credit note and applying the credit (e.g. after approval). Once finalized, applied per billing provider.
- [Get credit note](https://docs.flexprice.io/api-reference/credit-notes/get-credit-note.md): Use when you need to load a single credit note (e.g. for display or reconciliation).
- [Void credit note](https://docs.flexprice.io/api-reference/credit-notes/void-credit-note.md): Use when cancelling a draft credit note (e.g. created by mistake). Only draft credit notes can be voided.
- [Create customer](https://docs.flexprice.io/api-reference/customers/create-customer.md): Use when onboarding a new billing customer (e.g. sign-up or CRM sync). Ideal for linking via external_customer_id to your app's user id.
- [Delete customer](https://docs.flexprice.io/api-reference/customers/delete-customer.md): Use when removing a customer (e.g. GDPR or churn). Returns 204 No Content on success.
- [Get customer](https://docs.flexprice.io/api-reference/customers/get-customer.md): Use when you need to load a single customer (e.g. for a billing portal or to attach a subscription).
- [Get customer by external ID](https://docs.flexprice.io/api-reference/customers/get-customer-by-external-id.md): Use when resolving a customer by your app's id (e.g. from your user table). Ideal for integrations that key by external id.
- [Get customer entitlements](https://docs.flexprice.io/api-reference/customers/get-customer-entitlements.md): Use when checking what a customer can access (e.g. feature gating or usage limits). Supports optional filters (feature_ids, subscription_ids).
- [Get customer usage summary](https://docs.flexprice.io/api-reference/customers/get-customer-usage-summary.md): Use when showing a customer's usage (e.g. portal or overage alerts). Identify by customer_id or customer_lookup_key; supports filters.
- [Get upcoming credit grant applications](https://docs.flexprice.io/api-reference/customers/get-upcoming-credit-grant-applications.md): Use when showing upcoming or pending credits for a customer (e.g. in a portal or for forecasting).
- [Query customers](https://docs.flexprice.io/api-reference/customers/query-customers.md): Use when listing or searching customers (e.g. admin CRM or reporting). Returns a paginated list; supports filtering and sorting.
- [Update customer](https://docs.flexprice.io/api-reference/customers/update-customer.md): Use when updating customer details (e.g. name, email, or metadata). Identify by id or external_customer_id.
- [Create entitlement](https://docs.flexprice.io/api-reference/entitlements/create-entitlement.md): Use when attaching a feature (and its limit) to a plan or addon (e.g. "10 seats" or "1000 API calls"). Defines what the plan/addon includes.
- [Create entitlements in bulk](https://docs.flexprice.io/api-reference/entitlements/create-entitlements-in-bulk.md): Use when attaching many features to a plan or addon at once (e.g. initial plan setup or import). Bulk version of create entitlement.
- [Delete entitlement](https://docs.flexprice.io/api-reference/entitlements/delete-entitlement.md): Use when removing a feature from a plan or addon (e.g. deprecating a capability). Returns 200 with success message.
- [Get addon entitlements](https://docs.flexprice.io/api-reference/entitlements/get-addon-entitlements.md): Use when checking what features or limits an addon grants (e.g. for display or entitlement logic).
- [Get entitlement](https://docs.flexprice.io/api-reference/entitlements/get-entitlement.md): Use when you need to load a single entitlement (e.g. to display or edit a feature limit).
- [Get plan entitlements](https://docs.flexprice.io/api-reference/entitlements/get-plan-entitlements.md): Use when checking what a plan includes (e.g. feature list or limits for display or gating).
- [Query entitlements](https://docs.flexprice.io/api-reference/entitlements/query-entitlements.md): Use when listing or searching entitlements (e.g. plan editor or audit). Returns a paginated list; supports filtering by plan, addon, feature.
- [Update entitlement](https://docs.flexprice.io/api-reference/entitlements/update-entitlement.md): Use when changing an entitlement (e.g. increasing or decreasing a limit). Request body contains the fields to update.
- [Clone an environment](https://docs.flexprice.io/api-reference/environments/clone-an-environment.md): Clone all published features and plans from the source environment into a target environment. If target_environment_id is provided, entities are cloned into that existing environment. Otherwise a new environment is created from name and type first.
- [Error responses](https://docs.flexprice.io/api-reference/error-responses.md): Understand Flexprice API error response formats and error codes
- [Bulk ingest events](https://docs.flexprice.io/api-reference/events/bulk-ingest-events.md): Use when batching usage events (e.g. backfill or high-volume ingestion). More efficient than single event calls; returns 202 when accepted.
- [Get event](https://docs.flexprice.io/api-reference/events/get-event.md): Use when debugging a specific event (e.g. why it failed or how it was aggregated). Includes processing status and debug info.
- [Get Hugging Face inference data](https://docs.flexprice.io/api-reference/events/get-hugging-face-inference-data.md): Use when fetching Hugging Face inference usage or billing data (e.g. for HF-specific reporting or reconciliation).
- [Get usage analytics](https://docs.flexprice.io/api-reference/events/get-usage-analytics.md): Use when building analytics views (e.g. usage by feature or customer over time). Supports filtering, grouping, and time-series breakdown.
- [Get usage by meter](https://docs.flexprice.io/api-reference/events/get-usage-by-meter.md): Use when showing usage for a specific meter (e.g. dashboard or overage check). Supports time range, filters, and grouping by customer or subscription.
- [Get usage statistics](https://docs.flexprice.io/api-reference/events/get-usage-statistics.md): Use when building usage reports or dashboards across events. Supports filters and grouping; defaults to last 7 days if no range provided.
- [Ingest event](https://docs.flexprice.io/api-reference/events/ingest-event.md): Use when sending a single usage event from your app (e.g. one API call or one GB stored). Events are processed asynchronously; returns 202 with event_id.
- [List raw events](https://docs.flexprice.io/api-reference/events/list-raw-events.md): Use when debugging ingestion or exporting raw event data (e.g. support or audit). Returns a paginated list; supports time range and sorting.
- [Clone a feature](https://docs.flexprice.io/api-reference/features/clone-a-feature.md): Clone an existing feature
- [Create feature](https://docs.flexprice.io/api-reference/features/create-feature.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.
- [Delete feature](https://docs.flexprice.io/api-reference/features/delete-feature.md): Use when retiring a feature (e.g. deprecated capability). Returns 200 with success message.
- [Query features](https://docs.flexprice.io/api-reference/features/query-features.md): Use when listing or searching features (e.g. catalog or entitlement setup). Returns a paginated list; supports filtering and sorting.
- [Update feature](https://docs.flexprice.io/api-reference/features/update-feature.md): Use when changing feature definition (e.g. name, type, or meter). Request body contains the fields to update.
- [Create group](https://docs.flexprice.io/api-reference/groups/create-group.md): Use when organizing entities into a group (e.g. for filtering prices or plans by product line or region).
- [Delete group](https://docs.flexprice.io/api-reference/groups/delete-group.md): Use when removing a group and clearing its entity associations (e.g. retiring a product line). Returns 204 or 200 on success.
- [Get group](https://docs.flexprice.io/api-reference/groups/get-group.md): Use when you need to load a single group (e.g. for display or to assign entities).
- [Query groups](https://docs.flexprice.io/api-reference/groups/query-groups.md): Use when listing or searching groups (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.
- [Link integration mapping](https://docs.flexprice.io/api-reference/integrations/link-integration-mapping.md): Link a FlexPrice entity to provider entity with provider-specific side effects.
- [Introduction](https://docs.flexprice.io/api-reference/introduction.md)
- [Attempt invoice payment](https://docs.flexprice.io/api-reference/invoices/attempt-invoice-payment.md): Use when paying an invoice with the customer's wallet balance (e.g. prepaid credits or balance applied at checkout).
- [Create one-off invoice](https://docs.flexprice.io/api-reference/invoices/create-one-off-invoice.md): Use when creating a manual or one-off invoice (e.g. custom charge or non-recurring billing). Invoice is created in draft; finalize when ready.
- [Finalize invoice](https://docs.flexprice.io/api-reference/invoices/finalize-invoice.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 customer invoice summary](https://docs.flexprice.io/api-reference/invoices/get-customer-invoice-summary.md): Use when showing a customer's invoice overview (e.g. billing portal or balance summary). Includes totals and multi-currency breakdown.
- [Get invoice](https://docs.flexprice.io/api-reference/invoices/get-invoice.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.
- [Get invoice PDF](https://docs.flexprice.io/api-reference/invoices/get-invoice-pdf.md): Use when delivering an invoice PDF to the customer (e.g. email attachment or download). Use url=true for a presigned URL instead of binary. Use force_generate=true to regenerate and re-upload the PDF even if one already exists in S3.
- [Get invoice preview](https://docs.flexprice.io/api-reference/invoices/get-invoice-preview.md): Use when showing a customer what they will be charged (e.g. preview before checkout or plan change). No invoice is created.
- [Get invoice preview using meter_usage data](https://docs.flexprice.io/api-reference/invoices/get-invoice-preview-using-meter_usage-data.md): Preview invoice using the meter_usage table for usage data instead of feature_usage.
- [Query invoices](https://docs.flexprice.io/api-reference/invoices/query-invoices.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.
- [Recalculate draft invoice (v2)](https://docs.flexprice.io/api-reference/invoices/recalculate-draft-invoice-v2.md): Recalculates a draft SUBSCRIPTION invoice in-place (replaces line items, reapplies credits/coupons/taxes). Use when subscription or usage data changed before finalizing.
- [Recalculate invoice (voided invoice)](https://docs.flexprice.io/api-reference/invoices/recalculate-invoice-voided-invoice.md): Starts an async workflow that creates a fresh replacement invoice for a voided SUBSCRIPTION invoice (same billing period). Returns workflow_id and run_id; poll workflow status or GET the new invoice via recalculated_invoice_id after completion.
- [Trigger invoice communication webhook](https://docs.flexprice.io/api-reference/invoices/trigger-invoice-communication-webhook.md): Use when sending an invoice to the customer (e.g. trigger email or Slack). Payload includes full invoice details for your integration.
- [Update invoice](https://docs.flexprice.io/api-reference/invoices/update-invoice.md): Use when updating invoice metadata or due date (e.g. PDF URL, net terms). For paid invoices only safe fields can be updated.
- [Update invoice payment status](https://docs.flexprice.io/api-reference/invoices/update-invoice-payment-status.md): Use when reconciling payment status from an external gateway or manual entry (e.g. mark paid after bank confirmation).
- [Void invoice](https://docs.flexprice.io/api-reference/invoices/void-invoice.md): Use when cancelling an invoice (e.g. order cancelled or duplicate). Only unpaid invoices can be voided.
- [Get meter usage analytics](https://docs.flexprice.io/api-reference/meterusage/get-meter-usage-analytics.md): Query aggregated usage from meter_usage table for multiple meters
- [Query meter usage](https://docs.flexprice.io/api-reference/meterusage/query-meter-usage.md): Query aggregated usage from meter_usage table for a single meter with optional time-window bucketing
- [Pagination](https://docs.flexprice.io/api-reference/pagination.md): Learn how to paginate through API responses using offset-based pagination
- [Create payment](https://docs.flexprice.io/api-reference/payments/create-payment.md): Use when recording a payment against an invoice (e.g. after receiving funds via a gateway or manual entry).
- [Delete payment](https://docs.flexprice.io/api-reference/payments/delete-payment.md): Use when removing or voiding a payment record (e.g. correcting erroneous entries). Returns 200 with success message.
- [Get payment](https://docs.flexprice.io/api-reference/payments/get-payment.md): Use when you need to load a single payment (e.g. for a receipt view or reconciliation).
- [List payments](https://docs.flexprice.io/api-reference/payments/list-payments.md): Use when listing or searching payments (e.g. reconciliation UI or customer payment history). Returns a paginated list; supports filtering by customer, invoice, status.
- [Process payment](https://docs.flexprice.io/api-reference/payments/process-payment.md): Use when you need to charge or process a payment (e.g. trigger the payment provider to capture funds). Returns updated payment with status.
- [Update payment](https://docs.flexprice.io/api-reference/payments/update-payment.md): Use when updating payment status or metadata (e.g. after reconciliation or adding a reference).
- [Clone a plan](https://docs.flexprice.io/api-reference/plans/clone-a-plan.md): Clone an existing plan, copying its active prices, published entitlements, and published credit grants
- [Create plan](https://docs.flexprice.io/api-reference/plans/create-plan.md): Use when defining a new pricing plan (e.g. Free, Pro, Enterprise). Attach prices and entitlements; customers subscribe to plans.
- [Delete plan](https://docs.flexprice.io/api-reference/plans/delete-plan.md): Use when retiring a plan (e.g. end-of-life). Existing subscriptions may be affected. Returns 200 with success message.
- [Get plan](https://docs.flexprice.io/api-reference/plans/get-plan.md): Use when you need to load a single plan (e.g. for display or to create a subscription).
- [Query plans](https://docs.flexprice.io/api-reference/plans/query-plans.md): Use when listing or searching plans (e.g. plan picker or admin catalog). Returns a paginated list; supports filtering and sorting.
- [Synchronize plan prices](https://docs.flexprice.io/api-reference/plans/synchronize-plan-prices.md): Use when you have changed plan prices and need to push them to all active subscriptions (e.g. global price update). Returns workflow ID.
- [Update plan](https://docs.flexprice.io/api-reference/plans/update-plan.md): Use when changing plan details (e.g. name, interval, or metadata). Partial update supported.
- [Create price unit](https://docs.flexprice.io/api-reference/price-units/create-price-unit.md): Use when defining a new unit of measure for pricing (e.g. GB, API call, seat). Ideal for metered or usage-based prices.
- [Delete price unit](https://docs.flexprice.io/api-reference/price-units/delete-price-unit.md): Use when removing a price unit that is no longer needed. Fails if any price references this unit.
- [Get price unit](https://docs.flexprice.io/api-reference/price-units/get-price-unit.md): Use when you need to load a single price unit (e.g. for display or when creating a price).
- [Get price unit by code](https://docs.flexprice.io/api-reference/price-units/get-price-unit-by-code.md): Use when resolving a price unit by code (e.g. from an external catalog or config). Ideal for integrations.
- [List price units](https://docs.flexprice.io/api-reference/price-units/list-price-units.md): Use when listing price units (e.g. in a catalog or when creating prices). Returns a paginated list; supports status, sort, and pagination.
- [Query price units](https://docs.flexprice.io/api-reference/price-units/query-price-units.md): Use when searching or listing price units (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.
- [Update price unit](https://docs.flexprice.io/api-reference/price-units/update-price-unit.md): Use when renaming or updating metadata for a price unit. Code is immutable once created.
- [Create price](https://docs.flexprice.io/api-reference/prices/create-price.md): Use when adding a new price to a plan or catalog (e.g. per-seat, flat, or metered). Ideal for both simple and usage-based pricing.
- [Create prices in bulk](https://docs.flexprice.io/api-reference/prices/create-prices-in-bulk.md): Use when creating many prices at once (e.g. importing a catalog or setting up a plan with multiple tiers).
- [Delete price](https://docs.flexprice.io/api-reference/prices/delete-price.md): Use when retiring a price (e.g. end-of-life or replacement). Optional effective date or cascade for subscriptions.
- [Get price](https://docs.flexprice.io/api-reference/prices/get-price.md): Use when you need to load a single price (e.g. for display or editing). Response includes expanded meter and price unit when applicable.
- [Get price by lookup key](https://docs.flexprice.io/api-reference/prices/get-price-by-lookup-key.md): Use when resolving a price by external id (e.g. from your catalog or CMS). Ideal for integrations.
- [Query prices](https://docs.flexprice.io/api-reference/prices/query-prices.md): Use when listing or searching prices (e.g. plan builder or catalog). Returns a paginated list; supports filtering and sorting.
- [Update price](https://docs.flexprice.io/api-reference/prices/update-price.md): Use when changing price configuration (e.g. amount, billing scheme, or metadata).
- [Get a specific RBAC role](https://docs.flexprice.io/api-reference/rbac/get-a-specific-rbac-role.md): Use when you need to show or edit a single role (e.g. role detail page). Includes permissions, name, and description.
- [List all RBAC roles](https://docs.flexprice.io/api-reference/rbac/list-all-rbac-roles.md): Use when building role pickers or permission UIs. Returns all roles with permissions and descriptions.
- [Create scheduled task](https://docs.flexprice.io/api-reference/scheduled-tasks/create-scheduled-task.md): Use when setting up recurring data exports or other scheduled jobs. Ideal for report generation or syncing data on a schedule.
- [Delete a scheduled task](https://docs.flexprice.io/api-reference/scheduled-tasks/delete-a-scheduled-task.md): Use when removing a scheduled task from the active roster. Archives the task and removes it from the scheduler (soft delete).
- [Get scheduled task](https://docs.flexprice.io/api-reference/scheduled-tasks/get-scheduled-task.md): Use when you need to load a single scheduled task (e.g. to show details in a UI or check its configuration).
- [List scheduled tasks](https://docs.flexprice.io/api-reference/scheduled-tasks/list-scheduled-tasks.md): Use when listing or managing scheduled tasks in an admin UI. Returns a list; supports filtering by status, type, and pagination.
- [Schedule draft finalization](https://docs.flexprice.io/api-reference/scheduled-tasks/schedule-draft-finalization.md): Triggers the draft invoice finalization workflow that scans computed draft invoices whose finalization delay has elapsed and finalizes them (assign invoice number, sync to vendors, attempt payment).
- [Schedule update billing period](https://docs.flexprice.io/api-reference/scheduled-tasks/schedule-update-billing-period.md): Use when you need to trigger a billing-period update workflow (e.g. to recalculate or sync billing windows).
- [Trigger force run](https://docs.flexprice.io/api-reference/scheduled-tasks/trigger-force-run.md): Use when you need to run a scheduled export immediately (e.g. on-demand report or catch-up). Supports optional custom time range.
- [Update a scheduled task](https://docs.flexprice.io/api-reference/scheduled-tasks/update-a-scheduled-task.md): Use when pausing or resuming a scheduled task. Only the enabled field can be changed.
- [Create a new API key](https://docs.flexprice.io/api-reference/secrets/create-a-new-api-key.md): Use when issuing a new API key (e.g. for a service account or for the current user). Provide service_account_id to create for a service account.
- [Delete an API key](https://docs.flexprice.io/api-reference/secrets/delete-an-api-key.md): Use when revoking an API key (e.g. rotation or compromise). Permanently invalidates the key.
- [List API keys](https://docs.flexprice.io/api-reference/secrets/list-api-keys.md): Use when listing API keys (e.g. admin view or rotating keys). Returns a paginated list.
- [Activate draft subscription](https://docs.flexprice.io/api-reference/subscriptions/activate-draft-subscription.md): Use when turning a draft subscription live (e.g. after collecting payment or completing setup). Once activated, billing and entitlements apply.
- [Add addon to subscription](https://docs.flexprice.io/api-reference/subscriptions/add-addon-to-subscription.md): Use when adding an optional product or add-on to an existing subscription (e.g. extra storage or support tier).
- [Cancel subscription](https://docs.flexprice.io/api-reference/subscriptions/cancel-subscription.md): Use when a customer churns or downgrades. Supports immediate or end-of-period cancellation and proration. Ideal for self-serve or support-driven cancellations.
- [Cancel subscription schedule](https://docs.flexprice.io/api-reference/subscriptions/cancel-subscription-schedule.md): Use when cancelling a scheduled change (e.g. customer changed mind). Identify by schedule ID in path or by subscription ID + schedule type in body.
- [Create subscription](https://docs.flexprice.io/api-reference/subscriptions/create-subscription.md): Use when onboarding a customer to a plan or starting a new subscription. Ideal for draft subscriptions (activate later) or active from start.
- [Create subscription line item](https://docs.flexprice.io/api-reference/subscriptions/create-subscription-line-item.md): Use when adding a new charge or seat to a subscription (e.g. extra seat or one-time add). Supports price_id or inline price.
- [Delete subscription line item](https://docs.flexprice.io/api-reference/subscriptions/delete-subscription-line-item.md): Use when removing a charge or seat from a subscription (e.g. downgrade). Line item ends; retained for history but no longer billed.
- [Execute subscription modification](https://docs.flexprice.io/api-reference/subscriptions/execute-subscription-modification.md): Execute a mid-cycle subscription modification (inheritance or quantity change).
- [Execute subscription plan change](https://docs.flexprice.io/api-reference/subscriptions/execute-subscription-plan-change.md): Use when applying a plan change (e.g. upgrade or downgrade). Executes proration and generates invoice or credit as needed.
- [Get active addon associations](https://docs.flexprice.io/api-reference/subscriptions/get-active-addon-associations.md): Use when listing which add-ons are currently attached to a subscription (e.g. for display or editing).
- [Get subscription](https://docs.flexprice.io/api-reference/subscriptions/get-subscription.md): Use when you need to load a single subscription (e.g. for a billing portal or to check status).
- [Get subscription entitlements](https://docs.flexprice.io/api-reference/subscriptions/get-subscription-entitlements.md): Use when checking what features or limits a subscription has (e.g. entitlement checks or feature gating). Optional feature_ids to filter.
- [Get subscription schedule](https://docs.flexprice.io/api-reference/subscriptions/get-subscription-schedule.md): Use when you need to load a single scheduled change (e.g. to show when a plan change or renewal takes effect).
- [Get subscription (V2)](https://docs.flexprice.io/api-reference/subscriptions/get-subscription-v2.md): Use when you need a subscription with related data (line items, prices, plan). Supports expand for detailed payloads without extra round-trips.
- [Get upcoming credit grant applications](https://docs.flexprice.io/api-reference/subscriptions/get-upcoming-credit-grant-applications.md): Use when showing upcoming or pending credits for a subscription (e.g. in a portal or for forecasting).
- [Get usage by subscription](https://docs.flexprice.io/api-reference/subscriptions/get-usage-by-subscription.md): Use when showing usage for a subscription (e.g. in a portal or for overage checks). Supports time range and filters.
- [List all subscription schedules](https://docs.flexprice.io/api-reference/subscriptions/list-all-subscription-schedules.md): Use when listing or searching scheduled changes across subscriptions (e.g. admin view). Returns schedules with optional filtering.
- [List subscription schedules](https://docs.flexprice.io/api-reference/subscriptions/list-subscription-schedules.md): Use when listing scheduled changes for a subscription (e.g. upcoming plan change or renewal). Returns all schedules for that subscription.
- [Preview subscription modification](https://docs.flexprice.io/api-reference/subscriptions/preview-subscription-modification.md): Preview the impact of a mid-cycle subscription modification without committing changes.
- [Preview subscription plan change](https://docs.flexprice.io/api-reference/subscriptions/preview-subscription-plan-change.md): Use when showing a customer the cost of a plan change before they confirm (e.g. upgrade/downgrade preview with proration).
- [Query subscriptions](https://docs.flexprice.io/api-reference/subscriptions/query-subscriptions.md): Use when listing or searching subscriptions (e.g. admin view or customer subscription list). Returns a paginated list; supports filtering by customer, plan, status.
- [Remove addon from subscription](https://docs.flexprice.io/api-reference/subscriptions/remove-addon-from-subscription.md): Use when removing an add-on from a subscription (e.g. downgrade or opt-out).
- [Update subscription](https://docs.flexprice.io/api-reference/subscriptions/update-subscription.md): Use when changing subscription details (e.g. quantity, billing anchor, or parent). Supports partial update; send "" to clear parent_subscription_id.
- [Update subscription line item](https://docs.flexprice.io/api-reference/subscriptions/update-subscription-line-item.md): Use when changing a subscription line item (e.g. quantity or price). Implemented by ending the current line and creating a new one for clean billing.
- [Create a new task](https://docs.flexprice.io/api-reference/tasks/create-a-new-task.md): Use when submitting a file or job for async processing (e.g. export or import). Returns task ID to poll for status and result.
- [Download task export file](https://docs.flexprice.io/api-reference/tasks/download-task-export-file.md): Use when letting a user download an exported file (e.g. report or data export). Returns a presigned URL; supports FlexPrice or customer-owned S3.
- [Get a task](https://docs.flexprice.io/api-reference/tasks/get-a-task.md): Use when checking task status or progress (e.g. polling after create). Returns task by ID.
- [Get task processing result](https://docs.flexprice.io/api-reference/tasks/get-task-processing-result.md): Use when fetching the outcome of a completed task (e.g. export URL or error message). Call after task status is complete.
- [List tasks](https://docs.flexprice.io/api-reference/tasks/list-tasks.md): Use when listing or searching async tasks (e.g. admin queue view). Returns list with optional filtering.
- [Update task status](https://docs.flexprice.io/api-reference/tasks/update-task-status.md): Use when updating task status (e.g. marking complete or failed from a worker). Typically called by backend processors.
- [Create Tax Association](https://docs.flexprice.io/api-reference/tax-associations/create-tax-association.md): Use when linking a tax rate to an entity (e.g. customer, product, or region) so that rate applies on invoices.
- [Delete tax association](https://docs.flexprice.io/api-reference/tax-associations/delete-tax-association.md): Use when removing a tax association (e.g. entity no longer subject to that rate).
- [Get Tax Association](https://docs.flexprice.io/api-reference/tax-associations/get-tax-association.md): Use when you need to load a single tax association (e.g. for display or editing).
- [List tax associations](https://docs.flexprice.io/api-reference/tax-associations/list-tax-associations.md): Use when listing tax associations (e.g. tax config or audit). Returns list with optional filtering.
- [Update tax association](https://docs.flexprice.io/api-reference/tax-associations/update-tax-association.md): Use when changing a tax association (e.g. switch rate or entity). Request body contains the fields to update.
- [Create a tax rate](https://docs.flexprice.io/api-reference/tax-rates/create-a-tax-rate.md): Use when defining a new tax rate (e.g. VAT or sales tax) for use in invoices. Attach to customers or products via tax associations.
- [Delete a tax rate](https://docs.flexprice.io/api-reference/tax-rates/delete-a-tax-rate.md): Use when retiring a tax rate (e.g. no longer applicable). Fails if still referenced by associations.
- [Get a tax rate](https://docs.flexprice.io/api-reference/tax-rates/get-a-tax-rate.md): Use when you need to load a single tax rate (e.g. for display or when creating an association).
- [Get tax rates](https://docs.flexprice.io/api-reference/tax-rates/get-tax-rates.md): Use when listing tax rates (e.g. tax config UI). Returns tax rates with optional filters.
- [Update a tax rate](https://docs.flexprice.io/api-reference/tax-rates/update-a-tax-rate.md): Use when changing a tax rate (e.g. rate value or name). Request body contains the fields to update.
- [Get billing usage for the current tenant](https://docs.flexprice.io/api-reference/tenants/get-billing-usage-for-the-current-tenant.md): Use when showing the current tenant's billing usage (e.g. admin billing page or usage caps). Returns subscription and usage for the tenant.
- [Get tenant by ID](https://docs.flexprice.io/api-reference/tenants/get-tenant-by-id.md): Get tenant by ID
- [Update a tenant](https://docs.flexprice.io/api-reference/tenants/update-a-tenant.md): Use when changing tenant details (e.g. name or billing info). Request body contains the fields to update.
- [Create user or service account](https://docs.flexprice.io/api-reference/users/create-user-or-service-account.md): Create a user account (type=user, email required; returns user + password for login) or a service account (type=service_account, roles required) for API/automation access.
- [Get current user](https://docs.flexprice.io/api-reference/users/get-current-user.md): Use to show the logged-in user's profile in the UI or to check permissions and roles for the current session.
- [Query users](https://docs.flexprice.io/api-reference/users/query-users.md): Use when listing or searching service accounts in an admin UI, or when auditing who has API access and which roles they have.
- [Create a new wallet](https://docs.flexprice.io/api-reference/wallets/create-a-new-wallet.md): Use when giving a customer a prepaid or credit balance (e.g. prepaid plans or promotional credits).
- [Get Customer Wallets](https://docs.flexprice.io/api-reference/wallets/get-customer-wallets.md): Use when resolving wallets by external customer id or lookup key (e.g. from your app's user id). Supports optional real-time balance and expand.
- [Get wallet](https://docs.flexprice.io/api-reference/wallets/get-wallet.md): Use when you need to load a single wallet (e.g. for a balance or settings view).
- [Get wallet balance](https://docs.flexprice.io/api-reference/wallets/get-wallet-balance.md): Use when displaying or checking current wallet balance (e.g. before charging or in a portal). Supports optional expand for credits breakdown and from_cache.
- [Get wallet transactions](https://docs.flexprice.io/api-reference/wallets/get-wallet-transactions.md): Use when showing transaction history for a wallet (e.g. credit/debit log or audit). Returns a paginated list; supports limit, offset, and filters.
- [Get wallets by customer ID](https://docs.flexprice.io/api-reference/wallets/get-wallets-by-customer-id.md): Use when showing a customer's wallets (e.g. balance overview by currency or in a billing portal). Supports optional expand for balance breakdown.
- [Query wallet transactions](https://docs.flexprice.io/api-reference/wallets/query-wallet-transactions.md): Use when searching or reporting on wallet transactions (e.g. cross-wallet history or reconciliation). Returns a paginated list; supports filtering by wallet, customer, type, date range.
- [Query wallets](https://docs.flexprice.io/api-reference/wallets/query-wallets.md): Use when listing or searching wallets (e.g. admin view or reporting). Returns a paginated list; supports filtering by customer and status.
- [Terminate a wallet](https://docs.flexprice.io/api-reference/wallets/terminate-a-wallet.md): Use when closing a customer wallet (e.g. churn or migration). Closes the wallet and applies remaining balance per policy (refund or forfeit).
- [Top up wallet](https://docs.flexprice.io/api-reference/wallets/top-up-wallet.md): Use when adding funds to a wallet (e.g. top-up, refund, or manual credit). Supports optional idempotency via reference.
- [Update a wallet](https://docs.flexprice.io/api-reference/wallets/update-a-wallet.md): Use when changing wallet settings (e.g. enabling or updating auto top-up thresholds).
- [credit_note.created](https://docs.flexprice.io/api-reference/webhook-events/credit_notecreated.md): Fired when a new credit note is created. Doc-only for parsing.
- [credit_note.updated](https://docs.flexprice.io/api-reference/webhook-events/credit_noteupdated.md): Fired when a credit note is updated. Doc-only for parsing.
- [customer.created](https://docs.flexprice.io/api-reference/webhook-events/customercreated.md): Fired when a new customer is created. Doc-only for parsing.
- [customer.deleted](https://docs.flexprice.io/api-reference/webhook-events/customerdeleted.md): Fired when a customer is deleted. Doc-only for parsing.
- [customer.updated](https://docs.flexprice.io/api-reference/webhook-events/customerupdated.md): Fired when a customer is updated. Doc-only for parsing.
- [entitlement.created](https://docs.flexprice.io/api-reference/webhook-events/entitlementcreated.md): Fired when a new entitlement is created. Doc-only for parsing.
- [entitlement.deleted](https://docs.flexprice.io/api-reference/webhook-events/entitlementdeleted.md): Fired when an entitlement is deleted. Doc-only for parsing.
- [entitlement.updated](https://docs.flexprice.io/api-reference/webhook-events/entitlementupdated.md): Fired when an entitlement is updated. Doc-only for parsing.
- [feature.created](https://docs.flexprice.io/api-reference/webhook-events/featurecreated.md): Fired when a new feature is created. Doc-only for parsing.
- [feature.deleted](https://docs.flexprice.io/api-reference/webhook-events/featuredeleted.md): Fired when a feature is deleted. Doc-only for parsing.
- [feature.updated](https://docs.flexprice.io/api-reference/webhook-events/featureupdated.md): Fired when a feature is updated. Doc-only for parsing.
- [feature.wallet_balance.alert](https://docs.flexprice.io/api-reference/webhook-events/featurewallet_balancealert.md): Fired when a feature's associated wallet balance crosses an alert threshold. Doc-only for parsing.
- [invoice.communication.triggered](https://docs.flexprice.io/api-reference/webhook-events/invoicecommunicationtriggered.md): Fired when an invoice communication (e.g. email notification) is triggered. Doc-only for parsing.
- [invoice.payment.overdue](https://docs.flexprice.io/api-reference/webhook-events/invoicepaymentoverdue.md): Fired when an invoice payment is overdue past the due date. Doc-only for parsing.
- [invoice.update](https://docs.flexprice.io/api-reference/webhook-events/invoiceupdate.md): Fired when an invoice is updated. Doc-only for parsing.
- [invoice.update.finalized](https://docs.flexprice.io/api-reference/webhook-events/invoiceupdatefinalized.md): Fired when an invoice is finalized and locked for payment. Doc-only for parsing.
- [invoice.update.payment](https://docs.flexprice.io/api-reference/webhook-events/invoiceupdatepayment.md): Fired when an invoice payment status changes. Doc-only for parsing.
- [invoice.update.voided](https://docs.flexprice.io/api-reference/webhook-events/invoiceupdatevoided.md): Fired when an invoice is voided (e.g. order cancelled or duplicate). Doc-only for parsing.
- [payment.created](https://docs.flexprice.io/api-reference/webhook-events/paymentcreated.md): Fired when a new payment is created. Doc-only for parsing.
- [payment.failed](https://docs.flexprice.io/api-reference/webhook-events/paymentfailed.md): Fired when a payment fails. Doc-only for parsing.
- [payment.pending](https://docs.flexprice.io/api-reference/webhook-events/paymentpending.md): Fired when a payment is pending processing. Doc-only for parsing.
- [payment.success](https://docs.flexprice.io/api-reference/webhook-events/paymentsuccess.md): Fired when a payment succeeds. Doc-only for parsing.
- [payment.updated](https://docs.flexprice.io/api-reference/webhook-events/paymentupdated.md): Fired when a payment is updated. Doc-only for parsing.
- [subscription.activated](https://docs.flexprice.io/api-reference/webhook-events/subscriptionactivated.md): Fired when a draft subscription is activated. Doc-only for parsing.
- [subscription.cancelled](https://docs.flexprice.io/api-reference/webhook-events/subscriptioncancelled.md): Fired when a subscription is cancelled (immediately or end-of-period). Doc-only for parsing.
- [subscription.created](https://docs.flexprice.io/api-reference/webhook-events/subscriptioncreated.md): Fired when a new subscription is created. Doc-only for parsing.
- [subscription.draft.created](https://docs.flexprice.io/api-reference/webhook-events/subscriptiondraftcreated.md): Fired when a new draft subscription is created (not yet activated). Doc-only for parsing.
- [subscription.paused](https://docs.flexprice.io/api-reference/webhook-events/subscriptionpaused.md): Fired when a subscription is paused. Doc-only for parsing.
- [subscription.phase.created](https://docs.flexprice.io/api-reference/webhook-events/subscriptionphasecreated.md): Fired when a new subscription phase is created. Doc-only for parsing.
- [subscription.phase.deleted](https://docs.flexprice.io/api-reference/webhook-events/subscriptionphasedeleted.md): Fired when a subscription phase is deleted. Doc-only for parsing.
- [subscription.phase.updated](https://docs.flexprice.io/api-reference/webhook-events/subscriptionphaseupdated.md): Fired when a subscription phase is updated. Doc-only for parsing.
- [subscription.renewal.due](https://docs.flexprice.io/api-reference/webhook-events/subscriptionrenewaldue.md): Fired when a subscription renewal is upcoming (cron-driven). Doc-only for parsing.
- [subscription.resumed](https://docs.flexprice.io/api-reference/webhook-events/subscriptionresumed.md): Fired when a paused subscription is resumed. Doc-only for parsing.
- [subscription.updated](https://docs.flexprice.io/api-reference/webhook-events/subscriptionupdated.md): Fired when a subscription is updated (e.g. quantity, billing anchor, or metadata changes). Doc-only for parsing.
- [wallet.created](https://docs.flexprice.io/api-reference/webhook-events/walletcreated.md): Fired when a new wallet is created. Doc-only for parsing.
- [wallet.credit_balance.dropped](https://docs.flexprice.io/api-reference/webhook-events/walletcredit_balancedropped.md): Fired when a wallet's credit balance drops below an alert threshold. Doc-only for parsing.
- [wallet.credit_balance.recovered](https://docs.flexprice.io/api-reference/webhook-events/walletcredit_balancerecovered.md): Fired when a wallet's credit balance recovers above an alert threshold. Doc-only for parsing.
- [wallet.ongoing_balance.dropped](https://docs.flexprice.io/api-reference/webhook-events/walletongoing_balancedropped.md): Fired when a wallet's ongoing balance drops below an alert threshold. Doc-only for parsing.
- [wallet.ongoing_balance.recovered](https://docs.flexprice.io/api-reference/webhook-events/walletongoing_balancerecovered.md): Fired when a wallet's ongoing balance recovers above an alert threshold. Doc-only for parsing.
- [wallet.terminated](https://docs.flexprice.io/api-reference/webhook-events/walletterminated.md): Fired when a wallet is terminated. Doc-only for parsing.
- [wallet.transaction.created](https://docs.flexprice.io/api-reference/webhook-events/wallettransactioncreated.md): Fired when a new wallet transaction is created (top-up, deduction, etc.). Doc-only for parsing.
- [wallet.updated](https://docs.flexprice.io/api-reference/webhook-events/walletupdated.md): Fired when a wallet is updated. Doc-only for parsing.
- [Query workflows](https://docs.flexprice.io/api-reference/workflows/query-workflows.md): Use when listing or auditing workflow runs (e.g. ops dashboard or debugging). Returns a paginated list; supports filtering by workflow type and status.
- [Get Started](https://docs.flexprice.io/docs/Collectors/get-started.md): Install and run the Flexprice Bento Collector with Docker or Kubernetes
- [How It Works](https://docs.flexprice.io/docs/Collectors/how-it-works.md): Architecture, batching, and performance optimization for the Bento Collector
- [Flexprice Collector](https://docs.flexprice.io/docs/Collectors/overview.md): Stream usage events from Kafka and other sources into Flexprice with reliable delivery
- [Build Credit-based Pricing like Apollo.io](https://docs.flexprice.io/docs/boiler-plate/credit-based-pricing.md): Credit-based pricing is a usage-based model where customers prepay for a set number of credits and spend them as they use features, with each action deducting a defined credit amount.
- [Build Hybrid Pricing like Resend](https://docs.flexprice.io/docs/boiler-plate/hybrid-pricing.md): **Hybrid pricing** combines fixed **subscription** fees (recurring base charge) with usage-based metering (pay-per-use overages), plus **entitlements** that gate features and set limits per plan.
- [Build Usage-based Pricing like Vapi.ai](https://docs.flexprice.io/docs/boiler-plate/usage-based-pricing.md): Vapi is a developer platform for building, testing, and deploying realistic, human-like voice AI agents.
- [Changelog](https://docs.flexprice.io/docs/changelog.md): What we’ve been shipping at Flexprice lately
- [Model Context Protocol (MCP)](https://docs.flexprice.io/docs/connect/mcp-server.md): Connect Cursor, Claude, VS Code, and other MCP clients to your Flexprice API
- [Project Architecture](https://docs.flexprice.io/docs/contributing-guide/architechture.md): Understanding the project structure and architecture
- [Backend Development Setup](https://docs.flexprice.io/docs/contributing-guide/backend-setup.md): Complete guide to setting up the Flexprice backend development environment
- [Code of Conduct](https://docs.flexprice.io/docs/contributing-guide/code-of-contuct.md): Community guidelines and standards
- [Frontend Development Setup](https://docs.flexprice.io/docs/contributing-guide/frontend-setup.md): Complete guide to setting up the Flexprice frontend development environment
- [Contributing Guide](https://docs.flexprice.io/docs/contributing-guide/introduction.md): Learn how to contribute to this open source project
- [Archive a customer](https://docs.flexprice.io/docs/customers/archive.md)
- [Creating a customer](https://docs.flexprice.io/docs/customers/create.md)
- [Customer Portal](https://docs.flexprice.io/docs/customers/customer-portal.md): Generate secure sessions for customers to access their billing information
- [Overview](https://docs.flexprice.io/docs/customers/overview.md)
- [Automated Data Export to Amazon S3](https://docs.flexprice.io/docs/data-exports/amazon-s3/export.md): Automate data exports to Amazon S3 with flexible scheduling and configuration
- [Event Ingestion API Reference](https://docs.flexprice.io/docs/event-ingestion/api-reference.md): Complete API reference for sending events to Flexprice
- [Connecting to Billing](https://docs.flexprice.io/docs/event-ingestion/connecting-to-billing.md): Learn how to connect events to billing and see usage in invoices
- [Creating a Metered Feature](https://docs.flexprice.io/docs/event-ingestion/creating-a-metered-feature.md): Step-by-step guide to create a metered feature for event ingestion
- [Event Debugger](https://docs.flexprice.io/docs/event-ingestion/event-debugger.md): Monitor and debug event processing in real-time
- [Event Monitoring](https://docs.flexprice.io/docs/event-ingestion/monitoring.md): Monitor the health and performance of your event ingestion and processing pipeline
- [Overview](https://docs.flexprice.io/docs/event-ingestion/overview.md): Learn how to send usage events to Flexprice for metered billing
- [Sending Events](https://docs.flexprice.io/docs/event-ingestion/sending-events.md): Learn how to send usage events to Flexprice via API
- [Troubleshooting Event Ingestion](https://docs.flexprice.io/docs/event-ingestion/troubleshooting.md): Comprehensive guide to fixing common event ingestion issues in Flexprice
- [Validating Events](https://docs.flexprice.io/docs/event-ingestion/validating-events.md): Learn how to verify that events are being processed correctly in Flexprice
- [Architecture](https://docs.flexprice.io/docs/getting-started/architecture.md): This document outlines the core architecture components of the Flexprice platform, how they interact, and their respective responsibilities.
- [Flexprice Cloud](https://docs.flexprice.io/docs/getting-started/cloud.md): Learn how to quickly get started with Flexprice Cloud - the fastest way to integrate usage-based pricing
- [Configuration](https://docs.flexprice.io/docs/getting-started/configuration.md): Configure your self-hosted Flexprice instance
- [Self-hosting on AWS](https://docs.flexprice.io/docs/getting-started/self-hosting-aws.md): Complete guide to deploy Flexprice on AWS with ECS, Aurora PostgreSQL, MSK, EKS, and Redis
- [Self-hosting Flexprice](https://docs.flexprice.io/docs/getting-started/self-hosting-guide.md): Learn how to set up and run Flexprice on your own infrastructure
- [Managing Invoices](https://docs.flexprice.io/docs/invoices/managing.md)
- [Overview](https://docs.flexprice.io/docs/invoices/overview.md)
- [Partial payments](https://docs.flexprice.io/docs/invoices/partial-payments.md)
- [Apply Discount on Subscription](https://docs.flexprice.io/docs/product-catalogue/coupons/apply-discount-on-subscription.md): Learn how to apply discount coupons to customer subscriptions to provide flexible pricing options.
- [Create a Coupon](https://docs.flexprice.io/docs/product-catalogue/coupons/create.md): Learn how to create discount coupons in Flexprice to offer flexible pricing options to your customers.
- [Coupons Overview](https://docs.flexprice.io/docs/product-catalogue/coupons/overview.md): Learn about Flexprice's discount coupon system for flexible pricing and promotional strategies.
- [Pricing unit](https://docs.flexprice.io/docs/product-catalogue/custom-pricing/pricing-unit.md): This feature allows you to create and use your own currency in Flexprice. With create Price Units, add them to plans and wallets in custom currency.
- [Use cases](https://docs.flexprice.io/docs/product-catalogue/custom-pricing/use-cases.md): Add charges and create wallets using custom price units. All billing calculations use base currency.
- [AVERAGE](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/average.md): Calculates the average value of a specified property across all matching events.
- [COUNT](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/count.md): Counts the number of distinct events (by ID) that match the criteria.
- [COUNT UNIQUE](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/count-unique.md): Counts the number of distinct values for a specified property.
- [LATEST](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/latest.md): Returns the most recent value of a property based on event timestamp.
- [MAX](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/max.md): Get the maximum value of a property with optional bucketed or group-by calculations.
- [Overview](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/overview.md): **Aggregation types** define how usage is measured from incoming events. They are used to **calculate billable consumption** and form the foundation of usage-based billing.
- [SUM](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/sum.md): Sums the values of a specified property across all matching events.
- [SUM WITH MULTIPLIER](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/sum-with-multiplier.md): Sums property values and applies a configurable multiplier.
- [WEIGHTED SUM](https://docs.flexprice.io/docs/product-catalogue/features/aggregation/weighted-sum.md): Time-weighted sum calculation where values are prorated based on duration.
- [Creating a feature](https://docs.flexprice.io/docs/product-catalogue/features/create.md)
- [Link features to plans](https://docs.flexprice.io/docs/product-catalogue/features/linking-to-plans.md)
- [Overview](https://docs.flexprice.io/docs/product-catalogue/features/overview.md)
- [Use cases](https://docs.flexprice.io/docs/product-catalogue/features/use-cases.md)
- [Feature-Wallet Balance Alert](https://docs.flexprice.io/docs/product-catalogue/features/wallet-balance-alert.md): Set up automated alerts to monitor feature wallet balances and receive notifications when thresholds are crossed
- [Charges grouping](https://docs.flexprice.io/docs/product-catalogue/groups/charges-grouping.md): Assign prices (charges) to a group when adding or editing a charge.
- [Creating a group](https://docs.flexprice.io/docs/product-catalogue/groups/create.md): Create and list groups. Entity type is set once at creation and cannot be changed.
- [Feature grouping](https://docs.flexprice.io/docs/product-catalogue/groups/feature-grouping.md): Assign features to a group when creating or editing a feature.
- [Overview](https://docs.flexprice.io/docs/product-catalogue/groups/overview.md): Create named groups (e.g. Usage Pricing, Add-on Charges) for features and prices, and see grouped invoice line-items, usage and cost broken down by group in analytics and the customer portal.
- [Archiving a plan](https://docs.flexprice.io/docs/product-catalogue/plans/archive.md)
- [Flat fee](https://docs.flexprice.io/docs/product-catalogue/plans/billing-models/flat-fee.md)
- [Package](https://docs.flexprice.io/docs/product-catalogue/plans/billing-models/package.md)
- [Volume tiered](https://docs.flexprice.io/docs/product-catalogue/plans/billing-models/volume-tiered.md)
- [Advance vs Arrear](https://docs.flexprice.io/docs/product-catalogue/plans/charges/advance-vs-arrear.md)
- [Cloning a plan](https://docs.flexprice.io/docs/product-catalogue/plans/clone.md): Create a duplicate of an existing plan with a new name and lookup key, including its active prices, published entitlements, and plan-scoped credit grants.
- [Creating a plan](https://docs.flexprice.io/docs/product-catalogue/plans/create.md): Follow the steps below to create a pricing plan in Flexprice:
- [Localisation](https://docs.flexprice.io/docs/product-catalogue/plans/localisation.md)
- [Overview](https://docs.flexprice.io/docs/product-catalogue/plans/overview.md)
- [Price Overrides](https://docs.flexprice.io/docs/product-catalogue/plans/price-overrides.md): Learn how to customize pricing for individual customers by overriding plan charges during subscription creation.
- [Pricing Plans](https://docs.flexprice.io/docs/product-catalogue/plans/pricing.md): Learn how to create and manage pricing plans in Flexprice, including step-by-step creation, billing models, and price termination management.
- [Updating a Plan Price](https://docs.flexprice.io/docs/product-catalogue/plans/update-price.md): Update a plan price's amount, tiers, or metadata — and safely propagate the change to all active subscribers using the price sync workflow.
- [Clone Cursor pricing](https://docs.flexprice.io/docs/product-catalogue/plans/use-cases/clone-cursor-pricing.md)
- [Clone OpenAI pricing](https://docs.flexprice.io/docs/product-catalogue/plans/use-cases/clone-openai-pricing.md)
- [Manage API Keys](https://docs.flexprice.io/docs/rbac/api.md): Generate and manage API keys with specific permissions
- [Overview](https://docs.flexprice.io/docs/rbac/overview.md): Control access to your Flexprice resources with role-based permissions
- [Creating a Service Account](https://docs.flexprice.io/docs/rbac/service-accounts/create.md): Create a service account with specific permissions for your automated services
- [Settings](https://docs.flexprice.io/docs/settings/settings.md): Configure subscription auto-cancellation, invoice numbering, and wallet balance alerts at the tenant and environment level.
- [Commitment](https://docs.flexprice.io/docs/subscriptions/commitment.md): Commitment-based pricing is a flexible billing model that enables customers to commit to a minimum spend amount for each billing period. This pricing strategy provides predictable revenue for businesses while offering customers the flexibility to pay for actual usage beyond their commitment at a pre…
- [Customer Hierarchy](https://docs.flexprice.io/docs/subscriptions/customer-hierarchy.md): Configure billing relationships at the subscription level so you can separate who uses your product from who pays for it.
- [Create subscription for a customer](https://docs.flexprice.io/docs/subscriptions/customers-create-subscription.md): Once a customer is created, you can create a subscription for them by following these steps:
- [Subscription Override Line Items](https://docs.flexprice.io/docs/subscriptions/override-line-items.md): Learn how to customize pricing for specific subscriptions by overriding plan prices with custom amounts, quantities, billing models, and tier structures.
- [Plan Price Overrides](https://docs.flexprice.io/docs/subscriptions/plan-price-overrides.md): Give a specific customer custom rates without changing the plan for everyone else. Apply overrides at subscription creation time.
- [Record payment for subscription](https://docs.flexprice.io/docs/subscriptions/record-payment.md): Complete guide to Flexprice payment system including payment methods, behaviors, and wallet payment logic
- [Reservation / Commitment Discount](https://docs.flexprice.io/docs/subscriptions/reservation-discount.md)
- [Subscription Line Item Overrides](https://docs.flexprice.io/docs/subscriptions/subscription-line-item-overrides.md): Add, update, or remove individual charges on a live subscription, and push plan pricing changes to existing subscribers using the price sync workflow.
- [Understanding Proration](https://docs.flexprice.io/docs/subscriptions/understanding-proration.md): Learn how proration works when changing subscription plans and how it affects your billing
- [Upgrade & Downgrade](https://docs.flexprice.io/docs/subscriptions/upgrade-and-downgrade.md): Learn how to upgrade or downgrade subscription plans with automatic proration and billing adjustments
- [View subscription](https://docs.flexprice.io/docs/subscriptions/view.md)
- [Pause subscription](https://docs.flexprice.io/docs/subscriptions/workflows/pause.md)
- [Trialing](https://docs.flexprice.io/docs/subscriptions/workflows/trialing.md): Offer free trial periods on subscriptions before billing begins
- [Auto Top-Up](https://docs.flexprice.io/docs/wallet/auto-top-up.md): Automatically recharge customer wallets when balance falls below a configured threshold to ensure uninterrupted service.
- [Conversion rate](https://docs.flexprice.io/docs/wallet/conversion-rate.md): Conversion rate links your unit (e.g. credits) to base currency (e.g. USD). Billing stays in one currency.
- [Creating a wallet](https://docs.flexprice.io/docs/wallet/create.md)
- [Low Balance Alert](https://docs.flexprice.io/docs/wallet/low-balance-alert.md): Configure Wallet Sentinel Alerts to get notified when a customer's wallet balance crosses configurable Info, Warning, or Critical thresholds.
- [Manual Debit](https://docs.flexprice.io/docs/wallet/manual-debit.md): Manually deduct credits from customer wallets for refunds, adjustments, or administrative corrections.
- [Prepaid & Promotional credits](https://docs.flexprice.io/docs/wallet/prepaid-and-promotional.md): Description of your new file.
- [Top-up wallet](https://docs.flexprice.io/docs/wallet/top-up.md)
- [Wallet Transactions](https://docs.flexprice.io/docs/wallet/transactions.md): Track and monitor all wallet activity including credits added, debits, and transaction status
- [Webhooks](https://docs.flexprice.io/docs/webhook/webhooks.md): Learn about webhook events in Flexprice
- [Welcome to Flexprice](https://docs.flexprice.io/docs/welcome-to-flexprice.md): Developers should focus on building, not billing
- [Chargebee Connection Setup](https://docs.flexprice.io/integrations/chargebee/connection-setup.md): Complete guide to setting up and configuring Chargebee connections in Flexprice
- [Chargebee Customer Synchronization](https://docs.flexprice.io/integrations/chargebee/customer-sync.md): Complete guide to customer synchronization between Flexprice and Chargebee
- [Chargebee Invoice Sync & Webhook Handling](https://docs.flexprice.io/integrations/chargebee/invoice-sync.md): Complete guide to syncing invoices to Chargebee and handling webhooks
- [Chargebee Item Sync](https://docs.flexprice.io/integrations/chargebee/item-sync.md): Complete guide to syncing item families, items, and item prices to Chargebee
- [Introduction](https://docs.flexprice.io/integrations/integrations.md): Connect Flexprice with your favorite tools and platforms to streamline your pricing and revenue operations
- [Moyasar Connection Setup](https://docs.flexprice.io/integrations/moyasar/connection-setup.md): Complete guide to setting up and configuring Moyasar connections in Flexprice
- [Moyasar Invoice Synchronization](https://docs.flexprice.io/integrations/moyasar/invoice-sync.md): Complete guide to invoice synchronization between Flexprice and Moyasar
- [Nomod Connection Setup](https://docs.flexprice.io/integrations/nomod/connection-setup.md): Complete guide to setting up and configuring Nomod connections in Flexprice
- [Nomod Customer Synchronization](https://docs.flexprice.io/integrations/nomod/customer-sync.md): Complete guide to customer synchronization between Flexprice and Nomod
- [Nomod Payment Links & Invoice Sync](https://docs.flexprice.io/integrations/nomod/payment-links.md): Complete guide to creating payment links and handling the Nomod checkout flow
- [Paddle Connection Setup](https://docs.flexprice.io/integrations/paddle/connection-setup.md): Complete guide to setting up and configuring Paddle connections in Flexprice
- [QuickBooks Connection Setup](https://docs.flexprice.io/integrations/quickbooks/connection-setup.md): Complete guide to setting up and configuring QuickBooks Online connections in Flexprice
- [QuickBooks Integration Workflow](https://docs.flexprice.io/integrations/quickbooks/integration-workflow.md): Complete end-to-end workflow for syncing invoices from Flexprice to QuickBooks Online
- [Item Sync to QuickBooks](https://docs.flexprice.io/integrations/quickbooks/item-sync.md): Learn how Flexprice automatically creates and manages items in QuickBooks for invoice line items
- [Razorpay Connection Setup](https://docs.flexprice.io/integrations/razorpay/connection-setup.md): Complete guide to setting up and configuring Razorpay connections in Flexprice
- [Razorpay Customer Synchronization](https://docs.flexprice.io/integrations/razorpay/customer-sync.md): Complete guide to on-demand customer synchronization between Flexprice and Razorpay
- [Razorpay Integration Workflow](https://docs.flexprice.io/integrations/razorpay/integration-workflow.md): Complete guide to integrating Flexprice with Razorpay for payment processing
- [Razorpay Payment Links & Invoice Sync](https://docs.flexprice.io/integrations/razorpay/payment-links.md): Complete guide to creating payment links and handling the Razorpay checkout flow
- [Card Payment Checkout Flow](https://docs.flexprice.io/integrations/stripe/card-payment.md): Complete guide to processing card payments using saved payment methods
- [Stripe Connection Setup](https://docs.flexprice.io/integrations/stripe/connection-setup.md): Complete guide to setting up and configuring Stripe connections in Flexprice
- [Stripe Customer Synchronization](https://docs.flexprice.io/integrations/stripe/customer-sync.md): Complete guide to on-demand customer synchronization between Flexprice and Stripe
- [Invoice Sync & Save Card](https://docs.flexprice.io/integrations/stripe/examples/invoice-sync-workflow.md)
- [Stripe Invoice Sync Flow](https://docs.flexprice.io/integrations/stripe/invoice-sync.md): Comprehensive guide to Stripe invoice synchronization, collection methods, and payment reconciliation
- [Stripe Payment Links & Checkout Flow](https://docs.flexprice.io/integrations/stripe/payment-links.md): Complete guide to creating payment links and handling the Stripe checkout flow
- [Zoho Books Connection Setup](https://docs.flexprice.io/integrations/zohobooks/connection-setup.md): Complete guide to setting up and configuring Zoho Books connections in Flexprice

## OpenAPI Specs

- [openapi](https://docs.flexprice.io/api-reference/openapi.json)
- [vercel](https://docs.flexprice.io/vercel.json)

## Optional

- [Support](mailto:support@flexprice.io)
- [Community](https://join.slack.com/t/flexpricecommunity/shared_invite/zt-39uat51l0-n8JmSikHZP~bHJNXladeaQ)
- [Website](https://flexprice.io/)