# Lago ## Docs - [Welcome to Lago](https://lago-ftr-wallet-improvements.mintlify.site/guide/introduction/welcome-to-lago.md): Lago is an open-source software for metering and usage-based billing. It's the best alternative to Chargebee, Recurly or Stripe Billing for companies that need to handle complex billing logic. - [Why billing is a nightmare](https://lago-ftr-wallet-improvements.mintlify.site/guide/introduction/why-billing-is-a-nightmare.md) - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/self-hosted/overview.md): Deploy Lago seamlessly on your infrastructure, compatible with both free and premium editions. - [Docker](https://lago-ftr-wallet-improvements.mintlify.site/guide/self-hosted/docker.md): Docker is the easiest way to get started with the self-hosted version of Lago. - [Tracking & Analytics](https://lago-ftr-wallet-improvements.mintlify.site/guide/self-hosted/tracking-analytics.md) - [Versions update](https://lago-ftr-wallet-improvements.mintlify.site/guide/self-hosted/update-instance.md) - [Lago Cloud](https://lago-ftr-wallet-improvements.mintlify.site/guide/lago-cloud.md): Lago Cloud is the fully hosted version of our open-source billing API. - [Create billable metrics](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/create-billable-metrics.md): Billable metrics define how incoming events are aggregated in order to measure consumption. - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/overview.md): Aggregation types will define how consumption will be measured. - [COUNT](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/count.md) - [UNIQUE COUNT](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/count-unique.md) - [LATEST](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/latest.md) - [MAX](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/max.md) - [SUM](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/sum.md) - [WEIGHTED SUM](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/weighted-sum.md) - [Aggregation examples](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/aggregation-types/aggregation-examples.md) - [Recurring vs metered](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/recurring-vs-metered.md) - [Filters](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/filters.md): When setting up your pricing, you may want to filters events according to their property. To do so, you can create filters for your billable metric. - [Delete billable metrics](https://lago-ftr-wallet-improvements.mintlify.site/guide/billable-metrics/delete-billable-metrics.md) - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/overview.md): If Billable metrics are made to measure customer usage, Plans are made to apply prices to this usage. - [Plan model](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/plan-model.md): The plan model defines when and how much a customer is charged. - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/overview.md): In addition to the price of the plan, you can charge your customers for usage. - [Standard](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/standard.md) - [Graduated](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/graduated.md) - [Package](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/package.md) - [Percentage](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/percentage.md) - [Volume](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/volume.md) - [Graduated percentage](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charge-models/graduated-percentage.md) - [Metered vs Recurring](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/metered-vs-recurring.md): Usage-based charges can be either metered or recurring - [Arrears vs Advance](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/arrears-vs-advance.md): Usage-based charges can be either charged in advance or in arrears - [Prorated vs Full](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/prorated-vs-full.md): Usage-based charges can be either bill fully or prorated based on the number of days used. - [Spending minimums](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/spending-minimum.md) - [Invoiceable vs Uninvoiceable](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/invoiceable-vs-noninvoiceable.md): In-advance charges can be either invoiceable or not. - [Charges with filters](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/charges/charges-with-filters.md): Charge your customers by leveraging a combination of filters specified in the billable metric. - [Commitments](https://lago-ftr-wallet-improvements.mintlify.site/guide/plans/commitment.md) - [Customer management](https://lago-ftr-wallet-improvements.mintlify.site/guide/customers/customer-management.md) - [Customer metadata](https://lago-ftr-wallet-improvements.mintlify.site/guide/customers/customer-metadata.md) - [Invoice a customer](https://lago-ftr-wallet-improvements.mintlify.site/guide/customers/invoice-customer.md) - [The customer portal](https://lago-ftr-wallet-improvements.mintlify.site/guide/customers/customer-portal.md) - [Coupons](https://lago-ftr-wallet-improvements.mintlify.site/guide/coupons.md): Coupons allow you to offer discounts to your customers. When you apply a coupon to a customer, its value will be deducted from their next subscription invoice(s). - [Assign a plan to a customer](https://lago-ftr-wallet-improvements.mintlify.site/guide/subscriptions/assign-plan.md): A subscription is created when a plan is assigned to a customer. You can assign a plan to a customer at any time (i.e. when the customer record is created or later on). - [Upgrades and downgrades](https://lago-ftr-wallet-improvements.mintlify.site/guide/subscriptions/upgrades-downgrades.md): Customers have the flexibility to easily upgrade or downgrade their plan at any given moment. - [Edit a subscription](https://lago-ftr-wallet-improvements.mintlify.site/guide/subscriptions/edit-subscription.md): You can edit a subscription at any time, whether it's active or pending. - [Terminate a subscription](https://lago-ftr-wallet-improvements.mintlify.site/guide/subscriptions/terminate-subscription.md): You can terminate a subscription at any time, whether it's active or pending. - [Create add-ons](https://lago-ftr-wallet-improvements.mintlify.site/guide/one-off-invoices/create-add-ons.md): Add-ons are a useful feature that allows you to add a fixed charge that is not recurring to one-off invoices. This can be used to apply one-time fees such as a setup fee, one-time payment, or customer success fee. - [Issue one-off invoices](https://lago-ftr-wallet-improvements.mintlify.site/guide/one-off-invoices/create-one-off-invoices.md): One-off invoices allow you to bill immediately one or several add-ons to a customer. This guide will show you how to create a one-off invoice for a specific customer using the add-ons. - [Ingesting usage](https://lago-ftr-wallet-improvements.mintlify.site/guide/events/ingesting-usage.md): This guide explains how Lago ingests usage-based events coming from your application. - [Events list](https://lago-ftr-wallet-improvements.mintlify.site/guide/events/events-list.md): By ingesting events, you can see them flowing in the Lago application by using the events list. It allows you to take a deeper look at ingested events and detect possible warnings. - [Retrieving usage](https://lago-ftr-wallet-improvements.mintlify.site/guide/events/retrieve-usage.md): Learn how to retrieve usage data for both current and past billing periods. - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/overview.md): Lago automatically generates invoices for each customer according to the plan model. - [Fees](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/fees.md): A fee is a line item in an invoice. - [Taxes](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/taxes.md): When generating invoices, you may need to apply vat or other taxes. By creating taxes and applying them to the organization or/and customers, their invoices will be directly affected. - [Grace period](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/grace-period.md) - [Net payment term](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/net-payment-term.md) - [Download invoices](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/download-invoices.md) - [Invoice metadata](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/invoice-metadata.md) - [Void invoices](https://lago-ftr-wallet-improvements.mintlify.site/guide/invoicing/void.md) - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/payments/overview.md): Connect Lago to any payment providers by using native integrations or webhook messages. - [GoCardless integration](https://lago-ftr-wallet-improvements.mintlify.site/guide/payments/gocardless-integration.md): Lago's native integration with GoCardless allows you to collect payments via direct debit. - [Stripe integration](https://lago-ftr-wallet-improvements.mintlify.site/guide/payments/stripe-integration.md): Lago's native integration with Stripe allows you to collect payments automatically when new invoices are generated. - [Adyen integration](https://lago-ftr-wallet-improvements.mintlify.site/guide/payments/adyen-integration.md): Lago's native integration with Adyen allows you to collect payments automatically when new invoices are generated. - [Payment retries](https://lago-ftr-wallet-improvements.mintlify.site/guide/payments/payment-retries.md) - [Credit notes](https://lago-ftr-wallet-improvements.mintlify.site/guide/credit-notes.md) - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/wallet-and-prepaid-credits/overview.md): Since usage-based charges can be calculated at the end of the billing period, you often need to wait to collect payments. With prepaid credits, you can now unlock recurring revenue opportunities for pay-as-you-go pricing models. - [Top-ups](https://lago-ftr-wallet-improvements.mintlify.site/guide/wallet-and-prepaid-credits/wallet-top-ups.md): Add either granted or prepaid credits, or a combination of both, to the customer's wallet. - [Webhooks](https://lago-ftr-wallet-improvements.mintlify.site/guide/webhooks.md) - [Emails](https://lago-ftr-wallet-improvements.mintlify.site/guide/emails.md): Send automatic emails when issuing an invoice or any billing documents. - [Overview](https://lago-ftr-wallet-improvements.mintlify.site/guide/analytics/overview.md) - [Gross revenue](https://lago-ftr-wallet-improvements.mintlify.site/guide/analytics/gross-revenue.md) - [Monthly Recurring Revenue (MRR)](https://lago-ftr-wallet-improvements.mintlify.site/guide/analytics/mrr.md) - [Invoice collection](https://lago-ftr-wallet-improvements.mintlify.site/guide/analytics/invoice-collection.md) - [Entitlements](https://lago-ftr-wallet-improvements.mintlify.site/guide/entitlements.md) - [Integration testing](https://lago-ftr-wallet-improvements.mintlify.site/guide/integration-testing.md): This step-by-step integration guide will help you get started with Lago. - [Single Sign-On (SSO)](https://lago-ftr-wallet-improvements.mintlify.site/guide/security/sso.md) - [SOC 2 Type 2](https://lago-ftr-wallet-improvements.mintlify.site/guide/security/soc.md): Keeping your data secure. - [Lago OpenAPI](https://lago-ftr-wallet-improvements.mintlify.site/guide/lago-open-api.md) - [Migration to v1.2.0](https://lago-ftr-wallet-improvements.mintlify.site/guide/migration/migration-to-v1.2.0.md) - [Getting started](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/intro.md): Lago API allows your application to push customer information and metrics (events) from your application to the billing application. - [The add-on object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/add-on-object.md): This object represents an add-on, a one-time fee that can be applied on one-off invoices. - [Create an add-on](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/create.md): This endpoint is used to create an add-on that can be then attached to a one-off invoice. - [Update an add-on](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/update.md): This endpoint is used to update an existing add-on. - [Delete an add-on](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/destroy.md): This endpoint is used to delete an existing add-on. - [Retrieve an add-on](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/get-specific.md): This endpoint is used to retrieve a specific add-on. - [List all add-ons](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/add-ons/get-all.md): This endpoint is used to list all existing add-ons. - [Retrieve gross revenue](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/analytics/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. - [Retrieve MRR](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/analytics/mrr.md): This endpoint is used to list MRR. - [Retrieve invoiced usage](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/analytics/invoiced-usage.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… - [Retrieve invoice collection](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/analytics/invoice-collection.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`. - [The billable metric object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/object.md): This object represents a billable metric that is a pricing component of your application. - [Create a billable metric](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/create.md): This endpoint creates a new billable metric representing a pricing component of your application. - [Update a billable metric](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/update.md): This endpoint updates an existing billable metric representing a pricing component of your application. - [Delete a billable metric](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/destroy.md): This endpoint deletes an existing billable metric representing a pricing component of your application. - [Retrieve a billable metric](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/get-specific.md): This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code. - [List all billable metrics](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/get-all.md): This endpoint retrieves all existing billable metrics that represent pricing components of your application. - [List all billable metric groups](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/billable-metrics/get-all-groups.md): This endpoint retrieves all groups for a billable metric. - [The coupon object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/coupon-object.md): This object represents a coupon. This coupon can be applied to a customer with overriden values. - [Create a coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/create.md): This endpoint is used to create a coupon that can be then attached to a customer to create a discount. - [Update a coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/update.md): This endpoint is used to update a coupon that can be then attached to a customer to create a discount. - [Delete a coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/destroy.md): This endpoint is used to delete a coupon. - [Retrieve a coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/get-specific.md): This endpoint is used to retrieve a specific coupon. - [List all coupons](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/get-all.md): This endpoint is used to list all existing coupons. - [The applied coupon object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/applied-coupon-object.md): This object represents a coupon applied to a customer. It can override the initial values of a coupon. - [Apply a coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/apply.md): This endpoint is used to apply a specific coupon to a customer, before or during a subscription. - [Delete an applied coupon](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/destroy-applied-coupon.md): This endpoint is used to delete a specific coupon that has been applied to a customer. - [List all applied coupons](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/coupons/get-all-applied.md): This endpoint is used to list all applied coupons. You can filter by coupon status and by customer. - [The credit note object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/credit-note-object.md): This object represents a credit note, used to refund or credit back a customer for a fee or an invoice. - [Create a credit note](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/create.md): This endpoint creates a new credit note. - [Download a credit note](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/download.md): This endpoint downloads the PDF of an existing credit note. - [Update a credit note](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/update.md): This endpoint updates an existing credit note. - [Void available credit](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/void.md): This endpoint voids the available credit linked to a specific credit note. - [Retrieve a credit note](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/get-specific.md): This endpoint retrieves an existing credit note. - [List all credit notes](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/credit-notes/get-all.md): This endpoint list all existing credit notes. - [The customer usage object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customer-usage/customer-usage-object.md): This object represents the usage-based charges associated with one of your customers for a defined billing period. It allows you to monitor customer usage throughout the period. - [Retrieve current usage](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customer-usage/get-current.md): Retrieve real-time customer usage data for the current open billing period. - [Retrieve past usage](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customer-usage/get-past.md): Fetch historical customer usage data for closed billing periods. - [The customer object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/object.md): This object represents a customer of your business. It lets you create or update a customer, but also track usage and create invoices for the same customer. - [Create a customer](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/create.md): This endpoint creates a new customer. - [Update a customer](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/update.md): This endpoint creates a new customer. - [Regenerate checkout URL](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/psp-checkout-url.md): This endpoint regenerates the Payment Provider Checkout URL of a Customer. - [Delete a customer](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/delete.md): This endpoint deletes an existing customer. - [Retrieve a customer](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/get-specific.md): This endpoint retrieves an existing customer. - [List all customers](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/get-all.md): This endpoint retrieves all existing customers. - [Retrieve customer portal URL](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/customers/customer-portal.md): Retrieves an embeddable link for displaying a customer portal. - [The event object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/events/event-object.md): Events represents usage measurement sent to lago application that will then be aggregated into invoice line items. - [Send usage event](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/events/usage.md): This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription. - [Batch usage events](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/events/batch.md): This endpoint can be used to send a batch of usage records. Each request may include up to 100 events. - [Estimate an upcoming fee](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/events/estimated-fee.md): Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges. - [Retrieve an event](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/events/get-specific.md): This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription. - [The fee object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/fees/fee-object.md): This object represents a line item of an invoice, handling amount, billed units and item description. - [Update a fee](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/fees/update-fee.md): This endpoint is used for updating a specific fee that has been issued. - [Retrieve a fee](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/fees/retrieve-fee.md): This endpoint is used for retrieving a specific fee that has been issued. - [List all fees](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/fees/list-fees.md): This endpoint is used for retrieving all fees that has been issued. - [The invoice object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/invoice-object.md): Lago automatically generates invoices for each of your customers at the end of a billing period. They list and summarize the fees generated by Lago for your customers. Subscription, usage-based and recurring fees are listed as invoice items. - [Create a one-off invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/create-oneoff.md): This endpoint is used for issuing a one-off invoice. - [Download an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/download.md): This endpoint is used for downloading a specific invoice PDF document. - [Void an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/void.md): This endpoint is used for voiding an invoice. You can void an invoice only when it's in a `finalized` status, and the payment status is not `succeeded`. - [Retry an invoice payment](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/retry.md): This endpoint resends an invoice for collection and retry a payment. - [Generate a payment URL](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/payment-url.md): This endpoint generates a checkout link for a specific invoice. - [Refresh an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/refresh.md): This endpoint is used for refreshing a draft invoice. - [Finalize an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/finalize.md): This endpoint is used for finalizing a draft invoice. - [Update an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/update.md): This endpoint is used for updating an existing invoice. - [Retrieve an invoice](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/get-specific.md): This endpoint is used for retrieving a specific invoice that has been issued. - [List all invoices](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/invoices/get-all.md): This endpoint is used for retrievign all invoices. - [The organization object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/organizations/organization-object.md): This object represents your organization. - [Update your organization](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/organizations/update.md): This endpoint is used to update your own organization's settings. - [The plan object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/object.md): This object represents a plan. This plan can then be assigned to a customer. - [Create a plan](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/create.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. - [Update a plan](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/update.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. - [Delete a plan](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/destroy.md): This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions. - [Retrieve a plan](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/get-specific.md): This endpoint retrieves a specific plan. - [List all plans](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/plans/get-all-plans.md): This endpoint retrieves all existing plans. - [Currencies](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/resources/currencies.md): List of accepted currencies (ISO 4217). - [Timezones](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/resources/timezones.md): List of accepted timezones (TZ database). - [Document locales](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/resources/locales.md) - [The subscription object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/subscription-object.md): This object represents the assignation of plan to one of the customer of your business. - [Create a subscription](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/assign-plan.md): This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades). - [Update a subscription](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/update.md): This endpoint allows you to update a subscription. - [Terminate a subscription](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/terminate.md): This endpoint allows you to terminate a subscription. - [Retrieve a subscription](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/get-specific.md): This endpoint retrieves a specific subscription. - [List all subscriptions](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/subscriptions/get-all.md): This endpoint retrieves all active subscriptions. - [The tax object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/tax-object.md): This object represents a customizable tax rate applicable to either the organization or a specific customer. - [Create a tax rate](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/create.md): This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer. - [Update a tax rate](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/update.md): This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. - [Delete a tax rate](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/destroy.md): This endpoint is used to delete a tax. - [Retrieve a tax rate](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/get-specific.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. - [List all tax rates](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/taxes/get-all.md): This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer. - [The wallet object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/wallet-object.md): This object represents a wallet, holding free or prepaid credits. - [Create a wallet](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/create.md): This endpoint is used to create a wallet with prepaid credits. - [Update a wallet](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/update.md): This endpoint is used to update an existing wallet with prepaid credits. - [Terminate a wallet](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/terminate.md): This endpoint is used to terminate an existing wallet with prepaid credits. - [Retrieve a wallet](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/get-specific.md): This endpoint is used to retrieve an existing wallet with prepaid credits. - [List all wallets](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/get-all.md): This endpoint is used to list all wallets with prepaid credits. - [The wallet transaction object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/wallet-transaction-object.md): This object represents a wallet transaction. It is used for topping up or voiding prepaid credits. - [Top-up a wallet](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/top-up.md): This endpoint is used to top-up an active wallet. - [List all wallet transactions](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/wallets/get-all-transactions.md): This endpoint is used to list all wallet transactions. - [The webhook endpoint object](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/webhook-endpoint-object.md): This object represents the webhook endpoint used for listening to Lago's events - [Create a webhook endpoint](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/create.md): This endpoint is used to create a webhook endpoint. - [Update a webhook endpoint](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/update.md): This endpoint is used to update an existing webhook endpoint. - [Delete a webhook endpoint](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/destroy.md) - [Retrieve a webhook endpoint](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/get-all.md): This endpoint is used to list all webhook endpoints. - [List all webhook endpoints](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhook-endpoints/get-specific.md): This endpoint is used to retrieve an existing webhook endpoint. - [Format & Signature](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhooks/format---signature.md): Webhooks are HTTP notifications sent from Lago to your application. - [Messages](https://lago-ftr-wallet-improvements.mintlify.site/api-reference/webhooks/messages.md): Here is the complete list of webhook messages sent by Lago. - [Introduction](https://lago-ftr-wallet-improvements.mintlify.site/integrations/introduction.md): Find all Lago native integrations with third party tools, whether it's related to payment providers, alerting systems or data integrations. - [Segment integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/usage/segment.md): Segment is a powerful tool that allows you to track the usage of your customers, providing valuable insights that can help you make data-driven decisions. This data can be sent to Lago, our usage-based billing platform, to automate your billing process and ensure accurate invoicing for your custom… - [Hightouch integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/usage/hightouch.md): Hightouch is a Data Activation platform that syncs data from sources (database, warehouses, spreadsheet and much more) to business applications and developer tools. This data can be sent to Lago, our usage-based billing platform, to automate your billing process and ensure accurate invoicing for y… - [Stripe integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/payments/stripe-integration.md): Lago's native integration with Stripe allows you to collect payments automatically when new invoices are generated. - [GoCardless integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/payments/gocardless-integration.md): Lago's native integration with GoCardless allows you to collect payments via direct debit. - [Adyen integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/payments/adyen-integration.md): Lago's native integration with Adyen allows you to collect payments automatically when new invoices are generated. - [Lago EU Taxes](https://lago-ftr-wallet-improvements.mintlify.site/integrations/taxes/lago-eu-taxes.md) - [Salesforce CRM](https://lago-ftr-wallet-improvements.mintlify.site/integrations/crm/salesforce-crm.md): Lago syncs billing data to Salesforce in real-time. - [Zapier integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/alerting/zapier.md) - [N8N integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/alerting/n8n.md) - [Airbyte (ETL) integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/data/airbyte.md) - [Oso integration](https://lago-ftr-wallet-improvements.mintlify.site/integrations/entitlements/osohq.md) - [About Lago](https://lago-ftr-wallet-improvements.mintlify.site/faq/about-lago.md) - [About the software](https://lago-ftr-wallet-improvements.mintlify.site/faq/about-software.md) - [Deployment](https://lago-ftr-wallet-improvements.mintlify.site/faq/deployment.md) ## OpenAPI Specs - [lago-openapi](https://lago-ftr-wallet-improvements.mintlify.site/lago-openapi.yaml) ## Optional - [Blog](https://www.getlago.com/blog) - [GitHub](https://github.com/getlago/lago)