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

invoice
object
lago_id
string
required

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.

sequential_id
integer

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.

number
string
required

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.

issuing_date
string
required

The date when the invoice was issued. It is provided in the ISO 8601 date format.

payment_due_date
string
required

The payment due date for the invoice, specified in the ISO 8601 date format.

net_payment_term
integer
required

The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.

invoice_type
string
required

The type of invoice issued. Possible values are subscription, one-off or credit.

status
string
required

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.

payment_status
string
required

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.

currency
string
required

The currency of the invoice issued.

fees_amount_cents
integer
required

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.

taxes_amount_cents
integer
required

The sum of tax amount associated with the invoice, expressed in cents.

coupons_amount_cents
integer
required

The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents.

credit_notes_amount_cents
integer
required

The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents.

prepaid_credit_amount_cents
integer
required

The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents.

sub_total_taxes_excluding_amount_cents
integer
required

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.

sub_total_taxes_including_amount_cents
integer
required

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_cents

total_amount_cents
integer
required

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.

file_url
string

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

payment_dispute_lost_at
string

The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).

customers
object
required
subscriptions
object
required
fee
object
lago_id
string
required

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.

lago_group_id
string

Unique identifier assigned to the group that the fee belongs to

lago_invoice_id
string

Unique identifier assigned to the invoice that the fee belongs to

lago_true_up_fee_id
string

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.

lago_true_up_parent_fee_id
string

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.

lago_subscription_id
string

Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

lago_customer_id
string

Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.

ro

external_customer_id
string

Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.

external_subscription_id
string

Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.

invoice_display_name
string

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.

amount_cents
integer
required

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

amount_currency
string
required

The currency of this specific fee. It indicates the monetary unit in which the fee’s cost is expressed.

taxes_amount_cents
integer
required

The cost of the tax associated with this specific fee.

taxes_rate
number
required

The tax rate associated with this specific fee.

units
string
required

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.

precise_unit_amount
string
required

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

total_amount_cents
integer
required

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

total_amount_currency
string
required

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

events_count
integer

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.

pay_in_advance
boolean
required

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

invoiceable
boolean
required

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.

from_date
string

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.

to_date
string

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.

payment_status
string
required

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.

created_at
string

The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format.

succeeded_at
string

The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format.

failed_at
string

The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.

refunded_at
string

The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format

event_transaction_id
string

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

amount_details
object
required

List of all unit amount details for calculating the fee.

item
object
applied_taxes
object
credits
object
required
metadata
object

Was this page helpful?

List all feesCreate a one-off invoice