Update a fee

PUT

fees

{lago_id}

curl --location --request PUT "$LAGO_URL/api/v1/fees/1a901a90-1a90-1a90-1a90-1a901a901a90" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "fee": {
      "payment_status": "succeeded"
    }
  }'

{
  "fee": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_charge_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,
    "precise_amount": "1.0001",
    "precise_total_amount": "1.0212",
    "amount_currency": "EUR",
    "taxes_amount_cents": 20,
    "taxes_precise_amount": "0.20123",
    "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"
        }
      ]
    },
    "self_billed": false,
    "item": {
      "type": "subscription",
      "code": "startup",
      "name": "Startup",
      "invoice_display_name": "Setup Fee (SF1)",
      "filter_invoice_display_name": "AWS eu-east-1",
      "filters": {},
      "lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "item_type": "Subscription",
      "grouped_by": {}
    },
    "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"
      }
    ]
  }
}

curl --location --request PUT "$LAGO_URL/api/v1/fees/1a901a90-1a90-1a90-1a90-1a901a901a90" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "fee": {
      "payment_status": "succeeded"
    }
  }'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

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.

Body

application/json

Fee payload

fee

object

required

Response

200

application/json

Fee updated

fee

object

required

fee.amount_cents

integer

required

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

fee.amount_currency

enum<string>

required

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

Available options:

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

fee.taxes_amount_cents

integer

required

The cost of the tax associated with this specific fee.

fee.taxes_rate

number

required

The tax rate associated with this specific fee.

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.

fee.precise_unit_amount

string

required

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

fee.total_amount_cents

integer

required

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

fee.total_amount_currency

enum<string>

required

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

Available options:

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

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

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

fee.payment_status

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

Available options:

pending,

succeeded,

failed,

refunded

fee.item

object

required

Item attached to the fee

fee.lago_id

string | null

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.

fee.lago_charge_id

string | null

Unique identifier assigned to the charge that the fee belongs to

fee.lago_charge_filter_id

string | null

Unique identifier assigned to the charge filter that the fee belongs to

fee.lago_invoice_id

string | null

Unique identifier assigned to the invoice that the fee belongs to

fee.lago_true_up_fee_id

string | null

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.

fee.lago_true_up_parent_fee_id

string | null

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.

fee.lago_subscription_id

string | null

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

fee.lago_customer_id

string | null

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

fee.external_customer_id

string | null

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

fee.external_subscription_id

string | null

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

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

fee.precise_amount

string

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

fee.precise_total_amount

string

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

fee.taxes_precise_amount

string

The cost of the tax associated with this specific fee, with precision.

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

fee.from_date

string | null

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.

fee.to_date

string | null

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.

fee.created_at

string | null

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

fee.succeeded_at

string | null

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

fee.failed_at

string | null

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

fee.refunded_at

string | null

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

fee.event_transaction_id

string | null

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

fee.amount_details

object

List of all unit amount details for calculating the fee.

fee.amount_details.graduated_ranges

object[]

Graduated ranges, used for a graduated charge model.

fee.amount_details.graduated_percentage_ranges

object[]

Graduated percentage ranges, used for a graduated_percentage charge model.

fee.amount_details.free_units

string

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

fee.amount_details.paid_units

string

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

fee.amount_details.per_package_size

integer

The quantity of units included, defined for Package or Percentage charge model.

fee.amount_details.per_package_unit_amount

string

Total amount to charge for received paid_units, defined for Package or Percentage charge model.

fee.amount_details.units

string

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

fee.amount_details.free_events

integer

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

fee.amount_details.rate

string

Percentage rate applied for the Percentage charge model.

fee.amount_details.per_unit_total_amount

string

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

fee.amount_details.paid_events

integer

Total number of paid events for the Percentage charge model.

fee.amount_details.fixed_fee_unit_amount

string

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

fee.amount_details.fixed_fee_total_amount

string

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

fee.amount_details.min_max_adjustment_total_amount

string

Total adjustment amount linked to minimum and maximum spending per transaction for the Percentage charge model.

fee.amount_details.volume_ranges

object[]

Volume ranges, used for a volume charge model.

fee.self_billed

boolean

Indicates if the fee belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.

fee.applied_taxes

object[]

List of fee applied taxes

Was this page helpful?

Suggest edits Raise issue

The fee object Delete a fee

curl --location --request PUT "$LAGO_URL/api/v1/fees/1a901a90-1a90-1a90-1a90-1a901a901a90" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "fee": {
      "payment_status": "succeeded"
    }
  }'

{
  "fee": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_charge_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,
    "precise_amount": "1.0001",
    "precise_total_amount": "1.0212",
    "amount_currency": "EUR",
    "taxes_amount_cents": 20,
    "taxes_precise_amount": "0.20123",
    "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"
        }
      ]
    },
    "self_billed": false,
    "item": {
      "type": "subscription",
      "code": "startup",
      "name": "Startup",
      "invoice_display_name": "Setup Fee (SF1)",
      "filter_invoice_display_name": "AWS eu-east-1",
      "filters": {},
      "lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "item_type": "Subscription",
      "grouped_by": {}
    },
    "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"
      }
    ]
  }
}

API Reference

Authorizations

Path Parameters

Body

Response