Blog

Community

GitHub

Status

Lago

Documentation

API References

Integrations

Templates

Changelog

Get Started

Book a Demo

This endpoint is used for downloading a specific invoice PDF document.

Download an invoice

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 amount of credit associated with the invoice, expressed in cents.

Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation

The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number.

Unique identifier assigned to the credit item within the Lago application.

The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number.

The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice).

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

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

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.

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.

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 billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).

The cancellation date of the subscription. This field is not null when the subscription is `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.

The date and time when the current billing period ends, represented in ISO 8601 date format.

The date and time when the current billing period started, represented in ISO 8601 date format.

The date when the plan will be downgraded, represented in ISO 8601 date format.

The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).

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

The subscription external unique identifier (provided by your own application).

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

The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.

The code identifying the next plan in the case of a downgrade.

The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans.

The code identifying the previous plan associated with this subscription.

The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

The status of the subscription, which can have the following values:
- `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
- `active`: the subscription is currently active and applied to the customer.
- `terminated`: the subscription is no longer active.
- `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.

The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

The termination date of the subscription. This field is not null when the subscription is `terminated`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC)

The date when the free trial is ended, represented in ISO 8601 date format.

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

Download an invoice PDF

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.

API Reference

Download an invoice

Authorizations

Path Parameters

Response