lago-javascript-client 1.7.0 → 1.9.0

package/esm/openapi/client.d.ts

@@ -559,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.
      *
@@ -1927,7 +1936,26 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    events: {
+    events: any[];
+}
+export interface EventEstimateFeesInput {
+    event: {
+        /**
+         * 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"
+         */
+        code: string;
+        /**
+         * The unique identifier of the subscription within your application.
+         * @example "sub_1234567890"
+         */
+        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;
+    };
+}
+export interface EventInput {
+    event: {
         /**
          * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
          * @example "transaction_1234567890"
@@ -1955,27 +1983,8 @@ export interface EventBatchInput {
          * @example {"gb":10}
          */
         properties?: Record<string, string | number>;
-    }[];
-}
-export interface EventEstimateFeesInput {
-    event: {
-        /**
-         * 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"
-         */
-        code: string;
-        /**
-         * The unique identifier of the subscription within your application.
-         * @example "sub_1234567890"
-         */
-        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;
     };
 }
-export interface EventInput {
-    event: any;
-}
 export interface EventObject {
     /**
      * Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system
@@ -3150,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},"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
+         * @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?: {
             /**
@@ -3174,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"
@@ -3333,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},"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
+         * @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?: {
             /**
@@ -3363,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"
@@ -3467,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. */
@@ -3807,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?: {
             /**
@@ -3854,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;
+            }[];
         }[];
     };
 }
@@ -3940,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?: {
         /**
@@ -3999,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.
@@ -4053,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 {
@@ -4073,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"
@@ -4095,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
@@ -4127,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?: {
             /**
@@ -4180,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;
+            }[];
         }[];
     };
 }
@@ -4308,7 +4440,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.9.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.9.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago

package/package.json

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

package/script/openapi/client.d.ts

@@ -559,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.
      *
@@ -1927,7 +1936,26 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    events: {
+    events: any[];
+}
+export interface EventEstimateFeesInput {
+    event: {
+        /**
+         * 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"
+         */
+        code: string;
+        /**
+         * The unique identifier of the subscription within your application.
+         * @example "sub_1234567890"
+         */
+        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;
+    };
+}
+export interface EventInput {
+    event: {
         /**
          * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
          * @example "transaction_1234567890"
@@ -1955,27 +1983,8 @@ export interface EventBatchInput {
          * @example {"gb":10}
          */
         properties?: Record<string, string | number>;
-    }[];
-}
-export interface EventEstimateFeesInput {
-    event: {
-        /**
-         * 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"
-         */
-        code: string;
-        /**
-         * The unique identifier of the subscription within your application.
-         * @example "sub_1234567890"
-         */
-        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;
     };
 }
-export interface EventInput {
-    event: any;
-}
 export interface EventObject {
     /**
      * Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system
@@ -3150,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},"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
+         * @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?: {
             /**
@@ -3174,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"
@@ -3333,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},"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
+         * @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?: {
             /**
@@ -3363,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"
@@ -3467,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. */
@@ -3807,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?: {
             /**
@@ -3854,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;
+            }[];
         }[];
     };
 }
@@ -3940,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?: {
         /**
@@ -3999,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.
@@ -4053,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 {
@@ -4073,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"
@@ -4095,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
@@ -4127,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?: {
             /**
@@ -4180,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;
+            }[];
         }[];
     };
 }
@@ -4308,7 +4440,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.9.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.9.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago