Skip to main content
GET
/
fees
curl --location --request GET "$LAGO_URL/api/v1/fees?page=2&per_page=20&external_customer_id=hooli_1234" \
  --header "Authorization: Bearer $API_KEY"

{
  "fees": [
    {
      "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",
      "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_aggregated_units": "0.32",
      "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",
      "description": "Fee description",
      "precise_coupons_amount_cents": "0.0",
      "amount_details": {
        "plan_amount_cents": 10000,
        "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",
        "per_unit_total_amount": "10.0",
        "units": "20.0",
        "free_events": 10,
        "rate": "1.0",
        "paid_events": 20,
        "fixed_fee_unit_amount": "1.0",
        "fixed_fee_total_amount": "20.0",
        "min_max_adjustment_total_amount": "20.0",
        "per_unit_amount": "0.5",
        "flat_unit_amount": "10.0"
      },
      "self_billed": false,
      "item": {
        "type": "subscription",
        "code": "startup",
        "name": "Startup",
        "description": "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"
        }
      ],
      "pricing_unit_details": {
        "lago_pricing_unit_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "pricing_unit_code": "credits",
        "short_name": "CR",
        "amount_cents": 200,
        "precise_amount_cents": "200.0",
        "unit_amount_cents": 100,
        "precise_unit_amount": "100.0",
        "conversion_rate": "0.5"
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}
curl --location --request GET "$LAGO_URL/api/v1/fees?page=2&per_page=20&external_customer_id=hooli_1234" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer

Page number.

Example:

1

​
per_page
integer

Number of records per page.

Example:

20

​
external_customer_id
string

Unique identifier assigned to the customer in your application.

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
external_subscription_id
string

External subscription ID

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
event_transaction_id
string

Filter results by event transaction ID

Example:

"et_12345678"

​
currency
enum<string>

Filter results by fee"s currency.

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,
GHS,
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
Example:

"USD"

​
fee_type
enum<string>

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

Available options:
charge,
add_on,
subscription,
credit,
commitment
Example:

"charge"

​
billable_metric_code
string

Filter results by the code of the billable metric attached to the fee. Only applies to charge types.

Example:

"bm_code"

​
payment_status
enum<string>

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
Example:

"succeeded"

​
created_at_from
string<date-time>

Filter results created after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
created_at_to
string<date-time>

Filter results created before creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
succeeded_at_from
string<date-time>

Filter results with payment success after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
succeeded_at_to
string<date-time>

Filter results with payment success after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
failed_at_from
string<date-time>

Filter results with payment failure after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
failed_at_to
string<date-time>

Filter results with payment failure after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
refunded_at_from
string<date-time>

Filter results with payment refund after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

​
refunded_at_to
string<date-time>

Filter results with payment refund after creation date and time in UTC.

Example:

"2023-03-28T12:21:51Z"

Response

Successful response

​
fees
object[]
required
​
meta
object
required