Blog

Community

GitHub

Status

Lago

Documentation

API References

Integrations

Templates

Changelog

Get Started

Book a Demo

This endpoint updates an existing credit note.

Update a credit note

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.

Unique identifier of the credit note, created by Lago.

The credit note's item amount, expressed in cents.

The fee object related to the credit note item.

The credit note's item unique identifier, created by Lago.

The remaining credit note amount, expressed in cents.

The pro-rated amount of the coupons applied to the source invoice.

The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).

The credited amount of the credit note, expressed in cents.

The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:

- `available`: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices.
- `consumed`: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety.
- `voided`: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption.

The invoice unique number, related to the credit note.

The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.

The credit note unique identifier, created by Lago.

Unique identifier assigned to the invoice that the credit note belongs to

The reason of the credit note creation.
Possible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`.

The refunded amount of the credit note, expressed in cents.

The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:

- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.
- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.
- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

The subtotal of the credit note excluding any applicable taxes, expressed in cents.

The tax amount of the credit note, expressed in cents.

The tax rate associated with this specific credit note.

The total amount of the credit note, expressed in cents.

The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).

Unique identifier of the fee, created by Lago.

The cost of this specific fee, excluding any applicable taxes.

The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed.

List of all unit amount details for calculating the fee.

The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format.

Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`).

The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.

Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.

Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.

The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.

The beginning date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the start date of the billing period or subscription period associated with the fee.

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.

Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where `true` represents that the fee was included on the invoice, and `false` indicates that the fee was not included on the invoice.

The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`.

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

Key value list of event properties aggregated by the charge model

The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`.

Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`.

The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`.

The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.

Unique identifier assigned to the charge filter that the fee belongs to

Unique identifier assigned to the charge that the fee belongs to

Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

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.

Unique identifier assigned to the invoice that the fee belongs to

Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount.

Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee.

Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where `true` represents that the fee was paid in advance (straightaway), and `false` indicates that the fee was not paid in arrears (at the end of the period).

Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and `refunded`.

The cost of this specific fee, excluding any applicable taxes, with precision.

The cost of this specific fee, including any applicable taxes, with precision.

The unit amount of the fee per unit, with precision.

The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format

The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format.

The cost of the tax associated with this specific fee.

The cost of the tax associated with this specific fee, with precision.

The tax rate associated with this specific fee.

The ending date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the end date of the billing period or subscription period associated with the fee.

The cost of this specific fee, including any applicable taxes.

The currency of this specific fee, including any applicable taxes.

The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer.

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

API Reference

Update a credit note

Authorizations

Path Parameters

Body

Response