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

Create a coupon

lago

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

bearerAuth

Authorization

Unique identifier assigned to the customer in your application.

external_customer_id

external_subscription_id

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

lago_id

page

per_page

The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.

List of unique code used to identify the taxes.

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

Unique identifier of the add-on, created by Lago.

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

The remaining amount in cents for a `fixed_amount` coupon with a frequency set to `once`. This field indicates the remaining balance or value that can still be utilized from the coupon.

The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard.

The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount.

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

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

The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods.

Unique identifier of the coupon, created by Lago.

Unique identifier of the customer, created by Lago.

Unique identifier of the applied coupon, created by Lago.

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

The status of the coupon. Can be either `active` or `terminated`.

This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard.

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.

Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.

Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.

Internal description of the billable metric.

Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.

Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric.

Defines if the billable metric is persisted billing period over billing period.

- If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.
- If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.
- If not defined in the request, default value is `false`.

Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.

Name of the event property used to group values.

Array of strings or objects representing all possible values.

Number of active subscriptions using this billable metric.

Number of draft invoices for which this billable metric is listed as an invoice item.

Unique identifier of the billable metric created by Lago.

Number of plans using this billable metric.

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

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

All charge information, sorted by groups.

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

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

Set coupon limitations to plans or specific metrics.

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.

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.

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.

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

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.

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

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.

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.

Unique identifier of the credit note, created by Lago.

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

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

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

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.

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

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, all the payment methods are selected. For now, possible values are `card` and `sepa_debit`.

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`

The amount in cents, tax excluded, consumed by the customer for a specific charge item.

Object listing all the properties for a specific charge item.

Array of group object, representing multiple dimensions for a charge item.

The number of units consumed by the customer for a specific charge item.

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 city of the customer's billing address

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

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 state of the customer's billing address

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

The zipcode of the customer's billing address

Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage.

The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).

The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).

The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.

The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application

The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.

The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.

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

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

This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.

This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.

This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.

Unique identifier of the fee, created by Lago.

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

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 and the payment for the fee is made in advance (`pay_in_advance` is set to true).

Unique identifier assigned to the subscription in your application. 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 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.

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.

Unique identifier assigned to the customer, created by Lago. 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).

Unique identifier assigned to the group that the fee belongs to

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 and the payment for the fee is made in advance (`pay_in_advance` is set to true).

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

Key of a specific group associated with the billable metric.

Unique identifier of a specific group associated with the billable metric.

One of the values for a specific group associated with the billable metric.

Unique identifier of a billable metric group, created by Lago.

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

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 payment due date for the invoice, specified in the ISO 8601 date format.

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.

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.

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: 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: 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 custom billing settings for your organization.

The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal.

The customer invoice message that appears at the bottom of each billing documents.

The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer’s grace period.

The first line of your organization’s billing address.

The second line of your organization’s billing address.

API Reference

Create a coupon

Authorizations

Body

Response