lago-javascript-client 1.6.0 → 1.9.0

package/esm/openapi/client.d.ts

@@ -399,8 +399,6 @@ export interface BillableMetricObject {
      * @example "seconds"
      */
     weighted_interval?: "seconds" | null;
-    /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
-    group?: BillableMetricGroup;
     filters?: BillableMetricFilterObject[];
     /**
      * Number of active subscriptions using this billable metric.
@@ -458,8 +456,6 @@ export interface BillableMetricBaseInput {
      * @example "seconds"
      */
     weighted_interval?: "seconds" | null;
-    /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
-    group?: BillableMetricGroup;
     filters?: BillableMetricFilterInput[];
 }
 export interface BillableMetricCreateInput {
@@ -488,33 +484,6 @@ export interface BillableMetricFilterObject {
 export interface BillableMetricUpdateInput {
     billable_metric: BillableMetricBaseInput;
 }
-/**
- * Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric.
- * @deprecated
- */
-export interface BillableMetricGroup {
-    /**
-     * Name of the event property used to group values.
-     * @example "region"
-     */
-    key: string;
-    /**
-     * Array of strings or objects representing all possible values.
-     * @example ["us-east-1","us-east-2","eu-west-1"]
-     */
-    values: (string | {
-        /**
-         * Name of the event property used to group values.
-         * @example "region"
-         */
-        key: string;
-        /**
-         * Array of strings representing all possible values.
-         * @example ["us-east-1","us-east-2","eu-west-1"]
-         */
-        values: string[];
-    })[];
-}
 export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
     meta: PaginationMeta;
@@ -590,6 +559,15 @@ export interface ChargeObject {
      * @example true
      */
     invoiceable?: boolean;
+    /**
+     * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+     * This field determines whether and when the charge fee should be included in
+     * the invoice. If `null`, no invoice will be issued for this charge fee.
+     * If `invoice`, an invoice will be generated at the end of the period,
+     * consolidating all charge fees with a succeeded payment status.
+     * @example "invoice"
+     */
+    regroup_paid_fees?: "invoice" | null;
     /**
      * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
      *
@@ -608,11 +586,6 @@ export interface ChargeObject {
     properties?: ChargeProperties;
     /** List of filters used to apply differentiated pricing based on additional event properties. */
     filters?: ChargeFilterObject[];
-    /**
-     * All charge information, sorted by groups.
-     * @deprecated
-     */
-    group_properties?: GroupPropertiesObject[];
     /** All taxes applied to the charge. */
     taxes?: TaxObject[];
 }
@@ -1368,6 +1341,36 @@ export interface Customer {
     customer: CustomerObjectExtended;
 }
 /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
+export interface Address {
+    /**
+     * The first line of the billing address
+     * @example "5230 Penfield Ave"
+     */
+    address_line1?: string | null;
+    /**
+     * The second line of the billing address
+     * @example null
+     */
+    address_line2?: string | null;
+    /**
+     * The city of the customer's billing address
+     * @example "Woodland Hills"
+     */
+    city?: string | null;
+    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
+    country?: Country;
+    /**
+     * The state of the customer's billing address
+     * @example "CA"
+     */
+    state?: string | null;
+    /**
+     * The zipcode of the customer's billing address
+     * @example "91364"
+     */
+    zipcode?: string | null;
+}
+/** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
 export interface CustomerBillingConfiguration {
     /**
      * The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items
@@ -1406,7 +1409,7 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, all the payment methods are selected. For now, possible values are `card` and `sepa_debit`.
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `[card]`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
      * @example ["card","sepa_debit"]
      */
     provider_payment_methods?: string[] | null;
@@ -1497,46 +1500,6 @@ export type CustomerChargeGroupedUsageObject = {
     grouped_by?: Record<string, string>;
     /** Array of filter object, representing multiple dimensions for a charge item. */
     filters?: CustomerChargeFiltersUsageObject;
-    /** Array of group object, representing multiple dimensions for a charge item. */
-    groups?: CustomerChargeGroupsUsageObject;
-}[];
-/**
- * Array of group object, representing multiple dimensions for a charge item.
- * @deprecated
- */
-export type CustomerChargeGroupsUsageObject = {
-    /**
-     * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_id?: string;
-    /**
-     * The group key, only returned for groups with two dimensions.
-     * @example null
-     */
-    key?: string | null;
-    /**
-     * The group value.
-     * @example "europe"
-     */
-    value?: string;
-    /**
-     * The number of units consumed for a specific group related to a charge item.
-     * @pattern ^[0-9]+.?[0-9]*$
-     * @example "0.9"
-     */
-    units?: string;
-    /**
-     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
-     * @example 10
-     */
-    events_count?: number;
-    /**
-     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
-     * @example 1000
-     */
-    amount_cents?: number;
 }[];
 export interface CustomerChargeUsageObject {
     /**
@@ -1598,12 +1561,10 @@ export interface CustomerChargeUsageObject {
          * The aggregation type of the billable metric used for this charge. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
          * @example "sum_agg"
          */
-        aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
+        aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg" | "latest_agg";
     };
     /** Array of filter object, representing multiple dimensions for a charge item. */
     filters?: CustomerChargeFiltersUsageObject;
-    /** Array of group object, representing multiple dimensions for a charge item. */
-    groups: CustomerChargeGroupsUsageObject;
     /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
     grouped_usage?: CustomerChargeGroupedUsageObject;
 }
@@ -1698,6 +1659,8 @@ export interface CustomerCreateInput {
         net_payment_term?: number | null;
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
         billing_configuration?: CustomerBillingConfiguration;
+        /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
+        shipping_address?: Address;
         integration_customers?: {
             /**
              * A unique identifier for the integration customer object in the Lago application.
@@ -1903,6 +1866,8 @@ export interface CustomerObject {
     updated_at?: string;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
+    /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
+    shipping_address?: Address;
     integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
 }
@@ -1971,7 +1936,7 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    events: EventInput[];
+    events: any[];
 }
 export interface EventEstimateFeesInput {
     event: {
@@ -1981,17 +1946,10 @@ export interface EventEstimateFeesInput {
          */
         code: string;
         /**
-         * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
-         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
-         * @deprecated
-         * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-         */
-        external_customer_id?: string;
-        /**
-         * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
+         * The unique identifier of the subscription within your application.
          * @example "sub_1234567890"
          */
-        external_subscription_id?: string;
+        external_subscription_id: string;
         /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
         properties?: object;
     };
@@ -2003,13 +1961,6 @@ export interface EventInput {
          * @example "transaction_1234567890"
          */
         transaction_id: string;
-        /**
-         * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
-         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
-         * @deprecated
-         * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-         */
-        external_customer_id?: string;
         /**
          * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
          * @example "sub_1234567890"
@@ -2052,13 +2003,6 @@ export interface EventObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_customer_id: string | null;
-    /**
-     * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
-     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
-     * @deprecated
-     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-     */
-    external_customer_id: string | null;
     /**
      * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
      * @example "storage"
@@ -2089,7 +2033,7 @@ export interface EventObject {
      * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
      * @example "sub_1234567890"
      */
-    external_subscription_id: string | null;
+    external_subscription_id: string;
     /**
      * The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
      * @format date-time
@@ -2115,13 +2059,6 @@ export interface FeeObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id?: string | null;
-    /**
-     * Unique identifier assigned to the group that the fee belongs to
-     * @deprecated
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_group_id?: string | null;
     /**
      * Unique identifier assigned to the charge filter that the fee belongs to
      * @format uuid
@@ -2469,12 +2406,6 @@ export interface FeeObject {
         filter_invoice_display_name?: string;
         /** Key value list of event properties */
         filters?: Record<string, 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.
-         * @deprecated
-         * @example "Transactions - ACH"
-         */
-        group_invoice_display_name?: string;
         /**
          * 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`.
          * @format uuid
@@ -2517,49 +2448,17 @@ export interface GrossRevenueObject {
      * The total amount of revenue for a period, expressed in cents.
      * @example 50000
      */
-    amount_cents?: number;
+    amount_cents: number;
     /** The currency of revenue analytics. Format must be ISO 4217. */
-    currency?: Currency;
-}
-export interface GrossRevenues {
-    gross_revenues: GrossRevenueObject[];
-}
-export interface GroupObject {
-    /**
-     * Unique identifier of a specific group associated with the billable metric.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_id: string;
-    /**
-     * Key of a specific group associated with the billable metric.
-     * @example "region"
-     */
-    key: string;
-    /**
-     * One of the values for a specific group associated with the billable metric.
-     * @example "us-east-1"
-     */
-    value: string;
-}
-export interface GroupPropertiesObject {
-    /**
-     * Unique identifier of a billable metric group, created by Lago.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    group_id: string;
+    currency: Currency;
     /**
-     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual group will be used as the default display name.
-     * @example "AWS"
+     * Contains invoices count.
+     * @example 10
      */
-    invoice_display_name?: string;
-    /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
-    values: ChargeProperties;
+    invoices_count: number;
 }
-export interface GroupsPaginated {
-    groups: GroupObject[];
-    meta: PaginationMeta;
+export interface GrossRevenues {
+    gross_revenues: GrossRevenueObject[];
 }
 /** Minimum commitment for this plan. */
 export type MinimumCommitmentInput = {
@@ -2674,7 +2573,7 @@ export interface InvoiceCollectionObject {
      * The total amount of revenue for a period, expressed in cents.
      * @example 50000
      */
-    amount_cents: number;
+    amount_cents?: number;
     /** The currency of revenue analytics. Format must be ISO 4217. */
     currency?: Currency;
 }
@@ -3150,6 +3049,28 @@ export interface OrganizationUpdateInput {
         billing_configuration?: OrganizationBillingConfiguration;
     };
 }
+export interface OverdueBalanceObject {
+    /**
+     * Identifies the month to analyze revenue.
+     * @example "2023-11-01T00:00:00.000Z"
+     */
+    month: string;
+    /**
+     * The total amount of revenue for a period, expressed in cents.
+     * @example 50000
+     */
+    amount_cents: number;
+    /** The currency of revenue analytics. Format must be ISO 4217. */
+    currency: Currency;
+    /**
+     * The Lago invoice IDs associated with the revenue.
+     * @example ["5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"]
+     */
+    lago_invoice_ids: string[];
+}
+export interface OverdueBalances {
+    overdue_balances: OverdueBalanceObject[];
+}
 export interface PaginationMeta {
     /**
      * Current page.
@@ -3238,7 +3159,7 @@ export interface PlanCreateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3262,6 +3183,15 @@ export interface PlanCreateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | null;
             /**
              * 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.
              * @example "Setup"
@@ -3283,19 +3213,6 @@ export interface PlanCreateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /**
-             * All charge information, sorted by groups.
-             * @deprecated
-             */
-            group_properties?: {
-                /**
-                 * Unique identifier of a billable metric group, created by Lago.
-                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-                 */
-                group_id: string;
-                /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
-                values: ChargeProperties;
-            }[];
             /** List of filters used to apply differentiated pricing based on additional event properties. */
             filters?: ChargeFilterInput[];
             /**
@@ -3367,19 +3284,6 @@ export interface PlanOverridesObject {
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
         properties?: ChargeProperties;
-        /**
-         * All charge information, sorted by groups.
-         * @deprecated
-         */
-        group_properties?: {
-            /**
-             * Unique identifier of a billable metric group, created by Lago.
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            group_id: string;
-            /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
-            values: ChargeProperties;
-        }[];
         /** List of filters used to apply differentiated pricing based on additional event properties. */
         filters?: ChargeFilterInput[];
         /**
@@ -3447,7 +3351,7 @@ export interface PlanUpdateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3477,6 +3381,15 @@ export interface PlanUpdateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | null;
             /**
              * 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.
              * @example "Setup"
@@ -3498,19 +3411,6 @@ export interface PlanUpdateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /**
-             * All charge information, sorted by groups.
-             * @deprecated
-             */
-            group_properties?: {
-                /**
-                 * Unique identifier of a billable metric group, created by Lago.
-                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-                 */
-                group_id: string;
-                /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
-                values: ChargeProperties;
-            }[];
             /** List of filters used to apply differentiated pricing based on additional event properties. */
             filters?: ChargeFilterInput[];
             /**
@@ -3594,7 +3494,7 @@ export interface PlanObject {
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
-     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
+     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
@@ -3934,6 +3834,21 @@ export interface WalletCreateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The corresponding value for the key. */
+            value?: string;
+        }[];
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -3981,6 +3896,21 @@ export interface WalletCreateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -4067,6 +3997,11 @@ export interface WalletObject {
      * @example "2022-09-14T16:35:31Z"
      */
     terminated_at?: string | null;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
     /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
     recurring_transaction_rules?: {
         /**
@@ -4126,6 +4061,21 @@ export interface WalletObject {
          * @example "2022-04-29T08:59:51Z"
          */
         created_at: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     }[];
     /**
      * The wallet ongoing balance expressed in cents.
@@ -4180,6 +4130,21 @@ export interface WalletTransactionCreateInput {
          * @example "5.0"
          */
         voided_credits?: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+         * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+         */
+        metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     };
 }
 export interface WalletTransactionObject {
@@ -4200,6 +4165,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`. `threshold`
+     * @example "manual"
+     */
+    source?: "manual" | "interval" | "threshold";
     /**
      * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
      * @example "purchased"
@@ -4222,6 +4192,21 @@ export interface WalletTransactionObject {
      * @example "100.0"
      */
     credit_amount: string;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
+    /**
+     * This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+     * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+     */
+    metadata?: {
+        /** The unique identifier for the attribute. */
+        key?: string;
+        /** The value associated with the key. */
+        value?: string;
+    }[];
     /**
      * The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -4254,6 +4239,11 @@ export interface WalletUpdateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -4307,6 +4297,21 @@ export interface WalletUpdateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -4435,7 +4440,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.6.0
+ * @version 1.9.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4592,6 +4597,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<Mrrs, ApiErrorUnauthorized>>;
+        /**
+         * @description Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).
+         *
+         * @tags analytics
+         * @name FindAllOverdueBalances
+         * @summary List overdue balance
+         * @request GET:/analytics/overdue_balance
+         * @secure
+         */
+        findAllOverdueBalances: (query?: {
+            /** Currency of revenue analytics. Format must be ISO 4217. */
+            currency?: Currency;
+            /**
+             * The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
+        }, params?: RequestParams) => Promise<HttpResponse<OverdueBalances, ApiErrorUnauthorized>>;
     };
     appliedCoupons: {
         /**
@@ -4698,28 +4726,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         findBillableMetric: (code: string, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiErrorUnauthorized | ApiErrorNotFound>>;
-        /**
-         * @description This endpoint retrieves all groups for a billable metric.
-         *
-         * @tags billable_metrics
-         * @name FindAllBillableMetricGroups
-         * @summary Find a billable metric's groups
-         * @request GET:/billable_metrics/{code}/groups
-         * @deprecated
-         * @secure
-         */
-        findAllBillableMetricGroups: (code: string, query?: {
-            /**
-             * Page number.
-             * @example 1
-             */
-            page?: number;
-            /**
-             * Number of records per page.
-             * @example 20
-             */
-            per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<GroupsPaginated, ApiErrorUnauthorized>>;
     };
     coupons: {
         /**
@@ -5196,7 +5202,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/fees/{lago_id}
          * @secure
          */
-        updateFee: (lagoId: string, data: FeeUpdateInput, params?: RequestParams) => Promise<HttpResponse<Fee, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        updateFee: (lagoId: string, data: FeeUpdateInput, params?: RequestParams) => Promise<HttpResponse<Fee, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotAllowed | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for deleting a specific fee that has not yet been invoiced
+         *
+         * @tags fees
+         * @name DeleteFee
+         * @summary Delete a fee
+         * @request DELETE:/fees/{lago_id}
+         * @secure
+         */
+        deleteFee: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Fee, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
     };
     invoices: {
         /**
@@ -5255,6 +5271,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example true
              */
             payment_overdue?: boolean;
+            /**
+             * Search invoices by id, number, customer name, customer external_id or customer email.
+             * @example "Jane"
+             */
+            search_term?: string;
+            /**
+             * Filter invoices by currency in. Possible values ISO 4217 currency codes.
+             * @example "EUR"
+             */
+            currency?: string;
+            /**
+             * Filter invoices with a payment dispute lost. Possible values are `true` or `false`.
+             * @example true
+             */
+            payment_dispute_lost?: boolean;
+            /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off` or `advance_charges` */
+            invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges";
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used for updating an existing invoice.