GEgetlago
fees

List all fees

Changed on

This endpoint is used for retrieving all fees that have been issued.

get/fees

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

external_customer_idstring
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

Unique identifier assigned to the customer in your application.

external_subscription_idstring
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

External subscription ID

event_transaction_idstring
Example:et_12345678

Filter results by event transaction ID

currency'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' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'
Example:USD

Filter results by the fee's currency.

fee_type'charge' | 'fixed_charge' | 'add_on' | 'subscription' | 'credit' | 'commitment'
Example:charge

The fee type. Possible values are add_on, charge, fixed_charge, credit, subscription or commitment.

billable_metric_codestring
Example:bm_code

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

payment_status'pending' | 'succeeded' | 'failed' | 'refunded'
Example:succeeded

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_fromstring date-time
Example:2023-03-28T12:21:51Z

Filter results created at or after this date and time in UTC.

created_at_tostring date-time
Example:2023-03-28T12:21:51Z

Filter results created at or before this date and time in UTC.

succeeded_at_fromstring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment success at or after this date and time in UTC.

succeeded_at_tostring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment success at or before this date and time in UTC.

failed_at_fromstring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment failure at or after this date and time in UTC.

failed_at_tostring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment failure at or before this date and time in UTC.

refunded_at_fromstring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment refund at or after this date and time in UTC.

refunded_at_tostring date-time
Example:2023-03-28T12:21:51Z

Filter results with a payment refund at or before this date and time in UTC.

Response

Successful response

Example response

{
  "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_fixed_charge_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_original_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": "USD",
      "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": "USD",
      "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",
      "sub_total_excluding_taxes_amount_cents": 100,
      "sub_total_excluding_taxes_precise_amount_cents": "100.0",
      "amount_details": {
        "plan_amount_cents": 10000,
        "graduated_ranges": [
          {
            "units": "10.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",
            "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"
      },
      "item": {
        "type": "subscription",
        "code": "startup",
        "name": "Startup",
        "description": "Startup",
        "invoice_display_name": "Setup Fee (SF1)",
        "filter_invoice_display_name": "AWS eu-east-1",
        "lago_item_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "item_type": "Subscription"
      },
      "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"
        }
      ],
      "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"
      },
      "presentation_breakdowns": [
        {
          "units": "9.0"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the response property // became nullable for the status

    • warning

      added the new SYP enum value to the // response property for the response status

    • warning

      added the new SYP enum value to the //////// response property for the response status

    • warning

      added the new SYP enum value to the // response property for the response status

    • warning

      added the new TND enum value to the // response property for the response status

    • warning

      added the new TND enum value to the //////// response property for the response status

    • warning

      added the new TND enum value to the // response property for the response status

    • info

      added the new enum value fixed_charge to the query request parameter fee_type

    • info

      added the enum value SYP to the property allOf[Currency]/ of the query request parameter currency

    • info

      added the enum value TND to the property allOf[Currency]/ of the query request parameter currency

    • info

      added the optional property // to the response with the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status