Blog

Community

GitHub

Status

Lago

Documentation

API References

Integrations

Templates

Changelog

Get Started

Book a Demo

Retrieve a plan

Values used to apply differentiated pricing based on additional event properties.

Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.

List of all thresholds utilized for calculating the charge.

List of possible filter values. The key and values must match one of the billable metric filters.

Unique code identifying a billable metric.

Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.

The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard.

List of filters used to apply differentiated pricing based on additional event properties.

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.

This field specifies whether the charge should be included in a proper invoice. If set to `false`, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.

Unique identifier of the billable metric created by Lago.

Unique identifier of charge, created by Lago.

The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.

This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.

Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.

- If set to `true`, the charge is prorated based on the remaining days in the current billing period.
- If set to `false`, the charge is billed in full.
- If not defined in the request, default value is `false`.

This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
This field determines whether and when the charge fee should be included in
the invoice. If `null`, no invoice will be issued for this charge fee.
If `invoice`, an invoice will be generated at the end of the period,
consolidating all charge fees with a succeeded payment status.

- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.
- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.

The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.

The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.

The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.

The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.

Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.

Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.

The list of event properties that are used to group the events on the invoice for a `standard` charge model.

The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.

Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.

Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.

The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.

Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.

The amount of the minimum commitment in cents.

The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`.

Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.

Unique identifier of the minimum commitment, created by Lago.

The unique code representing the plan to be attached to the customer.

All taxes applied to the minimum commitment.

The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted.

The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.

The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.

This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.

Additional usage-based charges for this plan.

The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.

The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created.

The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted.

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.

Unique identifier of the plan created by Lago.

This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.

The duration in days during which the base cost of the plan is offered for free.

List of usage thresholds applied to the plan.

Number of add-ons this tax is applied to.

Set to `true` if the tax is used as one of the organization's default

Number of charges this tax is applied to.

Unique code used to identify the tax associated with the API request.

Number of customers this tax is applied to (directly or via the organization's default).

Unique identifier of the tax, created by Lago.

The amount to reach to trigger a `progressive_billing` invoice.

The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard.

Unique identifier of the usage threshold created by Lago.

This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.

The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.

bearerAuth

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.

Welcome to Lago

Why billing is a nightmare

Deploy Lago seamlessly on your infrastructure, compatible with both free and premium editions.

Overview

Docker is the easiest way to get started with the self-hosted version of Lago.

Docker

Tracking & Analytics

Versions update

Useful commands

Lago Cloud is the fully hosted version of our open-source billing API.

Lago Cloud

Billable metrics define how incoming events are aggregated in order to measure consumption.

Create billable metrics

Recurring vs metered

For more advanced calculations, you can use SQL custom expressions. These expressions are helpful when the aggregation results for a billable metric require complex calculations.

SQL Expressions

Lago aggregates your events in real time. You can add rounding rules to the final result.

Rounding

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.

Filters

Delete billable metrics

If Billable metrics are made to measure customer usage, Plans are made to apply prices to this usage.

The plan model defines when and how much a customer is charged.

Plan model

Commitments

Progressive billing, also known as threshold billing, automatically triggers an invoice when a customer's cumulative usage reaches predefined thresholds. This method ensures that customers cannot exceed certain usage limits without ensuring payment is received, reducing the risk of unpaid services or fraud.

Progressive billing

Customer management

Customer metadata

Invoice a customer

The customer portal

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).

Coupons

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).

Assign a plan to a customer

Customers have the flexibility to easily upgrade or downgrade their plan at any given moment.

Upgrades and downgrades

You can edit a subscription at any time, whether it's active or pending.

Edit a subscription

You can terminate a subscription at any time, whether it's active or pending.

Terminate a subscription

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.

Create add-ons

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.

Issue one-off invoices

This guide explains how Lago ingests usage-based events coming from your application.

Ingesting usage

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.

Events list

Learn how to retrieve usage data for both current and past billing periods.

Retrieving usage

Here is a list of sources you can use to ingest usage data. Some of these sources are capable of handling up to 15,000 events per second with default settings.

Metering ingestion sources

Lago automatically generates invoices for each customer according to the plan model.

Fees

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.

Taxes

Grace period

Net payment term

Download invoices

Invoice metadata

Void invoices

Lago enables you to filter invoices and export them as a simple or advanced CSV file, tailored to your needs.

Export invoices

Connect Lago to any payment providers by using native integrations or webhook messages.

Lago's native integration with GoCardless allows you to collect payments via direct debit.

GoCardless integration

Lago's native integration with Stripe allows you to collect payments automatically when new invoices are generated.

Stripe integration

Lago's native integration with Adyen allows you to collect payments automatically when new invoices are generated.

Adyen integration

Payment retries

Dunning refers to the process of communicating with customers to remind them of overdue invoices and attempt to recover the outstanding amounts.

Manual dunning

Automate how to communicate with your customers to remind them of overdue invoices and attempt to recover their overdue balance using dunning campaigns.

Automatic dunning

Credit notes

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.

Add and void credits, to the customer's wallet.

Top-up and void credits

Webhooks

Send automatic emails when issuing an invoice or any billing documents.

Emails

Overdue invoices

Gross revenue

Monthly Recurring Revenue (MRR)

Invoice collection

RBAC - Role Base Access Control

Single Sign-On (SSO)

SOC 2 Type 2

Entitlements

This step-by-step integration guide will help you get started with Lago.

Integration testing

Lago OpenAPI

Migration to v1.2.0

Lago API allows your application to push customer information and metrics (events) from your application to the billing application.

Getting started

This object represents an add-on, a one-time fee that can be applied on one-off invoices.

The add-on object

This endpoint is used to create an add-on that can be then attached to a one-off invoice.

Create an add-on

This endpoint is used to update an existing add-on.

Update an add-on

This endpoint is used to delete an existing add-on.

Delete an add-on

This endpoint is used to retrieve a specific add-on.

Retrieve an add-on

This endpoint is used to list all existing add-ons.

List all add-ons

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 gross revenue

Retrieve MRR (monthly recurring revenue)

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 amounts.

Retrieve invoiced usage

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`.

Retrieve invoice collection

Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).

Retrieve overdue balance

This object represents a billable metric used to define how incoming events are aggregated in order to measure consumption.

The billable metric object

This endpoint creates a new billable metric representing a pricing component of your application.

Create a billable metric

This endpoint updates an existing billable metric representing a pricing component of your application.

Update a billable metric

This endpoint deletes an existing billable metric representing a pricing component of your application.

API Reference

Retrieve a plan

Authorizations

Path Parameters

Response