Retrieve an invoice

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

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

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

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

Unique identifier of the applied tax, created by Lago.

Unique identifier of the tax, created by Lago.

Name of the tax.

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

The percentage rate of the tax

Internal description of the taxe

Amount of the tax

Currency of the tax

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 invoice, created by Lago.

Fees total amount on which the tax is applied

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

The currency of the credit.

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 item attached to the credit.

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 charge filter that the fee belongs to

Unique identifier assigned to the invoice that the fee belongs to

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.

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 customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

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.

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.

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.

The cost of the tax associated with this specific fee.

The tax rate associated with this specific fee.

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.

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

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

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

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.

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

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

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.

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 fee was created. 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 date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.

The date and time when the payment for the fee was refunded. 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).

List of all unit amount details for calculating the fee.

Item attached to the fee

List of fee applied taxes

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 subscription external unique identifier (provided by your own application).

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 customer external unique identifier (provided by your own application).

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 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 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 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 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 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 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 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 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 code identifying the previous plan associated with this subscription.

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

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

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