The fee object
{
"fee": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_group_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",
"amount_cents": 100,
"amount_currency": "EUR",
"taxes_amount_cents": 20,
"taxes_rate": 20,
"units": "0.32",
"total_amount_cents": 120,
"total_amount_currency": "EUR",
"events_count": 23,
"pay_in_advance": true,
"invoiceable": true,
"prorated": false,
"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",
"item": {
"type": "subscription",
"code": "startup",
"name": "Startup",
"lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"item_type": "Subscription"
},
"applied_taxes": [
{
"lago_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"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": 25,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z"
}
]
}
}
Attributes
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 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.
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 cost of this specific fee, including any applicable taxes.
The currency 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.
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.
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
.
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.
Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. If not defined, this argument is set to false
by default.
- 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.
Note that only a charge_model
sets to standard
or volume
can be prorated.
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 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
).
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 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 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 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
).
Was this page helpful?
{
"fee": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_group_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",
"amount_cents": 100,
"amount_currency": "EUR",
"taxes_amount_cents": 20,
"taxes_rate": 20,
"units": "0.32",
"total_amount_cents": 120,
"total_amount_currency": "EUR",
"events_count": 23,
"pay_in_advance": true,
"invoiceable": true,
"prorated": false,
"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",
"item": {
"type": "subscription",
"code": "startup",
"name": "Startup",
"lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"item_type": "Subscription"
},
"applied_taxes": [
{
"lago_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"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": 25,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z"
}
]
}
}