The fee object

This object represents a line item of an invoice, handling amount, billed units and item description.

The fee object

{
  "fee": {
    "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"
      }
    ]
  }
}

Attributes

fee · object

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

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]

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.

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]

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.

Show child attributes

Case of a fee linked to a graduated charge model

graduated_ranges · array

Graduated ranges, used for a graduated charge model.

Show child attributes

units · string

Total units received in Lago.

from_value · integer

Lower value of a tier. It is either 0 or the previous range’s to_value + 1

to_value · integer

Highest 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 · string

Flat unit amount within a specified tier.

per_unit_amount · string

Amount per unit within a specified tier.

per_unit_total_amount · string

Total amount of received units to be charged within a specified tier.

total_with_flat_amount · string

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

Graduated percentage ranges, used for a graduated_percentage charge model.

Show child attributes

units · string

Total units received in Lago.

from_value · integer

Lower value of a tier. It is either 0 or the previous range’s to_value + 1

to_value · integer

Highest 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 · string

Flat unit amount within a specified tier.

rate · string

Percentage rate applied within a specified tier.

per_unit_total_amount · string

Total amount of received units to be charged within a specified tier.

total_with_flat_amount · string

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

free_units · string

The quantity of units that are provided free of charge for each billing period in a package charge model.

paid_units · string

The quantity of units that are not provided free of charge for each billing period in a package charge model.

per_package_size · integer

The quantity of units included, defined for package or percentage charge model.

per_package_unit_amount · string

Total amount to charge for received paid_units``, defined for packageorpercentage` charge model.

Case of a fee linked to a percentage charge model

units · string

The total units received in Lago for the percentage charge model.

free_events · integer

Total number of free events allowed for the percentage charge model.

free_units · string

The quantity of units that are provided free of charge for each billing period in a package or percentage charge model.

paid_units · string

The quantity of units that are not provided free of charge for each billing period in a package or percentage charge model.

rate · string

Percentage rate applied for the Percentage charge model.

per_unit_total_amount · string

Total amount of received units to be charged for the percentage charge model.

paid_events · integer

Total number of paid events for the percentage charge model.

fixed_fee_unit_amount · string

Fixed fee unit price per received paid_event for the percentage charge model.

fixed_fee_total_amount · string

Total amount to charge for received paid_events for the percentage charge model.

min_max_adjustment_total_amount · string

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

volume_ranges · array

Volumes ranges, used for a volume charge model.

Show child attributes

flat_unit_amount · string

The unit price, excluding tax, for a specific tier of a volume charge model.

per_unit_amount · string

The flat amount for a whole tier, excluding tax, for a volume charge model.

per_unit_total_amount · string

Total amount of received units to be charged.

item · object

Show item

type · string · required

The fee type. Possible values are add-on, charge, credit or subscription.

code · string · required

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.

name · string · required

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.

lago_item_id · string · required

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.

item_type · string · required

The type of the fee item. Possible values are AddOn, BillableMetric, WalletTransaction or Subscription.

grouped_by · string · required

Key value list of event properties aggregated by the charge model.

filters · string · required

Key value list of event properties.

filters_invoice_display_name · string · required

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.

applied_taxes · object

Show applied_taxes

lago_id · string · required

Unique identifier of the applied tax, created by Lago.

lago_tax_id · string · required

Unique identifier of the tax, created by Lago.

tax_name · string · required

Name of the tax.

tax_code · string · required

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

tax_rate · number · required

The rate of the tax.

tax_description · string

Internal description of the tax.

amount_cents · integer · required

Amount of the tax.

amount_currency · string · required

The currency of the tax.

created_at · string · required

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.

lago_fee_id · string · required

Unique identifier of the fee, created by Lago.