Copy
Ask AI
{
"invoice": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 2,
"number": "LAG-1234-001-002",
"issuing_date": "2022-04-30",
"payment_dispute_lost_at": "2022-09-14T16:35:31Z",
"payment_due_date": "2022-04-30",
"net_payment_term": 30,
"invoice_type": "subscription",
"status": "finalized",
"payment_status": "succeeded",
"currency": "EUR",
"fees_amount_cents": 100,
"coupons_amount_cents": 10,
"credit_notes_amount_cents": 10,
"sub_total_excluding_taxes_amount_cents": 100,
"taxes_amount_cents": 20,
"sub_total_including_taxes_amount_cents": 120,
"prepaid_credit_amount_cents": 0,
"total_amount_cents": 100,
"version_number": 3,
"file_url": "https://getlago.com/invoice/file",
"customer": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 1,
"slug": "LAG-1234-001",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": null,
"applicable_timezone": "America/Los_Angeles",
"city": "Woodland Hills",
"country": "US",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"name": "Gavin Belson",
"phone": "1-171-883-3711 x245",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"url": "http://hooli.com",
"zipcode": "91364",
"net_payment_term": 30,
"created_at": "2022-04-29T08:59:51Z",
"updated_at": "2022-04-29T08:59:51Z",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"payment_provider_code": "stripe-eu-1",
"provider_customer_id": "cus_12345",
"sync": true,
"sync_with_provider": true,
"document_locale": "fr",
"provider_payment_methods": [
"card",
"sepa_debit"
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "Purchase Order",
"value": "123456789",
"display_in_invoice": true,
"created_at": "2022-04-29T08:59:51Z"
}
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "digital_ref_id",
"value": "INV-0123456-98765",
"created_at": "2022-04-29T08:59:51Z"
}
],
"applied_taxes": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_name": "TVA",
"tax_code": "french_standard_vat",
"tax_rate": 20,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"fees_amount_cents": 20000
}
],
"credits": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"amount_cents": 1200,
"amount_currency": "EUR",
"before_taxes": false,
"item": {
"lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"type": "coupon",
"code": "startup_deal",
"name": "Startup Deal"
},
"invoice": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"payment_status": "succeeded"
}
}
],
"fees": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_charge_filter_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_true_up_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_true_up_parent_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "external_id",
"external_subscription_id": "external_id",
"invoice_display_name": "Setup Fee (SF1)",
"amount_cents": 100,
"amount_currency": "EUR",
"taxes_amount_cents": 20,
"taxes_rate": 20,
"units": "0.32",
"precise_unit_amount": "312.5",
"total_amount_cents": 120,
"total_amount_currency": "EUR",
"events_count": 23,
"pay_in_advance": true,
"invoiceable": true,
"from_date": "2022-04-29T08:59:51Z",
"to_date": "2022-05-29T08:59:51Z",
"payment_status": "pending",
"created_at": "2022-08-24T14:58:59Z",
"succeeded_at": "2022-08-24T14:58:59Z",
"failed_at": "2022-08-24T14:58:59Z",
"refunded_at": "2022-08-24T14:58:59Z",
"event_transaction_id": "transaction_1234567890",
"amount_details": {
"graduated_ranges": [
{
"units": "10.0",
"from_value": 0,
"to_value": 10,
"flat_unit_amount": "1.0",
"per_unit_amount": "1.0",
"per_unit_total_amount": "10.0",
"total_with_flat_amount": "11.0"
}
],
"graduated_percentage_ranges": [
{
"units": "10.0",
"from_value": 0,
"to_value": 10,
"flat_unit_amount": "1.0",
"rate": "1.0",
"per_unit_total_amount": "10.0",
"total_with_flat_amount": "11.0"
}
],
"free_units": "10.0",
"paid_units": "40.0",
"per_package_size": 1000,
"per_package_unit_amount": "0.5",
"units": "20.0",
"free_events": 10,
"rate": "1.0",
"per_unit_total_amount": "10.0",
"paid_events": 20,
"fixed_fee_unit_amount": "1.0",
"fixed_fee_total_amount": "20.0",
"min_max_adjustment_total_amount": "20.0",
"volume_ranges": [
{
"per_unit_amount": "0.5",
"flat_unit_amount": "10.0",
"per_unit_total_amount": "10.0"
}
]
},
"item": {
"type": "subscription",
"code": "startup",
"name": "Startup",
"invoice_display_name": "Setup Fee (SF1)",
"filter_invoice_display_name": "AWS eu-east-1",
"filters": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"item_type": "Subscription",
"grouped_by": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"applied_taxes": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_name": "TVA",
"tax_code": "french_standard_vat",
"tax_rate": 20,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
}
]
}
],
"subscriptions": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"billing_time": "anniversary",
"name": "Repository A",
"plan_code": "premium",
"status": "active",
"created_at": "2022-08-08T00:00:00Z",
"canceled_at": "2022-09-14T16:35:31Z",
"started_at": "2022-08-08T00:00:00Z",
"ending_at": "2022-10-08T00:00:00Z",
"subscription_at": "2022-08-08T00:00:00Z",
"terminated_at": "2022-09-14T16:35:31Z",
"previous_plan_code": null,
"next_plan_code": null,
"downgrade_plan_date": "2022-04-30",
"trial_ended_at": "2022-08-08T00:00:00Z"
}
]
}
}
Attributes
Hide object
Hide object
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.
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 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 invoice was issued. It is provided in the ISO 8601 date
format.
The payment due date for the invoice, specified in the ISO 8601 date
format.
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 type of invoice issued. Possible values are
subscription, one-off
or credit.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 is considered as having zero value for reporting and is not
payable. Importantly, this status is final, meaning the invoice’s status
remains unalterable.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 currency of the invoice issued.
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.
The sum of tax amount associated with the invoice, expressed in cents.
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 all prepaid credits discounted on the invoice. It
calculates the cumulative discount amount applied by prepaid credits,
expressed in cents.
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 vat_amount_cents. - Version 3: is
equal to the sum sub_total_excluding_taxes_amount_cents and
taxes_amount_centsThe 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.
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 date when the payment dispute was lost. It is expressed in Coordinated
Universal Time (UTC).
Show customers
Show customers
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 first line of the billing address.
The second line of the billing address.
The city of the customer’s billing address.
Country code of the customer’s billing address. Format must be ISO
3166 (alpha-2).
Currency of the customer. Format must ISO 4217.
The email of the customer.
The legal company name of the customer.
The legal company number of the customer.
The tax identification number of the customer
The logo URL of the customer.
The full name of the customer.
The phone number of the customer.
The state of the customer’s billing address.
The customer’s timezone, used for billing purposes in their local
time. Overrides the organization’s timezone.
The custom website URL of the customer.
The zipcode of the customer’s billing address.
Show subscriptions
Show subscriptions
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 unique external identifier for the subscription in your
application. This identifier serves as an idempotency key, ensuring
that each subscription is unique.
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 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 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 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 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 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 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)Hide object
Hide object
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 group 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 in your application. 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.
Show Enum
Show Enum
[
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG,
AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB,
BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF,
CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP,
DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP,
GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF,
IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR,
KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL,
MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR,
MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK,
NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG,
QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK,
SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS,
TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU,
UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER,
ZAR, ZMW]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.
Show Enum
Show Enum
[
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG,
AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB,
BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF,
CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP,
DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP,
GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF,
IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR,
KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL,
MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR,
MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK,
NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG,
QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK,
SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS,
TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU,
UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER,
ZAR, ZMW]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.
Show child attributes
Show child attributes
Case of a fee linked to a graduated charge model
Graduated ranges, used for a
graduated charge model.Show child attributes
Show child attributes
Total units received in Lago.
Lower value of a tier. It is either 0 or the previous range’s
to_value + 1Highest value of a tier. - This value is higher than the
from_value of the same tier. - This value is null for the last
tier.
Flat unit amount within a specified tier.
Amount per unit within a specified tier.
Total amount of received units to be charged within a
specified tier.
Total amount to be charged for a specific tier, taking into
account the
flat_unit_amount and the
per_unit_total_amount.Case of a fee linked to a graduated percentage charge model
Graduated percentage ranges, used for a
graduated_percentage
charge model.Show child attributes
Show child attributes
Total units received in Lago.
Lower value of a tier. It is either 0 or the previous range’s
to_value + 1Highest value of a tier. - This value is higher than the
from_value of the same tier. - This value is null for the last
tier.
Flat unit amount within a specified tier.
Percentage rate applied within a specified tier.
Total amount of received units to be charged within a
specified tier.
Total amount to be charged for a specific tier, taking into
account the
flat_unit_amount and the
per_unit_total_amount.Case of a fee linked to a package charge model
The quantity of units that are provided free of charge for each
billing period in a
package charge model.The quantity of units that are not provided free of charge for
each billing period in a
package charge model.The quantity of units included, defined for
package or
percentage charge model.Total amount to charge for received
paid_units``, defined for packageorpercentage` charge model.Case of a fee linked to a percentage charge model
The total units received in Lago for the
percentage charge
model.Total number of free events allowed for the
percentage charge
model.The quantity of units that are provided free of charge for each
billing period in a
package or percentage charge model.The quantity of units that are not provided free of charge for
each billing period in a
package or percentage charge model.Percentage rate applied for the Percentage charge model.
Total amount of received units to be charged for the
percentage
charge model.Total number of paid events for the
percentage charge model.Fixed fee unit price per received paid_event for the
percentage
charge model.Total amount to charge for received paid_events for the
percentage charge model.Total adjustment amount linked to minimum and maximum spending per
transaction for the
percentage charge model.Case of a fee linked to a volume charge model
Volumes ranges, used for a
volume charge model.Show item
Show item
The fee type. Possible values are
add-on, charge, credit or
subscription.The code of the fee item. It can be the code of the
add-on, the
code of the charge, the code of the credit or the code 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.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 type of the fee item. Possible values are
AddOn,
BillableMetric, WalletTransaction or Subscription.Key value list of event properties aggregated by the charge model.
Key value list of event properties.
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.
Show applied_taxes
Show applied_taxes
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 rate of the tax.
Internal description of the tax.
Amount of the tax.
The 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 fee, created by Lago.
Show credits
Show credits
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.
Show item
Show item
Unique identifier assigned to the credit item within the Lago
application.
The type of credit applied. Possible values are
coupon or
credit_note.The code of the credit applied. It can be the code of the coupon
attached to the credit or the credit note’s number.
The name of the credit applied. It can be the name of the coupon
attached to the credit or the initial invoice’s number linked to
the credit note.
Show metadata
Show metadata
Unique identifier assigned to the invoice metadata within the Lago
application.
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.
Represents the value of the metadata’s key-value pair.