lago-javascript-client 1.1.0 → 1.3.0

package/esm/openapi/client.d.ts

@@ -401,6 +401,7 @@ export interface BillableMetricObject {
     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.
      * @example 4
@@ -459,14 +460,38 @@ export interface BillableMetricBaseInput {
     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 {
     billable_metric: BillableMetricBaseInput;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterInput {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterObject {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
 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. */
+/**
+ * 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.
@@ -494,6 +519,36 @@ export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
     meta: PaginationMeta;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterInput {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name?: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    properties?: ChargeProperties;
+    /**
+     * List of possible filter values. The key and values must match one of the billable metric filters.
+     * @example {"region":["us-east-1"]}
+     */
+    values?: Record<string, string[]>;
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterObject {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    properties: ChargeProperties;
+    /**
+     * List of possible filter values. The key and values must match one of the billable metric filters.
+     * @example {"region":["us-east-1"]}
+     */
+    values: Record<string, string[]>;
+}
 export interface ChargeObject {
     /**
      * Unique identifier of charge, created by Lago.
@@ -551,7 +606,12 @@ export interface ChargeObject {
     min_amount_cents?: number;
     /** List of all thresholds utilized for calculating the charge. */
     properties?: ChargeProperties;
-    /** All charge information, sorted by groups. */
+    /** 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[];
@@ -1351,6 +1411,35 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of filter object, representing multiple dimensions for a charge item. */
+export type CustomerChargeFiltersUsageObject = {
+    /**
+     * The number of units consumed for a specific charge filter related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge filter 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;
+    /**
+     * Specifies the name that will be displayed on an invoice.
+     * @example "AWS eu-east-1"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of filter values applied to the usage.
+     * @example {"region":"us-east-1"}
+     */
+    values?: Record<string, string>;
+}[];
 /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
 export type CustomerChargeGroupedUsageObject = {
     /**
@@ -1371,10 +1460,15 @@ export type CustomerChargeGroupedUsageObject = {
     units?: string;
     /** Key value list of event properties aggregated by the charge model */
     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. */
+/**
+ * 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.
@@ -1471,6 +1565,8 @@ export interface CustomerChargeUsageObject {
          */
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_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. */
@@ -1951,10 +2047,17 @@ export interface FeeObject {
     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
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_charge_filter_id?: string | null;
     /**
      * Unique identifier assigned to the invoice that the fee belongs to
      * @format uuid
@@ -2289,8 +2392,16 @@ export interface FeeObject {
          * @example "Setup Fee (SF1)"
          */
         invoice_display_name?: string;
+        /**
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, the actual charge filter values will be used as the default display name.
+         * @example "AWS eu-east-1"
+         */
+        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;
@@ -2557,7 +2668,7 @@ export interface InvoiceObject {
      * This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.
      * @example 2
      */
-    sequential_id: number;
+    sequential_id?: number;
     /**
      * The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.
      * @example "LAG-1234-001-002"
@@ -2569,6 +2680,12 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     issuing_date: string;
+    /**
+     * The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-09-14T16:35:31Z"
+     */
+    payment_dispute_lost_at?: string;
     /**
      * The payment due date for the invoice, specified in the ISO 8601 date format.
      * @format date
@@ -3091,7 +3208,10 @@ export interface PlanCreateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3101,6 +3221,8 @@ export interface PlanCreateInput {
                 /** 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[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3170,7 +3292,10 @@ export interface PlanOverridesObject {
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
         properties?: ChargeProperties;
-        /** All charge information, sorted by groups. */
+        /**
+         * All charge information, sorted by groups.
+         * @deprecated
+         */
         group_properties?: {
             /**
              * Unique identifier of a billable metric group, created by Lago.
@@ -3180,6 +3305,8 @@ export interface PlanOverridesObject {
             /** 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[];
         /**
          * List of unique code used to identify the taxes.
          * @example ["french_standard_vat"]
@@ -3296,7 +3423,10 @@ export interface PlanUpdateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3306,6 +3436,8 @@ export interface PlanUpdateInput {
                 /** 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[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3387,7 +3519,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},"group_properties":[]},{"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"}]},"group_properties":[]},{"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":{},"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"}}]},{"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"}]},"group_properties":[]},{"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"},"group_properties":[]}]
+     * @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":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
@@ -3570,6 +3702,12 @@ export interface SubscriptionObject {
      * @example "2022-04-30"
      */
     downgrade_plan_date?: string | null;
+    /**
+     * The date when the free trial is ended, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    trial_ended_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -3724,17 +3862,17 @@ export interface WalletCreateInput {
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type: "interval" | "threshold";
+            trigger: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -3834,17 +3972,17 @@ export interface WalletObject {
          */
         lago_id: string;
         /**
-         * The rule type. Possible values are `interval` or `threshold`.
+         * The trigger. Possible values are `interval` or `threshold`.
          * @example "interval"
          */
-        rule_type: "interval" | "threshold";
+        trigger: "interval" | "threshold";
         /**
-         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`.
+         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if trigger is set to `interval`.
          * @example "monthly"
          */
         interval?: "weekly" | "monthly" | "quarterly" | "yearly";
         /**
-         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
@@ -3904,17 +4042,23 @@ export interface WalletTransactionCreateInput {
          */
         wallet_id: string;
         /**
-         * The number of paid credits. Required only if there is no granted credits.
+         * The number of paid credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
         paid_credits?: string;
         /**
-         * The number of free granted credits. Required only if there is no paid credits.
+         * The number of free granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10.0"
          */
         granted_credits?: string;
+        /**
+         * The number of voided credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "5.0"
+         */
+        voided_credits?: string;
     };
 }
 export interface WalletTransactionObject {
@@ -3935,6 +4079,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * 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"
+     */
+    transaction_status: "purchased" | "granted" | "voided" | "invoiced";
     /**
      * The type of transaction. Possible values are `inbound` (increasing the balance) or `outbound` (decreasing the balance).
      * @example "inbound"
@@ -3993,17 +4142,17 @@ export interface WalletUpdateInput {
              */
             lago_id?: string;
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type?: "interval" | "threshold";
+            trigger?: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is set to `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is set to `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -4148,7 +4297,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4238,6 +4387,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @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<GrossRevenues, ApiErrorUnauthorized>>;
         /**
          * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
@@ -4251,6 +4405,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoiceCollections: (query?: {
             /** The currency of revenue analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoiceCollections, ApiErrorUnauthorized>>;
         /**
          * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
@@ -4264,6 +4423,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoicedUsages: (query?: {
             /** The currency of invoiced usage analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used to list MRR.
@@ -4403,6 +4567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code: string, query?: {
@@ -4988,6 +5153,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         finalizeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *
@@ -5371,6 +5546,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             status?: string;
+            /**
+             * 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"
+             */
+            transaction_status?: string;
             /**
              * The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).
              * @example "inbound"

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -444,6 +444,7 @@ export class Api extends HttpClient {
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code, query, params = {}) => this.request({
@@ -1040,6 +1041,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/lose_dispute`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v1.1.0",
+  "version": "v1.3.0",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/openapi/client.d.ts

@@ -401,6 +401,7 @@ export interface BillableMetricObject {
     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.
      * @example 4
@@ -459,14 +460,38 @@ export interface BillableMetricBaseInput {
     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 {
     billable_metric: BillableMetricBaseInput;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterInput {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterObject {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
 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. */
+/**
+ * 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.
@@ -494,6 +519,36 @@ export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
     meta: PaginationMeta;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterInput {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name?: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    properties?: ChargeProperties;
+    /**
+     * List of possible filter values. The key and values must match one of the billable metric filters.
+     * @example {"region":["us-east-1"]}
+     */
+    values?: Record<string, string[]>;
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterObject {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    properties: ChargeProperties;
+    /**
+     * List of possible filter values. The key and values must match one of the billable metric filters.
+     * @example {"region":["us-east-1"]}
+     */
+    values: Record<string, string[]>;
+}
 export interface ChargeObject {
     /**
      * Unique identifier of charge, created by Lago.
@@ -551,7 +606,12 @@ export interface ChargeObject {
     min_amount_cents?: number;
     /** List of all thresholds utilized for calculating the charge. */
     properties?: ChargeProperties;
-    /** All charge information, sorted by groups. */
+    /** 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[];
@@ -1351,6 +1411,35 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of filter object, representing multiple dimensions for a charge item. */
+export type CustomerChargeFiltersUsageObject = {
+    /**
+     * The number of units consumed for a specific charge filter related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge filter 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;
+    /**
+     * Specifies the name that will be displayed on an invoice.
+     * @example "AWS eu-east-1"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of filter values applied to the usage.
+     * @example {"region":"us-east-1"}
+     */
+    values?: Record<string, string>;
+}[];
 /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
 export type CustomerChargeGroupedUsageObject = {
     /**
@@ -1371,10 +1460,15 @@ export type CustomerChargeGroupedUsageObject = {
     units?: string;
     /** Key value list of event properties aggregated by the charge model */
     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. */
+/**
+ * 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.
@@ -1471,6 +1565,8 @@ export interface CustomerChargeUsageObject {
          */
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_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. */
@@ -1951,10 +2047,17 @@ export interface FeeObject {
     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
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_charge_filter_id?: string | null;
     /**
      * Unique identifier assigned to the invoice that the fee belongs to
      * @format uuid
@@ -2289,8 +2392,16 @@ export interface FeeObject {
          * @example "Setup Fee (SF1)"
          */
         invoice_display_name?: string;
+        /**
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, the actual charge filter values will be used as the default display name.
+         * @example "AWS eu-east-1"
+         */
+        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;
@@ -2557,7 +2668,7 @@ export interface InvoiceObject {
      * This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.
      * @example 2
      */
-    sequential_id: number;
+    sequential_id?: number;
     /**
      * The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.
      * @example "LAG-1234-001-002"
@@ -2569,6 +2680,12 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     issuing_date: string;
+    /**
+     * The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-09-14T16:35:31Z"
+     */
+    payment_dispute_lost_at?: string;
     /**
      * The payment due date for the invoice, specified in the ISO 8601 date format.
      * @format date
@@ -3091,7 +3208,10 @@ export interface PlanCreateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3101,6 +3221,8 @@ export interface PlanCreateInput {
                 /** 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[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3170,7 +3292,10 @@ export interface PlanOverridesObject {
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
         properties?: ChargeProperties;
-        /** All charge information, sorted by groups. */
+        /**
+         * All charge information, sorted by groups.
+         * @deprecated
+         */
         group_properties?: {
             /**
              * Unique identifier of a billable metric group, created by Lago.
@@ -3180,6 +3305,8 @@ export interface PlanOverridesObject {
             /** 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[];
         /**
          * List of unique code used to identify the taxes.
          * @example ["french_standard_vat"]
@@ -3296,7 +3423,10 @@ export interface PlanUpdateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3306,6 +3436,8 @@ export interface PlanUpdateInput {
                 /** 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[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3387,7 +3519,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},"group_properties":[]},{"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"}]},"group_properties":[]},{"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":{},"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"}}]},{"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"}]},"group_properties":[]},{"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"},"group_properties":[]}]
+     * @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":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
@@ -3570,6 +3702,12 @@ export interface SubscriptionObject {
      * @example "2022-04-30"
      */
     downgrade_plan_date?: string | null;
+    /**
+     * The date when the free trial is ended, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    trial_ended_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -3724,17 +3862,17 @@ export interface WalletCreateInput {
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type: "interval" | "threshold";
+            trigger: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -3834,17 +3972,17 @@ export interface WalletObject {
          */
         lago_id: string;
         /**
-         * The rule type. Possible values are `interval` or `threshold`.
+         * The trigger. Possible values are `interval` or `threshold`.
          * @example "interval"
          */
-        rule_type: "interval" | "threshold";
+        trigger: "interval" | "threshold";
         /**
-         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`.
+         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if trigger is set to `interval`.
          * @example "monthly"
          */
         interval?: "weekly" | "monthly" | "quarterly" | "yearly";
         /**
-         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
@@ -3904,17 +4042,23 @@ export interface WalletTransactionCreateInput {
          */
         wallet_id: string;
         /**
-         * The number of paid credits. Required only if there is no granted credits.
+         * The number of paid credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
         paid_credits?: string;
         /**
-         * The number of free granted credits. Required only if there is no paid credits.
+         * The number of free granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10.0"
          */
         granted_credits?: string;
+        /**
+         * The number of voided credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "5.0"
+         */
+        voided_credits?: string;
     };
 }
 export interface WalletTransactionObject {
@@ -3935,6 +4079,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * 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"
+     */
+    transaction_status: "purchased" | "granted" | "voided" | "invoiced";
     /**
      * The type of transaction. Possible values are `inbound` (increasing the balance) or `outbound` (decreasing the balance).
      * @example "inbound"
@@ -3993,17 +4142,17 @@ export interface WalletUpdateInput {
              */
             lago_id?: string;
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type?: "interval" | "threshold";
+            trigger?: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is set to `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is set to `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -4148,7 +4297,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4238,6 +4387,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @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<GrossRevenues, ApiErrorUnauthorized>>;
         /**
          * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
@@ -4251,6 +4405,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoiceCollections: (query?: {
             /** The currency of revenue analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoiceCollections, ApiErrorUnauthorized>>;
         /**
          * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
@@ -4264,6 +4423,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoicedUsages: (query?: {
             /** The currency of invoiced usage analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used to list MRR.
@@ -4403,6 +4567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code: string, query?: {
@@ -4988,6 +5153,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         finalizeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *
@@ -5371,6 +5546,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             status?: string;
+            /**
+             * 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"
+             */
+            transaction_status?: string;
             /**
              * The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).
              * @example "inbound"

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -448,6 +448,7 @@ class Api extends HttpClient {
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code, query, params = {}) => this.request({
@@ -1044,6 +1045,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/lose_dispute`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *