Blog

Community

GitHub

Status

Lago

Documentation

API References

Integrations

Templates

Changelog

Get Started

Book a Demo

This endpoint is used for retrieving all invoices.

List all invoices

Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.

The city of the customer's billing address

Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)

The state of the customer's billing address

The zipcode of the customer's billing address

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

The amount of usage in cents that has been accumulated over the lifetime of the subscription.

The date and time when the applied tax 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 applied tax was initially created.

Unique identifier of the applied tax, created by Lago.

Unique identifier of the tax, created by Lago.

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

The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago

The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items

The payment provider utilized to initiate payments for invoices issued by Lago.
Accepted values: `stripe`, `adyen`, `gocardless` or null. This field is required if you intend to assign a `provider_customer_id`.

Unique code used to identify a payment provider connection.

The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer

Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.

Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false`

Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`

Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format

The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created

Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice.

A unique identifier for the customer metadata object in the Lago application. Can be used to update a key-value pair

The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created

The type of the customer. It can have one of the following values:
- `company`: the customer is a company.
- `individual`: the customer is an individual.

The customer external unique identifier (provided by your own application)

Specifies how invoices with a zero total amount should be handled:
- `inherit`: (Default) Follows the organization-level configuration.
- `finalize`: Invoices are issued and finalized even if the total amount is zero.
- `skip`: Invoices with a total amount of zero are not finalized.

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.

The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation

A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id`

The tax identification number of the customer

The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated

Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments.

The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.

Unique code used to identify an integration connection.

A unique identifier for the integration customer object in the Lago application.

This optional field is needed only when working with `netsuite` connection.

Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`

The integration type used for accounting and tax syncs.
Accepted values: `netsuite, anrok`.

Fees total amount on which the tax is applied

Unique identifier of the invoice, created by Lago.

The date and time when the metadata object was created. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Represents the key of the metadata's key-value pair.

Unique identifier assigned to the invoice metadata within the Lago application.

Represents the value of the metadata's key-value pair.

The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents.

The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents.

The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value.

Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice

The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.

The date when the invoice was issued. It is provided in the ISO 8601 date format.

Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.

The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.

The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).

The payment due date for the invoice, specified in the ISO 8601 date format.

Specifies if the payment is considered as overdue.

The status of the payment associated with the invoice. It can have one of the following values:
- `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
- `succeeded`: the payment of the invoice has been successfully processed.
- `failed`: the payment of the invoice has failed or encountered an error during processing.

The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents.

The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices.

This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.

The status of the invoice. It indicates the current state of the invoice and can have two possible values:
- `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
- `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
- `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
- `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.

Subtotal amount, excluding taxes, expressed in cents.
This field depends on the version number. Here are the definitions based on the version:
- Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`.
- Version 2: is equal to the `fees_amount_cents`.
- Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`

Subtotal amount, including taxes, expressed in cents.
This field depends on the version number. Here are the definitions based on the version:
- Version 1: is equal to the `total_amount_cents`.
- Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`.
- Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`

The sum of tax amount associated with the invoice, expressed in cents.

The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.

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.

API Reference

List all invoices

Authorizations

Query Parameters

Response