lago-javascript-client 1.40.0 → 1.43.0

package/script/openapi/client.d.ts

@@ -2558,188 +2558,6 @@ export interface CreditNoteCreateInput {
         metadata?: MetadataInput;
     };
 }
-export interface CreditNote {
-    credit_note: CreditNoteObject;
-}
-export interface CreditNoteUpdateInput {
-    credit_note: {
-        /**
-         * The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:
-         *
-         * - `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.
-         * - `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.
-         * - `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.
-         * @example "succeeded"
-         */
-        refund_status: "pending" | "succeeded" | "failed";
-        /** Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. */
-        metadata?: MetadataInput;
-    };
-}
-export interface CreditNoteEstimateInput {
-    credit_note: {
-        /**
-         * The invoice unique identifier, created by Lago.
-         * @format uuid
-         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-         */
-        invoice_id: string;
-        /**
-         * 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: {
-            /**
-             * The fee unique identifier, created by Lago.
-             * @format uuid
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            fee_id: string;
-            /**
-             * The amount of the credit note item, expressed in cents.
-             * @example 10
-             */
-            amount_cents: number;
-        }[];
-    };
-}
-export interface CreditNoteEstimated {
-    estimated_credit_note: {
-        /**
-         * Unique identifier assigned to the invoice that the credit note belongs to
-         * @format uuid
-         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-         */
-        lago_invoice_id: string;
-        /**
-         * The invoice unique number, related to the credit note.
-         * @example "LAG-1234"
-         */
-        invoice_number: string;
-        /**
-         * The currency of the credit note.
-         * @example "EUR"
-         */
-        currency: Currency;
-        /**
-         * The tax amount of the credit note, expressed in cents.
-         * @example 20
-         */
-        taxes_amount_cents: number;
-        /**
-         * The precise tax amount of the credit note, expressed in cents with decimal precision.
-         * @example 20.1
-         */
-        precise_taxes_amount_cents: number;
-        /**
-         * The tax rate associated with this specific credit note.
-         * @example 20
-         */
-        taxes_rate: number;
-        /**
-         * The subtotal of the credit note excluding any applicable taxes, expressed in cents.
-         * @example 100
-         */
-        sub_total_excluding_taxes_amount_cents: number;
-        /**
-         * The credited amount of the credit note, expressed in cents.
-         * @example 100
-         */
-        max_creditable_amount_cents: number;
-        /**
-         * The refunded amount of the credit note, expressed in cents.
-         * @example 0
-         */
-        max_refundable_amount_cents: number;
-        /**
-         * The ofsetted amount of the credit note, expressed in cents.
-         * @example 0
-         */
-        max_offsettable_amount_cents: number;
-        /**
-         * The pro-rated amount of the coupons applied to the source invoice.
-         * @example 20
-         */
-        coupons_adjustment_amount_cents: number;
-        /**
-         * The precise pro-rated amount with decimal precision of the coupons applied to the source invoice.
-         * @example 20.1
-         */
-        precise_coupons_adjustment_amount_cents: number;
-        /** Array of credit note's items. */
-        items: {
-            /**
-             * 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.
-             * @format uuid
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            lago_fee_id: string | null;
-        }[];
-        applied_taxes?: {
-            /**
-             * Unique identifier of the tax, created by Lago.
-             * @format uuid
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            lago_tax_id?: string;
-            /**
-             * Name of the tax.
-             * @example "TVA"
-             */
-            tax_name?: string;
-            /**
-             * Unique code used to identify the tax associated with the API request.
-             * @example "french_standard_vat"
-             */
-            tax_code?: string;
-            /**
-             * The percentage rate of the tax
-             * @example 20
-             */
-            tax_rate?: number;
-            /**
-             * Internal description of the taxe
-             * @example "French standard VAT"
-             */
-            tax_description?: string;
-            /** @example 100 */
-            base_amount_cents?: number;
-            /**
-             * Amount of the tax
-             * @example 2000
-             */
-            amount_cents?: number;
-            /**
-             * Currency of the tax
-             * @example "USD"
-             */
-            amount_currency?: Currency;
-        }[];
-    };
-}
-export interface ApiErrorNotAllowed {
-    /**
-     * @format int32
-     * @example 405
-     */
-    status: number;
-    /** @example "Method Not Allowed" */
-    error: string;
-    /** @example "not_allowed" */
-    code: string;
-}
-export interface CreditNoteMetadataResponse {
-    /**
-     * Custom metadata stored as key-value pairs.
-     * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
-     */
-    metadata: MetadataObject;
-}
 /** @example "US" */
 export type CountryOrNull = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
 /** @example "America/Los_Angeles" */
