lago-javascript-client 1.3.0 → 1.6.0

package/esm/openapi/client.d.ts

@@ -973,7 +973,7 @@ export interface CreditNoteEstimateInput {
          */
         invoice_id: string;
         /**
-         * The list of credit note’s items.
+         * The list of credit note's items.
          * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
          */
         items: {
@@ -1036,15 +1036,15 @@ export interface CreditNoteEstimated {
          * @example 20
          */
         coupons_adjustment_amount_cents: number;
-        /** Array of credit note’s items. */
+        /** Array of credit note's items. */
         items: {
             /**
-             * The credit note’s item amount, expressed in cents.
+             * The credit note's item amount, expressed in cents.
              * @example 100
              */
             amount_cents: number;
             /**
-             * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+             * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
              * @format uuid
              * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
              */
@@ -1091,7 +1091,7 @@ export interface CreditNoteEstimated {
 }
 export interface CreditObject {
     /**
-     * Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit’s item record within the Lago system.
+     * Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit's item record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -1157,17 +1157,17 @@ export type CreditNoteAppliedTaxObject = BaseAppliedTax & {
 };
 export interface CreditNoteItemObject {
     /**
-     * The credit note’s item unique identifier, created by Lago.
+     * The credit note's item unique identifier, created by Lago.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * The credit note’s item amount, expressed in cents.
+     * The credit note's item amount, expressed in cents.
      * @example 100
      */
     amount_cents: number;
-    /** The credit note’s item currency. */
+    /** The credit note's item currency. */
     amount_currency: Currency;
     /** The fee object related to the credit note item. */
     fee: FeeObject;
@@ -1294,7 +1294,7 @@ export interface CreditNoteObject {
      * @example "https://getlago.com/credit_note/file"
      */
     file_url?: string | null;
-    /** Array of credit note’s items. */
+    /** Array of credit note's items. */
     items?: CreditNoteItemObject[];
     applied_taxes?: CreditNoteAppliedTaxObject[];
 }
@@ -1331,7 +1331,7 @@ export interface CreditNoteCreateInput {
          */
         refund_amount_cents?: number | null;
         /**
-         * The list of credit note’s items.
+         * The list of credit note's items.
          * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
          */
         items: {
@@ -1411,6 +1411,41 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. */
+export interface IntegrationCustomer {
+    /**
+     * A unique identifier for the integration customer object in the Lago application.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id?: string;
+    /**
+     * The integration type used for accounting and tax syncs.
+     * Accepted values: `netsuite`.
+     * @example "netsuite"
+     */
+    type?: "netsuite";
+    /**
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
+     */
+    integration_code?: string;
+    /**
+     * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
+     * @example "cus_12345"
+     */
+    external_customer_id?: string;
+    /**
+     * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
+     * @example true
+     */
+    sync_with_provider?: boolean;
+    /**
+     * This optional field is needed only when working with `netsuite` connection.
+     * @example "2"
+     */
+    subsidiary_id?: string;
+}
 /** Array of filter object, representing multiple dimensions for a charge item. */
 export type CustomerChargeFiltersUsageObject = {
     /**
@@ -1525,7 +1560,7 @@ export interface CustomerChargeUsageObject {
     /** Object listing all the properties for a specific charge item. */
     charge: {
         /**
-         * Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge’s record within the Lago system.
+         * Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -1544,7 +1579,7 @@ export interface CustomerChargeUsageObject {
     /** The related billable metric object. */
     billable_metric: {
         /**
-         * Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric’s record within the Lago system.
+         * Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -1663,6 +1698,40 @@ export interface CustomerCreateInput {
         net_payment_term?: number | null;
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
         billing_configuration?: CustomerBillingConfiguration;
+        integration_customers?: {
+            /**
+             * A unique identifier for the integration customer object in the Lago application.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            id?: string;
+            /**
+             * The integration type used for accounting and tax syncs.
+             * Accepted values: `netsuite`.
+             * @example "netsuite"
+             */
+            integration_type?: "netsuite";
+            /**
+             * Unique code used to identify an integration connection.
+             * @example "netsuite-eu-1"
+             */
+            integration_code?: string;
+            /**
+             * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
+             * @example "cus_12345"
+             */
+            external_customer_id?: string;
+            /**
+             * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
+             * @example true
+             */
+            sync_with_provider?: boolean;
+            /**
+             * This optional field is needed only when working with `netsuite` connection.
+             * @example "2"
+             */
+            subsidiary_id?: string;
+        }[];
         /** Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
         metadata?: {
             /**
@@ -1834,6 +1903,7 @@ export interface CustomerObject {
     updated_at?: string;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
+    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
 }
 export type CustomerObjectExtended = CustomerObject & {
@@ -1867,8 +1937,8 @@ export interface CustomerUsageObject {
     to_datetime: string;
     /**
      * The date of creation of the invoice.
-     * @format date-time
-     * @example "2022-08-01T23:59:59Z"
+     * @format date
+     * @example "2022-08-01"
      */
     issuing_date: string;
     /**
@@ -1877,7 +1947,7 @@ export interface CustomerUsageObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_invoice_id?: string | null;
-    /** The currency of the customer’s current usage. */
+    /** The currency of the customer's current usage. */
     currency?: Currency;
     /**
      * The amount in cents, tax excluded.
@@ -1961,7 +2031,7 @@ export interface EventInput {
          * 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.
          * @example {"gb":10}
          */
-        properties?: Record<string, string>;
+        properties?: Record<string, string | number>;
     };
 }
 export interface EventObject {
@@ -2010,7 +2080,7 @@ export interface EventObject {
         [key: string]: any;
     };
     /**
-     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system
+     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2040,7 +2110,7 @@ export type FeeAppliedTaxObject = BaseAppliedTax & {
 };
 export interface FeeObject {
     /**
-     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2108,7 +2178,7 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
-    /** The currency of this specific fee. It indicates the monetary unit in which the fee’s cost is expressed. */
+    /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
      * The cost of the tax associated with this specific fee.
@@ -2641,12 +2711,12 @@ export interface InvoiceMetadataObject {
      */
     lago_id?: string;
     /**
-     * Represents the key of the metadata’s key-value pair.
+     * Represents the key of the metadata's key-value pair.
      * @example "digital_ref_id"
      */
     key?: string;
     /**
-     * Represents the value of the metadata’s key-value pair.
+     * Represents the value of the metadata's key-value pair.
      * @example "INV-0123456-98765"
      */
     value?: string;
@@ -2659,7 +2729,7 @@ export interface InvoiceMetadataObject {
 }
 export interface InvoiceObject {
     /**
-     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2692,6 +2762,11 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     payment_due_date?: string;
+    /**
+     * Specifies if the payment is considered as overdue.
+     * @example true
+     */
+    payment_overdue?: boolean;
     /**
      * The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
      * @example 30
@@ -2872,7 +2947,7 @@ export interface OrganizationBillingConfiguration {
      */
     invoice_footer?: string | null;
     /**
-     * The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer’s grace period.
+     * The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.
      * @example 3
      */
     invoice_grace_period?: number;
@@ -2915,22 +2990,22 @@ export interface OrganizationObject {
     /** The default currency of an organization. */
     default_currency?: Currency;
     /**
-     * The first line of your organization’s billing address.
+     * The first line of your organization's billing address.
      * @example "100 Brex Street"
      */
     address_line1?: string | null;
     /**
-     * The second line of your organization’s billing address.
+     * The second line of your organization's billing address.
      * @example null
      */
     address_line2?: string | null;
     /**
-     * The state of your organization’s billing address.
+     * The state of your organization's billing address.
      * @example "NYC"
      */
     state?: string | null;
     /**
-     * The zipcode of your organization’s billing address.
+     * The zipcode of your organization's billing address.
      * @example "10000"
      */
     zipcode?: string | null;
@@ -2941,7 +3016,7 @@ export interface OrganizationObject {
      */
     email?: string | null;
     /**
-     * The city of your organization’s billing address.
+     * The city of your organization's billing address.
      * @example "New York"
      */
     city?: string | null;
@@ -2980,7 +3055,7 @@ export interface OrganizationObject {
      * @example "US123456789"
      */
     tax_identification_number?: string | null;
-    /** Your organization’s timezone, used for billing purposes in your own local time. Can be overwritten by the customer’s timezone. */
+    /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
     timezone?: Timezone;
     /** The custom billing settings for your organization. */
     billing_configuration: OrganizationBillingConfiguration;
@@ -2999,22 +3074,22 @@ export interface OrganizationUpdateInput {
         /** The default currency of an organization. */
         default_currency?: Currency;
         /**
-         * The first line of your organization’s billing address.
+         * The first line of your organization's billing address.
          * @example "100 Brex Street"
          */
         address_line1?: string | null;
         /**
-         * The second line of your organization’s billing address.
+         * The second line of your organization's billing address.
          * @example null
          */
         address_line2?: string | null;
         /**
-         * The state of your organization’s billing address.
+         * The state of your organization's billing address.
          * @example "NYC"
          */
         state?: string | null;
         /**
-         * The zipcode of your organization’s billing address.
+         * The zipcode of your organization's billing address.
          * @example "10000"
          */
         zipcode?: string | null;
@@ -3025,7 +3100,7 @@ export interface OrganizationUpdateInput {
          */
         email?: string | null;
         /**
-         * The city of your organization’s billing address.
+         * The city of your organization's billing address.
          * @example "New York"
          */
         city?: string | null;
@@ -3064,7 +3139,7 @@ export interface OrganizationUpdateInput {
          * @example "US123456789"
          */
         tax_identification_number?: string | null;
-        /** Your organization’s timezone, used for billing purposes in your own local time. Can be overwritten by the customer’s timezone. */
+        /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
         timezone?: Timezone;
         /**
          * Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
@@ -3150,7 +3225,7 @@ export interface PlanCreateInput {
          */
         pay_in_advance?: boolean;
         /**
-         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
          * @example null
          */
         bill_charges_monthly?: boolean | null;
@@ -3359,7 +3434,7 @@ export interface PlanUpdateInput {
          */
         pay_in_advance?: boolean;
         /**
-         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
          * @example null
          */
         bill_charges_monthly?: boolean | null;
@@ -3502,7 +3577,7 @@ export interface PlanObject {
      */
     pay_in_advance?: boolean;
     /**
-     * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+     * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
      * @example null
      */
     bill_charges_monthly?: boolean | null;
@@ -3605,7 +3680,7 @@ export interface SubscriptionUpdateInput {
 }
 export interface SubscriptionObject {
     /**
-     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system
+     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -3861,6 +3936,23 @@ export interface WalletCreateInput {
         expiration_at?: string | null;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
+            /**
+             * The number of paid credits used for recurring top-up.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "20.0"
+             */
+            paid_credits?: string | null;
+            /**
+             * The number of free granted credits used for recurring top-up.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            granted_credits?: string | null;
+            /**
+             * The method used for recurring top-up. Possible values are `fixed` or `target`.
+             * @example "target"
+             */
+            method?: "fixed" | "target";
             /**
              * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
@@ -3871,24 +3963,36 @@ export interface WalletCreateInput {
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+            /**
+             * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            started_at?: string;
             /**
              * 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"
              */
             threshold_credits?: string;
+            /**
+             * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "200.0"
+             */
+            target_ongoing_balance?: string;
         }[];
     };
 }
 export interface WalletObject {
     /**
-     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer’s record within the Lago system.
+     * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -3976,17 +4080,22 @@ export interface WalletObject {
          * @example "interval"
          */
         trigger: "interval" | "threshold";
+        /**
+         * The method used for recurring top-up. Possible values are `fixed` or `target`.
+         * @example "target"
+         */
+        method: "fixed" | "target";
         /**
          * 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";
+        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 trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
-        threshold_credits?: string;
+        threshold_credits: string;
         /**
          * The number of paid credits. Required only if there is no granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
@@ -3999,6 +4108,18 @@ export interface WalletObject {
          * @example "10.0"
          */
         granted_credits: string;
+        /**
+         * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+         * @format date-time
+         * @example "2022-08-08T00:00:00Z"
+         */
+        started_at?: string;
+        /**
+         * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "200.0"
+         */
+        target_ongoing_balance: string;
         /**
          * The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created
          * @format date-time
@@ -4036,7 +4157,7 @@ export interface WalletsPaginated {
 export interface WalletTransactionCreateInput {
     wallet_transaction: {
         /**
-         * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+         * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -4063,13 +4184,13 @@ export interface WalletTransactionCreateInput {
 }
 export interface WalletTransactionObject {
     /**
-     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction’s record within the Lago system.
+     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -4146,6 +4267,11 @@ export interface WalletUpdateInput {
              * @example "interval"
              */
             trigger?: "interval" | "threshold";
+            /**
+             * The method used for recurring top-up. Possible values are `fixed` or `target`.
+             * @example "target"
+             */
+            method?: "fixed" | "target";
             /**
              * 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"
@@ -4169,6 +4295,18 @@ export interface WalletUpdateInput {
              * @example "10.0"
              */
             granted_credits?: string;
+            /**
+             * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            started_at?: string;
+            /**
+             * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "200.0"
+             */
+            target_ongoing_balance?: string;
         }[];
     };
 }
@@ -4197,7 +4335,7 @@ export interface WebhookEndpointObject {
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system.
+     * Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -4297,9 +4435,9 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.2.0
+ * @version 1.6.0
  * @license AGPLv3
- * @baseUrl https://api.getlago.com/api/v1
+ * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -4973,7 +5111,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_subscription_id?: string;
-            /** Filter results by fee’s currency. */
+            /** Filter results by fee's currency. */
             currency?: Currency;
             /**
              * The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
@@ -5112,6 +5250,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             status?: "draft" | "finalized";
             /** Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. */
             payment_status?: "pending" | "failed" | "succeeded";
+            /**
+             * Filter invoices by payment_overdue. Possible values are `true` or `false`.
+             * @example true
+             */
+            payment_overdue?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used for updating an existing invoice.

package/esm/openapi/client.js

@@ -16,7 +16,7 @@ export var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType || (ContentType = {}));
 export class HttpClient {
-    baseUrl = "https://api.getlago.com/api/v1";
+    baseUrl = "https://{region}.getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -148,9 +148,9 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.2.0
+ * @version 1.6.0
  * @license AGPLv3
- * @baseUrl https://api.getlago.com/api/v1
+ * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *

package/package.json

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

package/script/openapi/client.d.ts

@@ -973,7 +973,7 @@ export interface CreditNoteEstimateInput {
          */
         invoice_id: string;
         /**
-         * The list of credit note’s items.
+         * The list of credit note's items.
          * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
          */
         items: {
@@ -1036,15 +1036,15 @@ export interface CreditNoteEstimated {
          * @example 20
          */
         coupons_adjustment_amount_cents: number;
-        /** Array of credit note’s items. */
+        /** Array of credit note's items. */
         items: {
             /**
-             * The credit note’s item amount, expressed in cents.
+             * The credit note's item amount, expressed in cents.
              * @example 100
              */
             amount_cents: number;
             /**
-             * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+             * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
              * @format uuid
              * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
              */
@@ -1091,7 +1091,7 @@ export interface CreditNoteEstimated {
 }
 export interface CreditObject {
     /**
-     * Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit’s item record within the Lago system.
+     * Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit's item record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -1157,17 +1157,17 @@ export type CreditNoteAppliedTaxObject = BaseAppliedTax & {
 };
 export interface CreditNoteItemObject {
     /**
-     * The credit note’s item unique identifier, created by Lago.
+     * The credit note's item unique identifier, created by Lago.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * The credit note’s item amount, expressed in cents.
+     * The credit note's item amount, expressed in cents.
      * @example 100
      */
     amount_cents: number;
-    /** The credit note’s item currency. */
+    /** The credit note's item currency. */
     amount_currency: Currency;
     /** The fee object related to the credit note item. */
     fee: FeeObject;
@@ -1294,7 +1294,7 @@ export interface CreditNoteObject {
      * @example "https://getlago.com/credit_note/file"
      */
     file_url?: string | null;
-    /** Array of credit note’s items. */
+    /** Array of credit note's items. */
     items?: CreditNoteItemObject[];
     applied_taxes?: CreditNoteAppliedTaxObject[];
 }
@@ -1331,7 +1331,7 @@ export interface CreditNoteCreateInput {
          */
         refund_amount_cents?: number | null;
         /**
-         * The list of credit note’s items.
+         * The list of credit note's items.
          * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
          */
         items: {
@@ -1411,6 +1411,41 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. */
+export interface IntegrationCustomer {
+    /**
+     * A unique identifier for the integration customer object in the Lago application.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id?: string;
+    /**
+     * The integration type used for accounting and tax syncs.
+     * Accepted values: `netsuite`.
+     * @example "netsuite"
+     */
+    type?: "netsuite";
+    /**
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
+     */
+    integration_code?: string;
+    /**
+     * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
+     * @example "cus_12345"
+     */
+    external_customer_id?: string;
+    /**
+     * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
+     * @example true
+     */
+    sync_with_provider?: boolean;
+    /**
+     * This optional field is needed only when working with `netsuite` connection.
+     * @example "2"
+     */
+    subsidiary_id?: string;
+}
 /** Array of filter object, representing multiple dimensions for a charge item. */
 export type CustomerChargeFiltersUsageObject = {
     /**
@@ -1525,7 +1560,7 @@ export interface CustomerChargeUsageObject {
     /** Object listing all the properties for a specific charge item. */
     charge: {
         /**
-         * Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge’s record within the Lago system.
+         * Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -1544,7 +1579,7 @@ export interface CustomerChargeUsageObject {
     /** The related billable metric object. */
     billable_metric: {
         /**
-         * Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric’s record within the Lago system.
+         * Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -1663,6 +1698,40 @@ export interface CustomerCreateInput {
         net_payment_term?: number | null;
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
         billing_configuration?: CustomerBillingConfiguration;
+        integration_customers?: {
+            /**
+             * A unique identifier for the integration customer object in the Lago application.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            id?: string;
+            /**
+             * The integration type used for accounting and tax syncs.
+             * Accepted values: `netsuite`.
+             * @example "netsuite"
+             */
+            integration_type?: "netsuite";
+            /**
+             * Unique code used to identify an integration connection.
+             * @example "netsuite-eu-1"
+             */
+            integration_code?: string;
+            /**
+             * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
+             * @example "cus_12345"
+             */
+            external_customer_id?: string;
+            /**
+             * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
+             * @example true
+             */
+            sync_with_provider?: boolean;
+            /**
+             * This optional field is needed only when working with `netsuite` connection.
+             * @example "2"
+             */
+            subsidiary_id?: string;
+        }[];
         /** Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
         metadata?: {
             /**
@@ -1834,6 +1903,7 @@ export interface CustomerObject {
     updated_at?: string;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
+    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
 }
 export type CustomerObjectExtended = CustomerObject & {
@@ -1867,8 +1937,8 @@ export interface CustomerUsageObject {
     to_datetime: string;
     /**
      * The date of creation of the invoice.
-     * @format date-time
-     * @example "2022-08-01T23:59:59Z"
+     * @format date
+     * @example "2022-08-01"
      */
     issuing_date: string;
     /**
@@ -1877,7 +1947,7 @@ export interface CustomerUsageObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_invoice_id?: string | null;
-    /** The currency of the customer’s current usage. */
+    /** The currency of the customer's current usage. */
     currency?: Currency;
     /**
      * The amount in cents, tax excluded.
@@ -1961,7 +2031,7 @@ export interface EventInput {
          * 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.
          * @example {"gb":10}
          */
-        properties?: Record<string, string>;
+        properties?: Record<string, string | number>;
     };
 }
 export interface EventObject {
@@ -2010,7 +2080,7 @@ export interface EventObject {
         [key: string]: any;
     };
     /**
-     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system
+     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2040,7 +2110,7 @@ export type FeeAppliedTaxObject = BaseAppliedTax & {
 };
 export interface FeeObject {
     /**
-     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2108,7 +2178,7 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
-    /** The currency of this specific fee. It indicates the monetary unit in which the fee’s cost is expressed. */
+    /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
      * The cost of the tax associated with this specific fee.
@@ -2641,12 +2711,12 @@ export interface InvoiceMetadataObject {
      */
     lago_id?: string;
     /**
-     * Represents the key of the metadata’s key-value pair.
+     * Represents the key of the metadata's key-value pair.
      * @example "digital_ref_id"
      */
     key?: string;
     /**
-     * Represents the value of the metadata’s key-value pair.
+     * Represents the value of the metadata's key-value pair.
      * @example "INV-0123456-98765"
      */
     value?: string;
@@ -2659,7 +2729,7 @@ export interface InvoiceMetadataObject {
 }
 export interface InvoiceObject {
     /**
-     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+     * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -2692,6 +2762,11 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     payment_due_date?: string;
+    /**
+     * Specifies if the payment is considered as overdue.
+     * @example true
+     */
+    payment_overdue?: boolean;
     /**
      * The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
      * @example 30
@@ -2872,7 +2947,7 @@ export interface OrganizationBillingConfiguration {
      */
     invoice_footer?: string | null;
     /**
-     * The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer’s grace period.
+     * The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.
      * @example 3
      */
     invoice_grace_period?: number;
@@ -2915,22 +2990,22 @@ export interface OrganizationObject {
     /** The default currency of an organization. */
     default_currency?: Currency;
     /**
-     * The first line of your organization’s billing address.
+     * The first line of your organization's billing address.
      * @example "100 Brex Street"
      */
     address_line1?: string | null;
     /**
-     * The second line of your organization’s billing address.
+     * The second line of your organization's billing address.
      * @example null
      */
     address_line2?: string | null;
     /**
-     * The state of your organization’s billing address.
+     * The state of your organization's billing address.
      * @example "NYC"
      */
     state?: string | null;
     /**
-     * The zipcode of your organization’s billing address.
+     * The zipcode of your organization's billing address.
      * @example "10000"
      */
     zipcode?: string | null;
@@ -2941,7 +3016,7 @@ export interface OrganizationObject {
      */
     email?: string | null;
     /**
-     * The city of your organization’s billing address.
+     * The city of your organization's billing address.
      * @example "New York"
      */
     city?: string | null;
@@ -2980,7 +3055,7 @@ export interface OrganizationObject {
      * @example "US123456789"
      */
     tax_identification_number?: string | null;
-    /** Your organization’s timezone, used for billing purposes in your own local time. Can be overwritten by the customer’s timezone. */
+    /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
     timezone?: Timezone;
     /** The custom billing settings for your organization. */
     billing_configuration: OrganizationBillingConfiguration;
@@ -2999,22 +3074,22 @@ export interface OrganizationUpdateInput {
         /** The default currency of an organization. */
         default_currency?: Currency;
         /**
-         * The first line of your organization’s billing address.
+         * The first line of your organization's billing address.
          * @example "100 Brex Street"
          */
         address_line1?: string | null;
         /**
-         * The second line of your organization’s billing address.
+         * The second line of your organization's billing address.
          * @example null
          */
         address_line2?: string | null;
         /**
-         * The state of your organization’s billing address.
+         * The state of your organization's billing address.
          * @example "NYC"
          */
         state?: string | null;
         /**
-         * The zipcode of your organization’s billing address.
+         * The zipcode of your organization's billing address.
          * @example "10000"
          */
         zipcode?: string | null;
@@ -3025,7 +3100,7 @@ export interface OrganizationUpdateInput {
          */
         email?: string | null;
         /**
-         * The city of your organization’s billing address.
+         * The city of your organization's billing address.
          * @example "New York"
          */
         city?: string | null;
@@ -3064,7 +3139,7 @@ export interface OrganizationUpdateInput {
          * @example "US123456789"
          */
         tax_identification_number?: string | null;
-        /** Your organization’s timezone, used for billing purposes in your own local time. Can be overwritten by the customer’s timezone. */
+        /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
         timezone?: Timezone;
         /**
          * Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
@@ -3150,7 +3225,7 @@ export interface PlanCreateInput {
          */
         pay_in_advance?: boolean;
         /**
-         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
          * @example null
          */
         bill_charges_monthly?: boolean | null;
@@ -3359,7 +3434,7 @@ export interface PlanUpdateInput {
          */
         pay_in_advance?: boolean;
         /**
-         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
          * @example null
          */
         bill_charges_monthly?: boolean | null;
@@ -3502,7 +3577,7 @@ export interface PlanObject {
      */
     pay_in_advance?: boolean;
     /**
-     * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+     * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly`.
      * @example null
      */
     bill_charges_monthly?: boolean | null;
@@ -3605,7 +3680,7 @@ export interface SubscriptionUpdateInput {
 }
 export interface SubscriptionObject {
     /**
-     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system
+     * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -3861,6 +3936,23 @@ export interface WalletCreateInput {
         expiration_at?: string | null;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
+            /**
+             * The number of paid credits used for recurring top-up.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "20.0"
+             */
+            paid_credits?: string | null;
+            /**
+             * The number of free granted credits used for recurring top-up.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            granted_credits?: string | null;
+            /**
+             * The method used for recurring top-up. Possible values are `fixed` or `target`.
+             * @example "target"
+             */
+            method?: "fixed" | "target";
             /**
              * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
@@ -3871,24 +3963,36 @@ export interface WalletCreateInput {
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+            /**
+             * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            started_at?: string;
             /**
              * 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"
              */
             threshold_credits?: string;
+            /**
+             * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "200.0"
+             */
+            target_ongoing_balance?: string;
         }[];
     };
 }
 export interface WalletObject {
     /**
-     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer’s record within the Lago system.
+     * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -3976,17 +4080,22 @@ export interface WalletObject {
          * @example "interval"
          */
         trigger: "interval" | "threshold";
+        /**
+         * The method used for recurring top-up. Possible values are `fixed` or `target`.
+         * @example "target"
+         */
+        method: "fixed" | "target";
         /**
          * 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";
+        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 trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
-        threshold_credits?: string;
+        threshold_credits: string;
         /**
          * The number of paid credits. Required only if there is no granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
@@ -3999,6 +4108,18 @@ export interface WalletObject {
          * @example "10.0"
          */
         granted_credits: string;
+        /**
+         * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+         * @format date-time
+         * @example "2022-08-08T00:00:00Z"
+         */
+        started_at?: string;
+        /**
+         * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "200.0"
+         */
+        target_ongoing_balance: string;
         /**
          * The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created
          * @format date-time
@@ -4036,7 +4157,7 @@ export interface WalletsPaginated {
 export interface WalletTransactionCreateInput {
     wallet_transaction: {
         /**
-         * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+         * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
@@ -4063,13 +4184,13 @@ export interface WalletTransactionCreateInput {
 }
 export interface WalletTransactionObject {
     /**
-     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction’s record within the Lago system.
+     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.
+     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -4146,6 +4267,11 @@ export interface WalletUpdateInput {
              * @example "interval"
              */
             trigger?: "interval" | "threshold";
+            /**
+             * The method used for recurring top-up. Possible values are `fixed` or `target`.
+             * @example "target"
+             */
+            method?: "fixed" | "target";
             /**
              * 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"
@@ -4169,6 +4295,18 @@ export interface WalletUpdateInput {
              * @example "10.0"
              */
             granted_credits?: string;
+            /**
+             * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            started_at?: string;
+            /**
+             * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "200.0"
+             */
+            target_ongoing_balance?: string;
         }[];
     };
 }
@@ -4197,7 +4335,7 @@ export interface WebhookEndpointObject {
      */
     lago_id: string;
     /**
-     * Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system.
+     * Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -4297,9 +4435,9 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.2.0
+ * @version 1.6.0
  * @license AGPLv3
- * @baseUrl https://api.getlago.com/api/v1
+ * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -4973,7 +5111,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_subscription_id?: string;
-            /** Filter results by fee’s currency. */
+            /** Filter results by fee's currency. */
             currency?: Currency;
             /**
              * The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
@@ -5112,6 +5250,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             status?: "draft" | "finalized";
             /** Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. */
             payment_status?: "pending" | "failed" | "succeeded";
+            /**
+             * Filter invoices by payment_overdue. Possible values are `true` or `false`.
+             * @example true
+             */
+            payment_overdue?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used for updating an existing invoice.

package/script/openapi/client.js

@@ -19,7 +19,7 @@ var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType = exports.ContentType || (exports.ContentType = {}));
 class HttpClient {
-    baseUrl = "https://api.getlago.com/api/v1";
+    baseUrl = "https://{region}.getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -152,9 +152,9 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.2.0
+ * @version 1.6.0
  * @license AGPLv3
- * @baseUrl https://api.getlago.com/api/v1
+ * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *