This endpoint is used to retrieve a specific coupon.

Retrieve a coupon

The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.

The currency of the coupon. This field is required only for coupon with `fixed_amount` type.

An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.

The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.

- If set to `fixed_amount`, the coupon represents a fixed amount discount.
- If set to `percentage`, the coupon represents a percentage-based discount.

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

Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.

- If set to `time_limit`, the coupon has an expiration based on a specified time limit.
- If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely.

The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.

The type of frequency for the coupon. It can have three possible values: `once`, `recurring`, or `forever`.

- If set to `once`, the coupon is applicable only for a single use.
- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.
- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.

Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type

Unique identifier of the coupon, created by Lago.

The coupon is limited to specific billable metrics. The possible values can be `true` or `false`.

The coupon is limited to specific plans. The possible values can be `true` or `false`.

The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.

An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.

Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.

This field indicates if the coupon has been terminated and is no longer usable. If it's not null, it won't be removed for existing customers using it, but it prevents the coupon from being applied in the future.

bearerAuth

Lago

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

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

Lago Cloud

Billing entities allow an organization to manage different billing configurations.

Billing entities (Beta)

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

Entitlements

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

Emails

Credit notes

Model your revenue-sharing structure within Lago.

Revenue share

Webhooks

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

Integration testing

Lago OpenAPI

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

Getting started

Find all Lago integrations with third-party tools—whether for payment providers, alerting systems, or data integrations. Note that some integrations are native and actively maintained by Lago, while others are community-developed and come with limited support.

Introduction

Replicate these popular B2B pricing templates to kickstart your journey with Lago.

Replicate Mistral's per-token pricing model with Lago.

Clone Mistral pricing

Replicate OpenAI's per-token pricing model with Lago.

Clone OpenAI pricing

Replicate Segment's hybrid pricing model with Lago.

Clone Segment pricing

Replicate Stripe's per-transaction pricing model with Lago.

Clone Stripe pricing

Replicate Algolia's pay-as-you-go pricing model with Lago.

Clone Algolia pricing

Replicate BigQuery's pay-as-you-go pricing model and offer free upfront credits with Lago.

Clone Google BigQuery pricing

Replicate Notion's per-seat pricing model with Lago.

Clone Notion pricing

About Lago

About the software

Community

Deployment

General

Pricing

Product features

Product updates

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

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

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

With Lago, you can preview invoices even if the customer doesn't exist yet or for an active subscription, allowing you to generate dry-run invoices or estimate potential bills.

Preview an invoice

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

Make your users pay Lago invoices with Cashfree Payments, India's leading payments and API banking company.

Cashfree Integration

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

GoCardless integration

Payment retries

Lago automatically generates payment receipts for each payment processed, whether manual or through payment provider integrations.

Payment receipts

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 customer communications to remind them of overdue invoices and recover outstanding balances through targeted dunning campaigns.

Automatic dunning

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

Overdue invoices

Gross revenue

Monthly Recurring Revenue (MRR)

Invoice collection

API Keys

RBAC - Role Base Access Control

Single Sign-On (SSO)

SOC 2 Type 2

Migration to v1.20.0

Migration to v1.2.0

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.

Delete a billable metric

This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code.

Retrieve a billable metric

This endpoint retrieves all existing billable metrics that represent pricing components of your application.

List all billable metrics

List all billable metric groups

This object represents a coupon used to applies discount on customer next invoices. This coupon can be applied to a customer with overriden values.

The coupon object

This endpoint is used to create a coupon that can be then attached to a customer to create a discount.

Create a coupon

This endpoint is used to update a coupon that can be then attached to a customer to create a discount.

Update a coupon

This endpoint is used to delete a coupon.

Delete a coupon

This endpoint is used to list all existing coupons.

List all coupons

This object represents a coupon applied to a customer. It can override the initial values of a coupon.

API Reference

Retrieve a coupon

Authorizations

Path Parameters

Response