@@ -3011,23 +2829,211 @@ export interface CustomerBaseObject {
      */
     updated_at?: string;
     /**
-     * Specifies how invoices with a zero total amount should be handled:
-     * - `inherit`: (Default) Follows the organization-level configuration.
-     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
-     * - `skip`: Invoices with a total amount of zero are not finalized.
-     * @example "inherit"
+     * Specifies how invoices with a zero total amount should be handled:
+     * - `inherit`: (Default) Follows the organization-level configuration.
+     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+     * - `skip`: Invoices with a total amount of zero are not finalized.
+     * @example "inherit"
+     */
+    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
+    /**
+     * Set to true to exclude all invoice custom sections from PDF generation for this customer only.
+     * @example false
+     */
+    skip_invoice_custom_sections?: boolean;
+    /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
+    billing_configuration?: CustomerBillingConfiguration;
+    /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
+    shipping_address?: Address;
+    metadata?: CustomerMetadata[];
+}
+export type CreditNoteExtendedObject = CreditNoteObject & {
+    customer?: CustomerBaseObject;
+};
+export interface CreditNoteExtended {
+    credit_note: CreditNoteExtendedObject;
+}
+export interface CreditNoteUpdateInput {
+    credit_note: {
+        /**
+         * The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:
+         *
+         * - `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.
+         * - `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.
+         * - `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.
+         * @example "succeeded"
+         */
+        refund_status: "pending" | "succeeded" | "failed";
+        /** Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. */
+        metadata?: MetadataInput;
+    };
+}
+export interface CreditNote {
+    credit_note: CreditNoteObject;
+}
+export interface CreditNoteEstimateInput {
+    credit_note: {
+        /**
+         * The invoice unique identifier, created by Lago.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        invoice_id: string;
+        /**
+         * 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: {
+            /**
+             * The fee unique identifier, created by Lago.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            fee_id: string;
+            /**
+             * The amount of the credit note item, expressed in cents.
+             * @example 10
+             */
+            amount_cents: number;
+        }[];
+    };
+}
+export interface CreditNoteEstimated {
+    estimated_credit_note: {
+        /**
+         * Unique identifier assigned to the invoice that the credit note belongs to
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_invoice_id: string;
+        /**
+         * The invoice unique number, related to the credit note.
+         * @example "LAG-1234"
+         */
+        invoice_number: string;
+        /**
+         * The currency of the credit note.
+         * @example "EUR"
+         */
+        currency: Currency;
+        /**
+         * The tax amount of the credit note, expressed in cents.
+         * @example 20
+         */
+        taxes_amount_cents: number;
+        /**
+         * The precise tax amount of the credit note, expressed in cents with decimal precision.
+         * @example 20.1
+         */
+        precise_taxes_amount_cents: number;
+        /**
+         * The tax rate associated with this specific credit note.
+         * @example 20
+         */
+        taxes_rate: number;
+        /**
+         * The subtotal of the credit note excluding any applicable taxes, expressed in cents.
+         * @example 100
+         */
+        sub_total_excluding_taxes_amount_cents: number;
+        /**
+         * The credited amount of the credit note, expressed in cents.
+         * @example 100
+         */
+        max_creditable_amount_cents: number;
+        /**
+         * The refunded amount of the credit note, expressed in cents.
+         * @example 0
+         */
+        max_refundable_amount_cents: number;
+        /**
+         * The ofsetted amount of the credit note, expressed in cents.
+         * @example 0
+         */
+        max_offsettable_amount_cents: number;
+        /**
+         * The pro-rated amount of the coupons applied to the source invoice.
+         * @example 20
+         */
+        coupons_adjustment_amount_cents: number;
+        /**
+         * The precise pro-rated amount with decimal precision of the coupons applied to the source invoice.
+         * @example 20.1
+         */
+        precise_coupons_adjustment_amount_cents: number;
+        /** Array of credit note's items. */
+        items: {
+            /**
+             * 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.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_fee_id: string | null;
+        }[];
+        applied_taxes?: {
+            /**
+             * Unique identifier of the tax, created by Lago.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_tax_id?: string;
+            /**
+             * Name of the tax.
+             * @example "TVA"
+             */
+            tax_name?: string;
+            /**
+             * Unique code used to identify the tax associated with the API request.
+             * @example "french_standard_vat"
+             */
+            tax_code?: string;
+            /**
+             * The percentage rate of the tax
+             * @example 20
+             */
+            tax_rate?: number;
+            /**
+             * Internal description of the taxe
+             * @example "French standard VAT"
+             */
+            tax_description?: string;
+            /** @example 100 */
+            base_amount_cents?: number;
+            /**
+             * Amount of the tax
+             * @example 2000
+             */
+            amount_cents?: number;
+            /**
+             * Currency of the tax
+             * @example "USD"
+             */
+            amount_currency?: Currency;
+        }[];
+    };
+}
+export interface ApiErrorNotAllowed {
+    /**
+     * @format int32
+     * @example 405
      */
-    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
+    status: number;
+    /** @example "Method Not Allowed" */
+    error: string;
+    /** @example "not_allowed" */
+    code: string;
+}
+export interface CreditNoteMetadataResponse {
     /**
-     * Set to true to exclude all invoice custom sections from PDF generation for this customer only.
-     * @example false
+     * Custom metadata stored as key-value pairs.
+     * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
      */
-    skip_invoice_custom_sections?: boolean;
-    /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
-    billing_configuration?: CustomerBillingConfiguration;
-    /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
-    shipping_address?: Address;
-    metadata?: CustomerMetadata[];
+    metadata: MetadataObject;
 }
 /** Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. */
 export interface IntegrationCustomer {
@@ -3676,6 +3682,12 @@ export interface PaymentObject {
      * @example "cus_5eb0285bcf941bc6ba"
      */
     provider_customer_id: string;
+    /**
+     * The unique identifier of the payment method used for this payment.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    payment_method_id?: string | null;
     /**
      * The next action to be taken by the customer to complete the payment. Should usually be empty, except when receiving the `payment.requires_action` webhook.
      * @example {"type":"redirect_to_url","redirect_to_url":{"url":"https://hooks.stripe.com/3d_secure_2/hosted?merchant=acct_AAA&payment_intent=pi_BBB&payment_intent_client_secret=pi_BBB&publishable_key=pk_test_CCC","return_url":"https://app.example.com"}}
@@ -3737,6 +3749,20 @@ export interface PaymentRequestsPaginated {
     payment_requests: PaymentRequestObject[];
     meta: PaginationMeta;
 }
+/** Reference to a specific payment method for processing the payment. */
+export interface PaymentMethodReference {
+    /**
+     * The type of payment method to use.
+     * @example "provider"
+     */
+    payment_method_type?: "provider" | "manual";
+    /**
+     * The unique identifier of the payment method (required when using a specific provider payment method).
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    payment_method_id?: string;
+}
 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
@@ -3775,6 +3801,16 @@ export interface SubscriptionObject {
      * @example "premium"
      */
     plan_code: string;
+    /**
+     * The base cost of the related plan, excluding any applicable taxes, that is billed on a recurring basis.
+     * @example 10000
+     */
+    plan_amount_cents?: number;
+    /**
+     * The currency of the related plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+     * @example "USD"
+     */
+    plan_amount_currency?: Currency;
     /**
      * The status of the subscription, which can have the following values:
      * - `active`: the subscription is currently active and applied to the customer.
@@ -3860,12 +3896,13 @@ export interface SubscriptionObject {
      *
      * - `credit`: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.
      * - `refund`: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.
+     * - `offset`: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is applied to the invoice reducing its amount due.
      * - `skip`: No credit note is generated for the unused subscription time.
      *
      * _Note: This field is only applicable to pay-in-advance plans and will be `null` for pay-in-arrears plans._
      * @example "credit"
      */
-    on_termination_credit_note: "credit" | "refund" | "skip";
+    on_termination_credit_note: "credit" | "refund" | "offset" | "skip";
     /**
      * When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage.
      * This field allows you to control the behavior of the invoice generation:
@@ -3876,6 +3913,8 @@ export interface SubscriptionObject {
      * @example "generate"
      */
     on_termination_invoice: "generate" | "skip";
+    /** The payment method assigned to this subscription for processing payments. */
+    payment_method?: PaymentMethodReference;
 }
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
@@ -3976,6 +4015,8 @@ export interface WalletRecurringTransactionRule {
      * @example false
      */
     ignore_paid_top_up_limits: boolean;
+    /** The payment method assigned to this recurring transaction rule for processing top-up payments. */
+    payment_method?: PaymentMethodReference;
 }
 export interface WalletObject {
     /**
@@ -4010,6 +4051,11 @@ export interface WalletObject {
      * @example "Prepaid"
      */
     name?: string | null;
+    /**
+     * The code of the wallet.
+     * @example "prepaid"
+     */
+    code?: string | null;
     /**
      * Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
      * @min 1
@@ -4122,6 +4168,8 @@ export interface WalletObject {
      * @example 1000
      */
     paid_top_up_max_amount_cents?: number | null;
+    /** The payment method assigned to this wallet for processing top-up payments. */
+    payment_method?: PaymentMethodReference;
     /**
      * Custom metadata stored as key-value pairs.
      * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
@@ -4407,35 +4455,78 @@ export interface CustomerPastUsage {
     usage_periods: CustomerUsage[];
     meta: PaginationMeta;
 }
-/** . */
 export interface CustomerCheckoutUrl {
-    customer?: {
-        /**
-         * 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
-         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-         */
-        lago_customer_id: string;
-        /**
-         * The customer external unique identifier (provided by your own application)
-         * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-         */
-        external_customer_id: string;
-        /**
-         * The Payment Provider name linked to the Customer.
-         * @example "stripe"
-         */
-        payment_provider: string;
-        /**
-         * Code of the payment provider
-         * @example "Stripe Prod"
-         */
-        payment_provider_code?: string;
-        /**
-         * The new generated Payment Provider Checkout URL for the Customer.
-         * @example "https://foo.bar"
-         */
-        checkout_url?: 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
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_customer_id: string;
+    /**
+     * The customer external unique identifier (provided by your own application)
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    external_customer_id: string;
+    /**
+     * The Payment Provider name linked to the Customer.
+     * @example "stripe"
+     */
+    payment_provider: string;
+    /**
+     * Code of the payment provider
+     * @example "Stripe Prod"
+     */
+    payment_provider_code?: string;
+    /**
+     * The new generated Payment Provider Checkout URL for the Customer.
+     * @example "https://foo.bar"
+     */
+    checkout_url?: string;
+}
+export interface PaymentMethodObject {
+    /**
+     * The unique identifier of the payment method, created by Lago.
+     * @format uuid
+     * @example "4cf085a7-c196-4f07-a543-97c50ec6e8b2"
+     */
+    lago_id: string;
+    /**
+     * Indicates whether this payment method is the default one for the customer.
+     * @example true
+     */
+    is_default: boolean;
+    /**
+     * Code of the payment provider associated with this payment method.
+     * @example "stripe_prod"
+     */
+    payment_provider_code?: string | null;
+    /**
+     * Human-readable name of the payment provider.
+     * @example "Stripe"
+     */
+    payment_provider_name?: string | null;
+    /**
+     * The type of the payment provider.
+     * @example "stripe"
+     */
+    payment_provider_type: "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
+    /**
+     * Unique identifier of the payment method within the payment provider.
+     * @example "pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ"
+     */
+    provider_method_id: string;
+    /**
+     * Timestamp when the payment method was created in Lago's database.
+     * @format date-time
+     * @example "2025-01-21T00:10:29Z"
+     */
+    created_at: string;
+}
+export interface PaymentMethodsPaginated {
+    payment_methods: PaymentMethodObject[];
+    meta: PaginationMeta;
+}
+export interface PaymentMethod {
+    payment_method: PaymentMethodObject;
 }
 export interface EventObject {
     /**
@@ -4869,6 +4960,8 @@ export interface InvoiceOneOffCreateInput {
              */
             skip_psp?: boolean | null;
         }[];
+        /** Optional payment method to use for processing the invoice payment. */
+        payment_method?: PaymentMethodReference;
     };
 }
 export interface ErrorDetailObject {
@@ -5400,6 +5493,8 @@ export interface PaymentRequestCreateInput {
         email: string;
         /** A list of Lago IDs for the customer's overdue invoices to start the dunning process */
         lago_invoice_ids: string[];
+        /** Optional payment method to use for processing the payment request. */
+        payment_method?: PaymentMethodReference;
     };
 }
 export interface PaymentRequest {
@@ -5740,6 +5835,11 @@ export interface ChargeObject {
          */
         conversion_rate: string;
     };
+    /**
+     * Specifies whether the charge accepts a target wallet for prepaid credits deduction.
+     * @example false
+     */
+    accepts_target_wallet?: boolean | null;
 }
 export interface FixedChargeProperties {
     /**
@@ -6190,6 +6290,11 @@ export interface PlanCreateInput {
                  */
                 conversion_rate?: string;
             };
+            /**
+             * Specifies whether the charge accepts a target wallet for prepaid credits deduction.
+             * @example false
+             */
+            accepts_target_wallet?: boolean | null;
         }[];
         /**
          * Additional fixed charges for this plan.
@@ -6398,6 +6503,11 @@ export interface PlanUpdateInput {
                  */
                 conversion_rate?: string;
             };
