# Nozle

> AI billing & margin intelligence platform

- [Introduction](https://docs.nozle.dev/guides/getting-started/introduction.md): What is Nozle and who is it for
- [Quickstart](https://docs.nozle.dev/guides/getting-started/quickstart.md): Track your first billable event and connect secure checkout
- [Core Concepts](https://docs.nozle.dev/guides/getting-started/concepts.md): Plans, subscriptions, events, entitlements, and margin
- [Architecture](https://docs.nozle.dev/guides/getting-started/architecture.md): How Nozle connects your product, billing backend, and payment provider
- [Merchant backend billing](https://docs.nozle.dev/guides/getting-started/merchant-backend-bff.md): Keep customer billing behind your authenticated backend while using a publishable key only for the public catalog.
- [Event Pipeline](https://docs.nozle.dev/guides/billing/event-pipeline.md): How usage events move from your application into billing and margin reporting
- [Plans](https://docs.nozle.dev/guides/billing/plans.md): Creating and managing pricing plans
- [Checkout](https://docs.nozle.dev/guides/billing/checkout.md): Payment-aware Stripe checkout through an authenticated merchant backend
- [Subscriptions](https://docs.nozle.dev/guides/billing/subscriptions.md): Create, upgrade, downgrade, cancel, and restore subscriptions safely
- [Invoices](https://docs.nozle.dev/guides/billing/invoices.md): Understand invoice generation, payment state, and customer delivery
- [Payments](https://docs.nozle.dev/guides/billing/payments.md): Payment processing, retries, and dunning
- [Product Credits Overview](https://docs.nozle.dev/guides/credits/overview.md): Customer-level credit systems, balances, sources, and ledger behavior
- [Consumable Metrics](https://docs.nozle.dev/guides/credits/usage-behavior.md): Model usage behavior independently from aggregation lifecycle
- [Credit Systems and Rates](https://docs.nozle.dev/guides/credits/configuration.md): Create a credit catalog and exact metric conversion rates
- [Included Plan Credits](https://docs.nozle.dev/guides/credits/plan-grants.md): Configure recurring customer grants and lifecycle behavior
- [Entity-scoped Credits](https://docs.nozle.dev/guides/credits/entities.md): Model per-user credit pools, shared fallback, lifecycle, and exact transfers
- [Check and Track Usage](https://docs.nozle.dev/guides/credits/usage-tracking.md): Advisory checks and atomic idempotent consumption
- [Paid Credit Top-ups](https://docs.nozle.dev/guides/credits/top-ups.md): Sell fixed packages and grant credits only after confirmed payment
- [Credit Reliability and Reconciliation](https://docs.nozle.dev/guides/credits/reliability.md): Understand ledger invariants, event delivery, and operational safety
- [Credit Rollout and Acceptance](https://docs.nozle.dev/guides/credits/rollout.md): Validate, canary, monitor, and roll back product-credit integrations
- [Margin Intelligence](https://docs.nozle.dev/guides/margin/overview.md): Cost and revenue visibility for AI products
- [Cost Models](https://docs.nozle.dev/guides/margin/cost-models.md): Define per-unit costs for margin calculation
- [Dashboard](https://docs.nozle.dev/guides/margin/dashboard.md): Query margin data by customer, metric, plan, and model
- [Margin Alerts](https://docs.nozle.dev/guides/margin/alerts.md): Margin floor alerts and cost spike detection
- [Entitlements Overview](https://docs.nozle.dev/guides/entitlements/overview.md): Enforce feature access and usage limits from a trusted backend
- [The can() Endpoint](https://docs.nozle.dev/guides/entitlements/can-endpoint.md): Deep-dive into GET /api/v1/can
- [Backend-authorized updates](https://docs.nozle.dev/guides/entitlements/real-time.md): Keep entitlement UI current without exposing customer credentials
- [API Introduction](https://docs.nozle.dev/api/introduction.md): Build billing, metering, entitlement, credit, and margin workflows with Nozle
- [API Standards](https://docs.nozle.dev/api/api-standards.md): Authentication, payloads, pagination, errors, and safe retries
- [Authentication](https://docs.nozle.dev/api/authentication.md): Public catalog and trusted-backend credentials
- [Errors](https://docs.nozle.dev/api/errors.md): HTTP errors, validation failures, and retry guidance
- [Webhooks](https://docs.nozle.dev/api/webhooks.md): Stripe webhook events and signature verification
- [MCP Server](https://docs.nozle.dev/api/mcp.md): Connect AI tools to Nozle documentation
- [Application Billing API](https://docs.nozle.dev/billing-api/overview.md): Server-side APIs for customer, subscription, checkout, invoice, and usage workflows
- [Create Subscription](https://docs.nozle.dev/api/subscribe.md)
- [Create Checkout Session](https://docs.nozle.dev/api/create-checkout.md)
- [Billing Status](https://docs.nozle.dev/api/billing-status.md)
- [Import External Billing State](https://docs.nozle.dev/api/import-billing-state.md): Import an existing paid subscription without creating a Nozle invoice or payment
- [Entity Subscriptions](https://docs.nozle.dev/api/entity-subscriptions.md): Give individual customer Entities independent plans, billing periods, and subscription lifecycles.
- [Upgrade Plan](https://docs.nozle.dev/api/upgrade.md)
- [Cancel Subscription](https://docs.nozle.dev/api/cancel-subscription.md)
- [Customer Credit Balances](https://docs.nozle.dev/api/customer-credit-balances.md): Read exact customer balances and source breakdowns
- [Customer Credit Operations](https://docs.nozle.dev/api/customer-credit-operations.md): Paginate immutable grants, consumes, denials, and adjustments
- [Customer Entities](https://docs.nozle.dev/api/customer-entities.md): Create, list, update, suspend, reactivate, and delete customer Entities
- [Entity Credit Balances](https://docs.nozle.dev/api/entity-credit-balances.md): Read Entity, shared, and effective exact-decimal balances
- [Entity Credit Operations](https://docs.nozle.dev/api/entity-credit-operations.md): Paginate immutable Entity-attributed credit history
- [Entity Credit Transfers](https://docs.nozle.dev/api/entity-credit-transfers.md): Allocate and return provenance-preserving paid top-up credits
- [Import Opening Credit Balance](https://docs.nozle.dev/api/import-opening-credit-balance.md): Seed the remaining plan credits for an externally billed subscription without an invoice
- [Check Credit Usage](https://docs.nozle.dev/api/usage-check.md): Calculate an advisory credit decision without mutation
- [Track and Consume Credits](https://docs.nozle.dev/api/usage-track.md): Atomically consume credits and queue the matching billing event
- [Create Credit Top-up Purchase](https://docs.nozle.dev/api/create-credit-top-up-purchase.md): Start checkout for a fixed product-credit package
- [Check & Deduct Credits](https://docs.nozle.dev/api/check-and-deduct.md)
- [Legacy Invoice Wallet Balance](https://docs.nozle.dev/api/credit-balance.md)
- [Check Entitlement](https://docs.nozle.dev/api/check-entitlement.md)
- [WebSocket Token](https://docs.nozle.dev/api/centrifugo-token.md)
- [Margin Summary](https://docs.nozle.dev/api/margin-summary.md)
- [Margin by Customer](https://docs.nozle.dev/api/margin-customers.md)
- [Margin Trend](https://docs.nozle.dev/api/margin-trend.md)
- [Simulate Margin](https://docs.nozle.dev/api/margin-simulate.md)
- [List Cost Models](https://docs.nozle.dev/api/list-cost-models.md)
- [Create Cost Model](https://docs.nozle.dev/api/create-cost-model.md)
- [Delete Cost Model](https://docs.nozle.dev/api/delete-cost-model.md)
- [LLM Proxy](https://docs.nozle.dev/api/llm-proxy.md): Reverse proxy for OpenAI and Anthropic with automatic token tracking
- [Create a customer](https://docs.nozle.dev/api-reference/customers/create-a-customer.md): This endpoint creates a new customer.
- [List all customers](https://docs.nozle.dev/api-reference/customers/list-all-customers.md): This endpoint retrieves all existing customers.
- [Retrieve a customer](https://docs.nozle.dev/api-reference/customers/retrieve-a-customer.md): This endpoint retrieves an existing customer.
- [Delete a customer](https://docs.nozle.dev/api-reference/customers/delete-a-customer.md): This endpoint deletes an existing customer.
- [Get a customer portal URL](https://docs.nozle.dev/api-reference/customers/get-a-customer-portal-url.md): Retrieves an embeddable link for displaying a customer portal.
- [Generate a Customer Payment Provider Checkout URL](https://docs.nozle.dev/api-reference/customers/generate-a-customer-payment-provider-checkout-url.md): This endpoint regenerates the Payment Provider Checkout URL of a Customer.
- [Create a plan](https://docs.nozle.dev/api-reference/plans/create-a-plan.md): This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
- [List all plans](https://docs.nozle.dev/api-reference/plans/list-all-plans.md): This endpoint retrieves all existing plans.
- [Update a plan](https://docs.nozle.dev/api-reference/plans/update-a-plan.md): This endpoint updates a specific plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
- [Retrieve a plan](https://docs.nozle.dev/api-reference/plans/retrieve-a-plan.md): This endpoint retrieves a specific plan.
- [Delete a plan](https://docs.nozle.dev/api-reference/plans/delete-a-plan.md): This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions.
- [Replace plan metadata](https://docs.nozle.dev/api-reference/plans/replace-plan-metadata.md): This endpoint replaces all existing metadata on a plan with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
- [Merge plan metadata](https://docs.nozle.dev/api-reference/plans/merge-plan-metadata.md): This endpoint merges the provided metadata with existing metadata on the plan. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
- [Delete all plan metadata](https://docs.nozle.dev/api-reference/plans/delete-all-plan-metadata.md): This endpoint removes all metadata from a plan.
- [Delete a metadata key](https://docs.nozle.dev/api-reference/plans/delete-a-metadata-key.md): This endpoint removes a single metadata key from a plan.
- [Create a charge](https://docs.nozle.dev/api-reference/plans/create-a-charge.md): This endpoint creates a new charge for a specific plan.
- [List all charges for a plan](https://docs.nozle.dev/api-reference/plans/list-all-charges-for-a-plan.md): This endpoint retrieves all charges for a specific plan.
- [Retrieve a charge](https://docs.nozle.dev/api-reference/plans/retrieve-a-charge.md): This endpoint retrieves a specific charge for a plan.
- [Update a charge](https://docs.nozle.dev/api-reference/plans/update-a-charge.md): This endpoint updates a specific charge for a plan.
- [Delete a charge](https://docs.nozle.dev/api-reference/plans/delete-a-charge.md): This endpoint deletes a specific charge from a plan.
- [Create a charge filter](https://docs.nozle.dev/api-reference/plans/create-a-charge-filter.md): This endpoint creates a new filter for a specific charge.
- [List all filters for a charge](https://docs.nozle.dev/api-reference/plans/list-all-filters-for-a-charge.md): This endpoint retrieves all filters for a specific charge.
- [Retrieve a charge filter](https://docs.nozle.dev/api-reference/plans/retrieve-a-charge-filter.md): This endpoint retrieves a specific filter for a charge.
- [Update a charge filter](https://docs.nozle.dev/api-reference/plans/update-a-charge-filter.md): This endpoint updates a specific filter for a charge.
- [Delete a charge filter](https://docs.nozle.dev/api-reference/plans/delete-a-charge-filter.md): This endpoint deletes a specific filter from a charge.
- [Create a fixed charge](https://docs.nozle.dev/api-reference/plans/create-a-fixed-charge.md): This endpoint creates a new fixed charge for a specific plan.
- [List all fixed charges for a plan](https://docs.nozle.dev/api-reference/plans/list-all-fixed-charges-for-a-plan.md): This endpoint retrieves all fixed charges for a specific plan.
- [Retrieve a fixed charge](https://docs.nozle.dev/api-reference/plans/retrieve-a-fixed-charge.md): This endpoint retrieves a specific fixed charge for a plan.
- [Update a fixed charge](https://docs.nozle.dev/api-reference/plans/update-a-fixed-charge.md): This endpoint updates a specific fixed charge for a plan.
- [Delete a fixed charge](https://docs.nozle.dev/api-reference/plans/delete-a-fixed-charge.md): This endpoint deletes a specific fixed charge from a plan.
- [List all customer's subscriptions](https://docs.nozle.dev/api-reference/customers/list-all-customers-subscriptions.md): This endpoint retrieves all active subscriptions for a customer.
- [Assign a plan to a customer](https://docs.nozle.dev/api-reference/subscriptions/assign-a-plan-to-a-customer.md): This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades).
- [List all subscriptions](https://docs.nozle.dev/api-reference/subscriptions/list-all-subscriptions.md): This endpoint retrieves all active subscriptions.
- [Retrieve a subscription](https://docs.nozle.dev/api-reference/subscriptions/retrieve-a-subscription.md): This endpoint retrieves a specific subscription.
- [Update a subscription](https://docs.nozle.dev/api-reference/subscriptions/update-a-subscription.md): This endpoint allows you to update a subscription.
- [Terminate a subscription](https://docs.nozle.dev/api-reference/subscriptions/terminate-a-subscription.md): This endpoint allows you to terminate a subscription.
- [Retrieve subscription lifetime usage](https://docs.nozle.dev/api-reference/subscriptions/retrieve-subscription-lifetime-usage.md): This endpoint enables the retrieval of the lifetime usage of a subscription.
- [Update a subscription lifetime usage](https://docs.nozle.dev/api-reference/subscriptions/update-a-subscription-lifetime-usage.md): This endpoint allows you to update the lifetime usage of a subscription.
- [List subscription alerts](https://docs.nozle.dev/api-reference/subscriptions/list-subscription-alerts.md): This endpoint enables the retrieval of all alerts for a subscription.
- [Create subscription alert(s)](https://docs.nozle.dev/api-reference/subscriptions/create-subscription-alerts.md): This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
- [Delete all subscription alerts](https://docs.nozle.dev/api-reference/subscriptions/delete-all-subscription-alerts.md): This endpoint allows you to delete all alerts for a subscription.
- [Retrieve a subscription alert](https://docs.nozle.dev/api-reference/subscriptions/retrieve-a-subscription-alert.md): This endpoint enables the retrieval of a specific alert for a subscription.
- [Update a subscription alert](https://docs.nozle.dev/api-reference/subscriptions/update-a-subscription-alert.md): This endpoint allows you to update an existing alert for a subscription.
- [Delete a subscription alert](https://docs.nozle.dev/api-reference/subscriptions/delete-a-subscription-alert.md): This endpoint allows you to delete an existing alert for a subscription.
- [List all fixed charges for a subscription](https://docs.nozle.dev/api-reference/subscriptions/list-all-fixed-charges-for-a-subscription.md): This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
- [List all charges for a subscription](https://docs.nozle.dev/api-reference/subscriptions/list-all-charges-for-a-subscription.md): This endpoint retrieves all effective charges for a specific subscription. If the subscription has plan overrides with charge overrides, the overridden charges are returned.
- [Retrieve a charge for a subscription](https://docs.nozle.dev/api-reference/subscriptions/retrieve-a-charge-for-a-subscription.md): This endpoint retrieves a specific effective charge for a subscription. If the subscription has a plan override with a charge override, the overridden charge is returned.
- [Override a charge for a subscription](https://docs.nozle.dev/api-reference/subscriptions/override-a-charge-for-a-subscription.md): This endpoint creates or updates a charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The charge override allows customizing specific charge properties (invoice_display_name, min_amount_cents, properties, filters, ta…
- [Create a charge filter](https://docs.nozle.dev/api-reference/subscriptions/create-a-charge-filter.md): This endpoint creates a new filter for a specific charge on a subscription.
- [List all filters for a charge](https://docs.nozle.dev/api-reference/subscriptions/list-all-filters-for-a-charge.md): This endpoint retrieves all filters for a specific charge on a subscription.
- [Retrieve a charge filter](https://docs.nozle.dev/api-reference/subscriptions/retrieve-a-charge-filter.md): This endpoint retrieves a specific filter for a charge on a subscription.
- [Update a charge filter](https://docs.nozle.dev/api-reference/subscriptions/update-a-charge-filter.md): This endpoint updates a specific filter for a charge on a subscription.
- [Delete a charge filter](https://docs.nozle.dev/api-reference/subscriptions/delete-a-charge-filter.md): This endpoint deletes a specific filter from a charge on a subscription.
- [Retrieve a fixed charge for a subscription](https://docs.nozle.dev/api-reference/subscriptions/retrieve-a-fixed-charge-for-a-subscription.md): This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
- [Override a fixed charge for a subscription](https://docs.nozle.dev/api-reference/subscriptions/override-a-fixed-charge-for-a-subscription.md): This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_…
- [Create a feature](https://docs.nozle.dev/api-reference/features/create-a-feature.md): This endpoint creates a boolean, config, or metered feature in your product catalog.
- [List all features](https://docs.nozle.dev/api-reference/features/list-all-features.md): This endpoint retrieves all existing boolean, config, and metered features.
- [Update a feature](https://docs.nozle.dev/api-reference/features/update-a-feature.md): This endpoint updates an existing feature. Its code and feature type are immutable after creation.
- [Delete a feature](https://docs.nozle.dev/api-reference/features/delete-a-feature.md): This endpoint soft-deletes an existing feature, prevents future use, and preserves historical records.
- [Retrieve a feature](https://docs.nozle.dev/api-reference/features/retrieve-a-feature.md): This endpoint retrieves an existing feature by its immutable code.
- [Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.](https://docs.nozle.dev/api-reference/features/delete-a-privilege-deleting-a-privilege-removes-it-from-all-plans-and-subscriptions.md): Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
- [Create an entitlement](https://docs.nozle.dev/api-reference/entitlements/create-an-entitlement.md): This endpoint creates new entitlements by adding features to a plan. Note that all existing entitlements will be deleted and replaced by the ones provided. To add a new entitlement without removing the existing ones, use PATCH. The feature must exist and all privileges must be valid for the feature.
- [List all entitlements](https://docs.nozle.dev/api-reference/entitlements/list-all-entitlements.md): This endpoint retrieves all entitlements for a specific plan.
- [Partial update of an entitlement](https://docs.nozle.dev/api-reference/entitlements/partial-update-of-an-entitlement.md): This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and pr…
- [Retrieve an entitlement](https://docs.nozle.dev/api-reference/entitlements/retrieve-an-entitlement.md): This endpoint retrieves a specific entitlement for a plan.
- [Delete an entitlement](https://docs.nozle.dev/api-reference/entitlements/delete-an-entitlement.md): This endpoint deletes an existing entitlement by removing the feature from the plan.
- [Remove a privilege from an entitlement](https://docs.nozle.dev/api-reference/entitlements/remove-a-privilege-from-an-entitlement.md): This endpoint removes a specific privilege and its value from an entitlement. The privilege remains untouched on the original feature.
- [List all subscription entitlements](https://docs.nozle.dev/api-reference/entitlements/list-all-subscription-entitlements.md): This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.
- [Update subscription entitlements](https://docs.nozle.dev/api-reference/entitlements/update-subscription-entitlements.md): This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be…
- [Remove an entitlement from a subscription](https://docs.nozle.dev/api-reference/entitlements/remove-an-entitlement-from-a-subscription.md): This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
- [Remove a privilege from a subscription entitlement override](https://docs.nozle.dev/api-reference/entitlements/remove-a-privilege-from-a-subscription-entitlement-override.md): This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
- [Send usage events](https://docs.nozle.dev/api-reference/events/send-usage-events.md): This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.
- [List all events](https://docs.nozle.dev/api-reference/events/list-all-events.md): This endpoint is used for retrieving all events.
- [Batch multiple events](https://docs.nozle.dev/api-reference/events/batch-multiple-events.md): This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
- [Estimate fees for a pay in advance charge](https://docs.nozle.dev/api-reference/events/estimate-fees-for-a-pay-in-advance-charge.md): Estimate the fees that would be created after reception of an event for a feature attached to one or multiple pay in advance charges
- [Estimate instant fees for a pay in advance charge](https://docs.nozle.dev/api-reference/events/estimate-instant-fees-for-a-pay-in-advance-charge.md): Estimate the fees that would be created after reception of an event for a feature attached to one or multiple pay in advance standard or percentage charges
- [Batch estimate instant fees for a pay in advance charge](https://docs.nozle.dev/api-reference/events/batch-estimate-instant-fees-for-a-pay-in-advance-charge.md): Estimate the fees that would be created after reception of an event for a feature attached to one or multiple pay in advance standard or percentage charges
- [Retrieve a specific event](https://docs.nozle.dev/api-reference/events/retrieve-a-specific-event.md): This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
- [Create a feature](https://docs.nozle.dev/api-reference/features/create-a-feature.md): This endpoint creates a boolean, config, or metered feature in your product catalog.
- [List all features](https://docs.nozle.dev/api-reference/features/list-all-features.md): This endpoint retrieves all existing boolean, config, and metered features.
- [Evaluate a metered Feature expression](https://docs.nozle.dev/api-reference/features/evaluate-a-metered-feature-expression.md): Evaluate a metered Feature expression against test event data.
- [Update a feature](https://docs.nozle.dev/api-reference/features/update-a-feature.md): This endpoint updates an existing feature. Its code and feature type are immutable after creation.
- [Delete a feature](https://docs.nozle.dev/api-reference/features/delete-a-feature.md): This endpoint soft-deletes an existing feature, prevents future use, and preserves historical records.
- [Retrieve a feature](https://docs.nozle.dev/api-reference/features/retrieve-a-feature.md): This endpoint retrieves an existing feature by its immutable code.
- [Retrieve customer current usage](https://docs.nozle.dev/api-reference/customers/retrieve-customer-current-usage.md): This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
- [Retrieve customer current and projected usage](https://docs.nozle.dev/api-reference/customers/retrieve-customer-current-and-projected-usage.md): This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.
- [Retrieve customer past usage](https://docs.nozle.dev/api-reference/customers/retrieve-customer-past-usage.md): This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
- [List all customer's invoices](https://docs.nozle.dev/api-reference/customers/list-all-customers-invoices.md): This endpoint is used for retrieving all invoices of a customer.
- [Create a one-off invoice](https://docs.nozle.dev/api-reference/invoices/create-a-one-off-invoice.md): This endpoint is used for issuing a one-off invoice.
- [List all invoices](https://docs.nozle.dev/api-reference/invoices/list-all-invoices.md): This endpoint is used for retrieving all invoices.
- [Update an invoice](https://docs.nozle.dev/api-reference/invoices/update-an-invoice.md): This endpoint is used for updating an existing invoice.
- [Retrieve an invoice](https://docs.nozle.dev/api-reference/invoices/retrieve-an-invoice.md): This endpoint is used for retrieving a specific invoice that has been issued.
- [Download an invoice PDF](https://docs.nozle.dev/api-reference/invoices/download-an-invoice-pdf.md): This endpoint is used for downloading a specific invoice PDF document.
- [Finalize a draft invoice](https://docs.nozle.dev/api-reference/invoices/finalize-a-draft-invoice.md): This endpoint is used for finalizing a draft invoice.
- [Mark an invoice payment dispute as lost](https://docs.nozle.dev/api-reference/invoices/mark-an-invoice-payment-dispute-as-lost.md): This endpoint is used for setting invoice's payment dispute as lost.
- [Refresh a draft invoice](https://docs.nozle.dev/api-reference/invoices/refresh-a-draft-invoice.md): This endpoint is used for refreshing a draft invoice.
- [Retry generation of a failed invoice](https://docs.nozle.dev/api-reference/invoices/retry-generation-of-a-failed-invoice.md): This endpoint is used for retrying to generate a failed invoice.
- [Generate a payment URL](https://docs.nozle.dev/api-reference/invoices/generate-a-payment-url.md): This endpoint generates a checkout link for a specific invoice.
- [Create an invoice preview](https://docs.nozle.dev/api-reference/invoices/create-an-invoice-preview.md): This endpoint is used for generating invoice preview.
- [Retry an invoice payment](https://docs.nozle.dev/api-reference/invoices/retry-an-invoice-payment.md): This endpoint resends an invoice for collection and retry a payment.
- [Void an invoice](https://docs.nozle.dev/api-reference/invoices/void-an-invoice.md): This endpoint is used for voiding an invoice. • When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`. • When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this va…
- [List all fees](https://docs.nozle.dev/api-reference/fees/list-all-fees.md): This endpoint is used for retrieving all fees that has been issued.
- [Retrieve a specific fee](https://docs.nozle.dev/api-reference/fees/retrieve-a-specific-fee.md): This endpoint is used for retrieving a specific fee that has been issued.
- [Update a fee](https://docs.nozle.dev/api-reference/fees/update-a-fee.md): This endpoint is used for updating a specific fee that has been issued.
- [Delete a fee](https://docs.nozle.dev/api-reference/fees/delete-a-fee.md): This endpoint is used for deleting a specific fee that has not yet been invoiced
- [Create a wallet](https://docs.nozle.dev/api-reference/wallets/create-a-wallet.md): This endpoint is used to create a wallet with prepaid credits.
- [List all customer's wallets](https://docs.nozle.dev/api-reference/wallets/list-all-customers-wallets.md): This endpoint is used to list all wallets with prepaid credits of a customer
- [Update a wallet](https://docs.nozle.dev/api-reference/wallets/update-a-wallet.md): This endpoint is used to update an existing wallet with prepaid credits.
- [Retrieve a wallet](https://docs.nozle.dev/api-reference/wallets/retrieve-a-wallet.md): This endpoint is used to retrieve an existing wallet with prepaid credits.
- [Terminate a wallet](https://docs.nozle.dev/api-reference/wallets/terminate-a-wallet.md): This endpoint is used to terminate an existing wallet with prepaid credits.
- [Replace wallet metadata](https://docs.nozle.dev/api-reference/wallets/replace-wallet-metadata.md): This endpoint replaces all existing metadata on a wallet with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
- [Merge wallet metadata](https://docs.nozle.dev/api-reference/wallets/merge-wallet-metadata.md): This endpoint merges the provided metadata with existing metadata on the wallet. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
- [Delete all wallet metadata](https://docs.nozle.dev/api-reference/wallets/delete-all-wallet-metadata.md): This endpoint removes all metadata from a wallet.
- [Delete a metadata key](https://docs.nozle.dev/api-reference/wallets/delete-a-metadata-key.md): This endpoint removes a single metadata key from a wallet.
- [List wallet alerts](https://docs.nozle.dev/api-reference/wallets/list-wallet-alerts.md): This endpoint enables the retrieval of all alerts for a wallet.
- [Create wallet alert(s)](https://docs.nozle.dev/api-reference/wallets/create-wallet-alerts.md): This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
- [Delete all wallet alerts](https://docs.nozle.dev/api-reference/wallets/delete-all-wallet-alerts.md): This endpoint allows you to delete all alerts for a wallet.
- [Retrieve a wallet alert](https://docs.nozle.dev/api-reference/wallets/retrieve-a-wallet-alert.md): This endpoint enables the retrieval of a specific alert for a wallet.
- [Update a wallet alert](https://docs.nozle.dev/api-reference/wallets/update-a-wallet-alert.md): This endpoint allows you to update an existing alert for a wallet.
- [Delete a wallet alert](https://docs.nozle.dev/api-reference/wallets/delete-a-wallet-alert.md): This endpoint allows you to delete an existing alert for a wallet.
- [Create a wallet](https://docs.nozle.dev/api-reference/wallets/create-a-wallet.md): This endpoint is used to create a wallet with prepaid credits.
- [List all wallets](https://docs.nozle.dev/api-reference/wallets/list-all-wallets.md): This endpoint is used to list all wallets with prepaid credits.
- [Update a wallet](https://docs.nozle.dev/api-reference/wallets/update-a-wallet.md): This endpoint is used to update an existing wallet with prepaid credits.
- [Retrieve a wallet](https://docs.nozle.dev/api-reference/wallets/retrieve-a-wallet.md): This endpoint is used to retrieve an existing wallet with prepaid credits.
- [Terminate a wallet](https://docs.nozle.dev/api-reference/wallets/terminate-a-wallet.md): This endpoint is used to terminate an existing wallet with prepaid credits.
- [Replace wallet metadata](https://docs.nozle.dev/api-reference/wallets/replace-wallet-metadata.md): This endpoint replaces all existing metadata on a wallet with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
- [Merge wallet metadata](https://docs.nozle.dev/api-reference/wallets/merge-wallet-metadata.md): This endpoint merges the provided metadata with existing metadata on the wallet. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
- [Delete all wallet metadata](https://docs.nozle.dev/api-reference/wallets/delete-all-wallet-metadata.md): This endpoint removes all metadata from a wallet.
- [Delete a metadata key](https://docs.nozle.dev/api-reference/wallets/delete-a-metadata-key.md): This endpoint removes a single metadata key from a wallet.
- [Top up a wallet](https://docs.nozle.dev/api-reference/wallets/top-up-a-wallet.md): This endpoint is used to top-up an active wallet.
- [Retrieve a wallet transaction](https://docs.nozle.dev/api-reference/wallets/retrieve-a-wallet-transaction.md): This endpoint is used to retrieve a specific wallet transactions.
- [Generate a payment URL](https://docs.nozle.dev/api-reference/wallets/generate-a-payment-url.md): This endpoint generates a checkout link for a specific wallet transaction.
- [List all consumptions for a wallet transaction](https://docs.nozle.dev/api-reference/wallets/list-all-consumptions-for-a-wallet-transaction.md): This endpoint is used to list all consumption records for an inbound wallet transaction. It shows how the credits from this inbound transaction were consumed by outbound transactions. Only available for traceable wallets.
- [List all fundings for a wallet transaction](https://docs.nozle.dev/api-reference/wallets/list-all-fundings-for-a-wallet-transaction.md): This endpoint is used to list all funding records for an outbound wallet transaction. It shows which inbound transactions funded this outbound transaction. Only available for traceable wallets.
- [List all wallet transactions](https://docs.nozle.dev/api-reference/wallets/list-all-wallet-transactions.md): This endpoint is used to list all wallet transactions.
- [Apply a coupon to a customer](https://docs.nozle.dev/api-reference/coupons/apply-a-coupon-to-a-customer.md): This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
- [List all applied coupons](https://docs.nozle.dev/api-reference/coupons/list-all-applied-coupons.md): This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.
- [Create a coupon](https://docs.nozle.dev/api-reference/coupons/create-a-coupon.md): This endpoint is used to create a coupon that can be then attached to a customer to create a discount.
- [List all coupons](https://docs.nozle.dev/api-reference/coupons/list-all-coupons.md): This endpoint is used to list all existing coupons.
- [Update a coupon](https://docs.nozle.dev/api-reference/coupons/update-a-coupon.md): This endpoint is used to update a coupon that can be then attached to a customer to create a discount.
- [Retrieve a coupon](https://docs.nozle.dev/api-reference/coupons/retrieve-a-coupon.md): This endpoint is used to retrieve a specific coupon.
- [Delete a coupon](https://docs.nozle.dev/api-reference/coupons/delete-a-coupon.md): This endpoint is used to delete a coupon.
- [List all customer's applied coupons](https://docs.nozle.dev/api-reference/customers/list-all-customers-applied-coupons.md): This endpoint is used to list all applied coupons for a customer.
- [Delete an applied coupon](https://docs.nozle.dev/api-reference/coupons/delete-an-applied-coupon.md): This endpoint is used to delete a specific coupon that has been applied to a customer.
- [Create an add-on](https://docs.nozle.dev/api-reference/add-ons/create-an-add-on.md): This endpoint is used to create an add-on that can be then attached to a one-off invoice.
- [List all add-ons](https://docs.nozle.dev/api-reference/add-ons/list-all-add-ons.md): This endpoint is used to list all existing add-ons.
- [Update an add-on](https://docs.nozle.dev/api-reference/add-ons/update-an-add-on.md): This endpoint is used to update an existing add-on.
- [Retrieve an add-on](https://docs.nozle.dev/api-reference/add-ons/retrieve-an-add-on.md): This endpoint is used to retrieve a specific add-on.
- [Delete an add-on](https://docs.nozle.dev/api-reference/add-ons/delete-an-add-on.md): This endpoint is used to delete an existing add-on.
- [Create a credit note](https://docs.nozle.dev/api-reference/credit-notes/create-a-credit-note.md): This endpoint creates a new credit note.
- [List all credit notes](https://docs.nozle.dev/api-reference/credit-notes/list-all-credit-notes.md): This endpoint list all existing credit notes.
- [Update a credit note](https://docs.nozle.dev/api-reference/credit-notes/update-a-credit-note.md): This endpoint updates an existing credit note.
- [Retrieve a credit note](https://docs.nozle.dev/api-reference/credit-notes/retrieve-a-credit-note.md): This endpoint retrieves an existing credit note.
- [Download a credit note PDF](https://docs.nozle.dev/api-reference/credit-notes/download-a-credit-note-pdf.md): This endpoint downloads the PDF of an existing credit note.
- [Estimate amounts for a new credit note](https://docs.nozle.dev/api-reference/credit-notes/estimate-amounts-for-a-new-credit-note.md): This endpoint allows you to retrieve amounts for a new credit note creation.
- [Void available credit](https://docs.nozle.dev/api-reference/credit-notes/void-available-credit.md): This endpoint voids the available credit linked to a specific credit note.
- [Replace credit note metadata](https://docs.nozle.dev/api-reference/credit-notes/replace-credit-note-metadata.md): This endpoint replaces all existing metadata on a credit note with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
- [Merge credit note metadata](https://docs.nozle.dev/api-reference/credit-notes/merge-credit-note-metadata.md): This endpoint merges the provided metadata with existing metadata on the credit note. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
- [Delete all credit note metadata](https://docs.nozle.dev/api-reference/credit-notes/delete-all-credit-note-metadata.md): This endpoint removes all metadata from a credit note.
- [Delete a metadata key](https://docs.nozle.dev/api-reference/credit-notes/delete-a-metadata-key.md): This endpoint removes a single metadata key from a credit note.
- [List all customer's credit notes](https://docs.nozle.dev/api-reference/customers/list-all-customers-credit-notes.md): This endpoint list all existing credit notes for a customer.
- [Create a tax](https://docs.nozle.dev/api-reference/taxes/create-a-tax.md): This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer.
- [List all taxes](https://docs.nozle.dev/api-reference/taxes/list-all-taxes.md): This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer.
- [Update a tax](https://docs.nozle.dev/api-reference/taxes/update-a-tax.md): This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer.
- [Retrieve a Tax](https://docs.nozle.dev/api-reference/taxes/retrieve-a-tax.md): This endpoint retrieves an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. The tax is identified by its unique code.
- [Delete a tax](https://docs.nozle.dev/api-reference/taxes/delete-a-tax.md): This endpoint is used to delete a tax.
- [List all customer's payments](https://docs.nozle.dev/api-reference/customers/list-all-customers-payments.md): This endpoint is used to list all payments of a customer
- [Create a payment](https://docs.nozle.dev/api-reference/payments/create-a-payment.md): This endpoint is used to create a manual payment
- [List all payments](https://docs.nozle.dev/api-reference/payments/list-all-payments.md): This endpoint is used to list all payments
- [Retrieve a payment](https://docs.nozle.dev/api-reference/payments/retrieve-a-payment.md): This endpoint retrieves a specific payment by its ID.
- [List all customer payment methods](https://docs.nozle.dev/api-reference/payment-methods/list-all-customer-payment-methods.md): This endpoint retrieves all payment methods of a Customer.
- [Set the payment method as default](https://docs.nozle.dev/api-reference/payment-methods/set-the-payment-method-as-default.md): Use the payment method as default when not selected a payment method
- [Delete a payment method](https://docs.nozle.dev/api-reference/payment-methods/delete-a-payment-method.md): This endpoint deletes a specific payment method for a customer.
- [List all payment receipts](https://docs.nozle.dev/api-reference/payment-receipts/list-all-payment-receipts.md): This endpoint is used to list all existing payment receipts.
- [Retrieve a payment receipt](https://docs.nozle.dev/api-reference/payment-receipts/retrieve-a-payment-receipt.md): This endpoint retrieves a specific payment receipt.
- [List all customer's payment requests](https://docs.nozle.dev/api-reference/customers/list-all-customers-payment-requests.md): This endpoint is used to list all existing payment requests of a customer.
- [Create a payment request](https://docs.nozle.dev/api-reference/payment-requests/create-a-payment-request.md): This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
- [List all payment requests](https://docs.nozle.dev/api-reference/payment-requests/list-all-payment-requests.md): This endpoint is used to list all existing payment requests.
- [Retrieve a payment request](https://docs.nozle.dev/api-reference/payment-requests/retrieve-a-payment-request.md): This endpoint retrieves a specific payment request by its ID.
- [List all billing entities](https://docs.nozle.dev/api-reference/billing-entities/list-all-billing-entities.md): This endpoint returns a list of all billing entities in the organization
- [Create a billing entity](https://docs.nozle.dev/api-reference/billing-entities/create-a-billing-entity.md): This endpoint is used to create a new billing entity
- [Retrieve a billing entity](https://docs.nozle.dev/api-reference/billing-entities/retrieve-a-billing-entity.md): This endpoint returns a specific billing entity by its code
- [Update a billing entity](https://docs.nozle.dev/api-reference/billing-entities/update-a-billing-entity.md): This endpoint is used to update an existing billing entity
- [Create a webhook_endpoint](https://docs.nozle.dev/api-reference/webhook-endpoints/create-a-webhook_endpoint.md): This endpoint is used to create a webhook endpoint.
- [List all webhook endpoints](https://docs.nozle.dev/api-reference/webhook-endpoints/list-all-webhook-endpoints.md): This endpoint is used to list all webhook endpoints.
- [Update a webhook endpoint](https://docs.nozle.dev/api-reference/webhook-endpoints/update-a-webhook-endpoint.md): This endpoint is used to update an existing webhook endpoint.
- [Retrieve a webhook endpoint](https://docs.nozle.dev/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint.md): This endpoint is used to retrieve an existing webhook endpoint.
- [Delete a webhook endpoint](https://docs.nozle.dev/api-reference/webhook-endpoints/delete-a-webhook-endpoint.md): This endpoint is used to delete an existing webhook endpoint.
- [Retrieve webhook public key as JSON](https://docs.nozle.dev/api-reference/webhooks/retrieve-webhook-public-key-as-json.md): This endpoint retrieves the public key used to verify webhook signatures, wrapped in a JSON object. Prefer it over the deprecated plain-text public-key endpoint.
- [Retrieve webhook public key](https://docs.nozle.dev/api-reference/webhooks/retrieve-webhook-public-key.md): This endpoint is used to retrieve the public key used to verify the webhooks signature
- [Update your organization](https://docs.nozle.dev/api-reference/organizations/update-your-organization.md): This endpoint is used to update your own organization's settings.
- [List gross revenue](https://docs.nozle.dev/api-reference/analytics/list-gross-revenue.md): Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
- [List of finalized invoices](https://docs.nozle.dev/api-reference/analytics/list-of-finalized-invoices.md): Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
- [List usage revenue](https://docs.nozle.dev/api-reference/analytics/list-usage-revenue.md): Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced…
- [List MRR](https://docs.nozle.dev/api-reference/analytics/list-mrr.md): This endpoint is used to list MRR.
- [List overdue balance](https://docs.nozle.dev/api-reference/analytics/list-overdue-balance.md): Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).
- [List usage](https://docs.nozle.dev/api-reference/analytics/list-usage.md): Returns usages.
- [List all activity logs](https://docs.nozle.dev/api-reference/activity-logs/list-all-activity-logs.md): This endpoint retrieves all existing activity logs that represent actions performed on application resources.
- [Retrieve an activity log](https://docs.nozle.dev/api-reference/activity-logs/retrieve-an-activity-log.md): This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.
- [List all api logs](https://docs.nozle.dev/api-reference/api-logs/list-all-api-logs.md): This endpoint retrieves all existing api logs that represent requests performed to Nozle's API.
- [Retrieve an api log](https://docs.nozle.dev/api-reference/api-logs/retrieve-an-api-log.md): This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.
- [Installation](https://docs.nozle.dev/sdks/react/installation.md): Install the React SDK and configure public catalog reads with merchant-backed checkout.
- [Theming](https://docs.nozle.dev/sdks/react/styling.md): Theme React SDK components with CSS variables and application styles.
- [Components](https://docs.nozle.dev/sdks/react/components.md): Pricing, checkout, billing, usage, and customer-facing React components.
- [Provider and hooks](https://docs.nozle.dev/sdks/react/hooks.md): Read the public catalog, start merchant-backed checkout, and access the React SDK context.
- [Feature gates](https://docs.nozle.dev/sdks/react/gates.md): Render UI from entitlement, usage, and plan state supplied by your authenticated backend.
- [Installation](https://docs.nozle.dev/sdks/node/installation.md): Install and configure the server-only @nozle-js/node SDK.
- [Billing and subscriptions](https://docs.nozle.dev/sdks/node/billing.md): List plans and create payment-aware checkout or direct subscriptions from a trusted backend.
- [Tracking events](https://docs.nozle.dev/sdks/node/tracking-events.md): Send idempotent metered events and control subscription attribution with nozle.track().
- [Product credits](https://docs.nozle.dev/sdks/node/credits.md): Discover credit systems, read exact balances, transfer Entity credits, and atomically consume usage.
- [Customers and Entities](https://docs.nozle.dev/sdks/node/customers-entities.md): Upsert customers and manage idempotent Entity lifecycle operations.
- [Entitlements](https://docs.nozle.dev/sdks/node/entitlements.md): Check feature access, usage limits, and margin state with nozle.can().
- [Margin queries](https://docs.nozle.dev/sdks/node/margin-queries.md): Query summary, customer, metric, plan, model, and trend margin data.
- [LLM auto-capture](https://docs.nozle.dev/sdks/node/llm-auto-capture.md): Wrap OpenAI or Anthropic clients to emit token metadata through nozle.track().
- [Installation](https://docs.nozle.dev/sdks/python/installation.md): Install and configure the typed, synchronous Nozle Python SDK.
- [Errors and retries](https://docs.nozle.dev/sdks/python/errors.md): Handle local validation, authentication, transport, and structured API errors safely.
- [Billing and subscriptions](https://docs.nozle.dev/sdks/python/billing.md): List plans and create checkout or direct subscriptions from Python.
- [Tracking events](https://docs.nozle.dev/sdks/python/tracking-events.md): Send idempotent metered events and control subscription attribution with nozle.track().
- [Product credits](https://docs.nozle.dev/sdks/python/credits.md): Discover credit systems, read exact balances, transfer Entity credits, and consume usage atomically.
- [Customers and Entities](https://docs.nozle.dev/sdks/python/customers-entities.md): Upsert customers and manage idempotent Entity lifecycle operations.
- [Entitlements](https://docs.nozle.dev/sdks/python/entitlements.md): Check feature access, usage limits, and margin state with nozle.can().
- [Margin queries](https://docs.nozle.dev/sdks/python/margin-queries.md): Query summary, customer, metric, plan, model, and trend margin data.
- [LLM auto-capture](https://docs.nozle.dev/sdks/python/llm-auto-capture.md): Wrap synchronous or asynchronous OpenAI and Anthropic clients to emit token metadata.
- [Stripe](https://docs.nozle.dev/integrations/stripe.md): Stripe integration for checkout and payments
- [Changelog](https://docs.nozle.dev/changelog/index.md): Product and developer-platform updates from Nozle

## OpenAPI Specs

- [nozle-openapi](/nozle-openapi.yaml)