+            /**
+             * Specifies whether the charge accepts a target wallet for prepaid credits deduction.
+             * @example false
+             */
+            accepts_target_wallet?: boolean | null;
         }[];
         /**
          * Additional fixed charges for this plan.
@@ -6682,6 +6792,8 @@ export interface SubscriptionCreateInput {
         subscription_at?: string;
         /** Based plan overrides. */
         plan_overrides?: PlanOverridesObject;
+        /** Optional payment method to use for processing subscription payments. */
+        payment_method?: PaymentMethodReference;
     };
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
@@ -6716,6 +6828,8 @@ export interface SubscriptionUpdateInput {
         subscription_at?: string;
         /** Based plan overrides. */
         plan_overrides?: PlanOverridesObject;
+        /** Optional payment method to use for processing subscription payments. */
+        payment_method?: PaymentMethodReference;
     };
 }
 export interface LifetimeUsageThresholdObject {
@@ -6921,6 +7035,21 @@ export interface AlertCreateInput {
         code: string;
     };
 }
+export interface AlertBatchCreateInput {
+    /** Array of alerts to create. All alerts are created atomically - if any fail validation, none are created. */
+    alerts: (AlertBaseInput & {
+        /**
+         * The type of alert.
+         * @example "billable_metric_current_usage_amount"
+         */
+        alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+        /**
+         * Unique code used to identify the alert.
+         * @example "storage_threshold_alert"
+         */
+        code: string;
+    })[];
+}
 export interface Alert {
     alert: AlertObject;
 }
@@ -7026,6 +7155,11 @@ export interface WalletCreateInput {
          * @example "Prepaid"
          */
         name?: string | null;
+        /**
+         * The code of the wallet.
+         * @example "prepaid"
+         */
+        code?: string | null;
         /**
          * Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
          * @min 1
@@ -7112,6 +7246,8 @@ export interface WalletCreateInput {
         ignore_paid_top_up_limits_on_creation?: boolean | null;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: any[] | null;
+        /** Optional payment method to use for processing wallet top-up payments. */
+        payment_method?: PaymentMethodReference;
         /** Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. */
         metadata?: MetadataInput;
     };
@@ -7126,6 +7262,11 @@ export interface WalletUpdateInput {
          * @example "new_name"
          */
         name?: string | null;
+        /**
+         * The code of the wallet.
+         * @example "prepaid"
+         */
+        code?: string | null;
         /**
          * Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
          * @min 1
@@ -7223,7 +7364,11 @@ export interface WalletUpdateInput {
              * @example "Tokens for models 'high-fidelity-boost'"
              */
             transaction_name?: string | null;
+            /** Optional payment method to use for processing recurring top-up payments. */
+            payment_method?: PaymentMethodReference;
         }[];
+        /** Optional payment method to use for processing wallet top-up payments. */
+        payment_method?: PaymentMethodReference;
         /** Set wallet limitations to fee types. */
         applies_to?: {
             /**
@@ -7291,6 +7436,8 @@ export interface WalletTransactionCreateInput {
          * @example false
          */
         ignore_paid_top_up_limits?: boolean;
+        /** Optional payment method to use for processing the wallet transaction payment. */
+        payment_method?: PaymentMethodReference;
         /**
          * 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"}]
@@ -7381,6 +7528,8 @@ export interface WalletTransactionObject {
      * @example "Tokens for models 'high-fidelity-boost'"
      */
     name: string | null;
+    /** The payment method assigned to this wallet transaction for processing the payment. */
+    payment_method?: PaymentMethodReference;
 }
 export interface WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
@@ -7633,9 +7782,6 @@ export type CustomerViesCheckObject = CustomerBaseObject & {
         valid?: boolean;
     };
 };
-export type CreditNoteExtendedObject = CreditNoteObject & {
-    customer?: CustomerBaseObject;
-};
 export interface CreditNotePaymentProviderRefundError {
     /**
      * Unique identifier assigned to the credit note within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit note record within the Lago system.
@@ -7745,6 +7891,9 @@ export interface FeeTaxProviderErrorObject {
     event_transaction_id: string | null;
     provider_error: string | Record<string, any>;
 }
+export type InvoicePaymentDisputeLostObject = InvoiceObjectExtended & {
+    provider_error?: string | Record<string, any>;
+};
 export interface InvoicePaymentFailureObject {
     /**
      * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
@@ -7976,7 +8125,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.40.0
+ * @version 1.42.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -8680,7 +8829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/credit_notes
          * @secure
          */
-        createCreditNote: (data: CreditNoteCreateInput, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createCreditNote: (data: CreditNoteCreateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteExtended, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
         /**
          * @description This endpoint list all existing credit notes.
          *
@@ -8769,7 +8918,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/credit_notes/{lago_id}
          * @secure
          */
-        updateCreditNote: (lagoId: string, data: CreditNoteUpdateInput, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateCreditNote: (lagoId: string, data: CreditNoteUpdateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteExtended, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves an existing credit note.
          *
@@ -8779,7 +8928,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/credit_notes/{lago_id}
          * @secure
          */
-        findCreditNote: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findCreditNote: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<CreditNoteExtended, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint downloads the PDF of an existing credit note.
          *
@@ -8809,7 +8958,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
-        voidCreditNote: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
+        voidCreditNote: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<CreditNoteExtended, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
          * @description This endpoint replaces all existing metadata on a credit note with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
          *
@@ -9350,6 +9499,47 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         generateCustomerCheckoutUrl: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<CustomerCheckoutUrl, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint retrieves all payment methods of a Customer.
+         *
+         * @tags payment_methods
+         * @name FindAllCustomersPaymentMethods
+         * @summary List all customer payment methods
+         * @request GET:/customers/{external_customer_id}/payment_methods
+         * @secure
+         */
+        findAllCustomersPaymentMethods: (externalCustomerId: string, query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+        }, params?: RequestParams) => Promise<HttpResponse<PaymentMethodsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description Use the payment method as default when not selected a payment method
+         *
+         * @tags payment_methods
+         * @name PaymentMethodSetAsDefault
+         * @summary Set the payment method as default
+         * @request PUT:/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default
+         * @secure
+         */
+        paymentMethodSetAsDefault: (lagoId: string, externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<PaymentMethod, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint deletes a specific payment method for a customer.
+         *
+         * @tags payment_methods
+         * @name DestroyPaymentMethod
+         * @summary Delete a payment method
+         * @request DELETE:/customers/{external_customer_id}/payment_methods/{lago_id}
+         * @secure
+         */
+        destroyPaymentMethod: (lagoId: string, externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<PaymentMethod, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     events: {
         /**
@@ -9793,7 +9983,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/invoices/{lago_id}/retry_payment
          * @secure
          */
-        retryPayment: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
+        retryPayment: (lagoId: string, data?: {
+            /** Reference to a specific payment method for processing the payment. */
+            payment_method?: PaymentMethodReference;
+        }, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
          * @description This endpoint is used for voiding an invoice. • When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`. • When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this validation is bypassed: the invoice is forcibly voided and a credit note is generated. If the specified refund/credit amounts do not cover the full invoice total, the remainder is issued on a second credit note that is created and immediately voided.
          *
@@ -10276,15 +10469,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getSubscriptionAlerts: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Alerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint allows you to create a new alert for a subscription.
+         * @description This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
          *
          * @tags subscriptions
          * @name CreateSubscriptionAlert
-         * @summary Create a subscription alert
+         * @summary Create subscription alert(s)
          * @request POST:/subscriptions/{external_id}/alerts
          * @secure
          */
-        createSubscriptionAlert: (externalId: string, data: AlertCreateInput, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        createSubscriptionAlert: (externalId: string, data: AlertCreateInput | AlertBatchCreateInput, params?: RequestParams) => Promise<HttpResponse<Alerts | Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to delete all alerts for a subscription.
+         *
+         * @tags subscriptions
+         * @name DeleteAllSubscriptionAlerts
+         * @summary Delete all subscription alerts
+         * @request DELETE:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        deleteAllSubscriptionAlerts: (externalId: string, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of a specific alert for a subscription.
          *