lago-javascript-client 1.20.0 → 1.22.0

package/esm/openapi/client.d.ts

@@ -1557,8 +1557,8 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
-     * @example ["card","sepa_debit"]
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.
+     * @example ["card","sepa_debit","us_bank_account","bacs_debit","link","boleto","crypto","customer_balance"]
      */
     provider_payment_methods?: string[] | null;
 }
@@ -1949,9 +1949,9 @@ export interface CustomerIntegratrionErrorObject {
     external_customer_id: string;
     /**
      * The type of accounting provider code
-     * @example "anrock"
+     * @example "anrok"
      */
-    accounting_provider: "anrock" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
+    accounting_provider: "anrok" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
     /**
      * Code of the accounting provider
      * @example "Netsuite Prod"
@@ -2845,17 +2845,17 @@ export interface FeeObject {
     /** Item attached to the fee */
     item: {
         /**
-         * The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
+         * The fee type. Possible values are `add-on`, `charge`, `credit`, `subscription` or `commitment`.
          * @example "subscription"
          */
         type: "charge" | "add_on" | "subscription" | "credit";
         /**
-         * The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`.
+         * The code of the fee item. It can be the code of the `add-on`, the code of the `charge`, the code of the `credit` or the code of the `subscription`.
          * @example "startup"
          */
         code: string;
         /**
-         * The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`.
+         * The name of the fee item. It can be the name of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
          * @example "Startup"
          */
         name: string;
@@ -2872,13 +2872,13 @@ export interface FeeObject {
         /** Key value list of event properties */
         filters?: Record<string, string[]>;
         /**
-         * Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`.
+         * Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
         lago_item_id: string;
         /**
-         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`.
+         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription` or `Commitment`.
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
@@ -5452,7 +5452,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.20.0
+ * @version 1.22.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5991,20 +5991,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @tags customers
          * @name FindCustomer
          * @summary Retrieve a customer
-         * @request GET:/customers/{external_id}
+         * @request GET:/customers/{external_customer_id}
          * @secure
          */
-        findCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findCustomer: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint deletes an existing customer.
          *
          * @tags customers
          * @name DestroyCustomer
          * @summary Delete a customer
-         * @request DELETE:/customers/{external_id}
+         * @request DELETE:/customers/{external_customer_id}
          * @secure
          */
-        destroyCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        destroyCustomer: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to delete a specific coupon that has been applied to a customer.
          *
@@ -6048,6 +6048,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "sub_1234567890"
              */
             external_subscription_id: string;
+            /**
+             * Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.
+             * @default true
+             * @example true
+             */
+            apply_taxes?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
@@ -6427,8 +6433,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example true
              */
             payment_dispute_lost?: boolean;
-            /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off` or `advance_charges` */
-            invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges";
+            /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`. */
+            invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
             /**
              * Filter invoices by self billed. Possible values are `true` or `false`.
              * @example true
@@ -6548,6 +6554,141 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                 payment_url?: string | undefined;
             } | undefined;
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for generating invoice preview.
+         *
+         * @tags invoices
+         * @name InvoicePreview
+         * @summary Create an invoice preview
+         * @request POST:/invoices/preview
+         * @secure
+         */
+        invoicePreview: (data: {
+            customer: {
+                /**
+                 * The first line of the billing address
+                 * @example "5230 Penfield Ave"
+                 */
+                address_line1?: string;
+                /**
+                 * The second line of the billing address
+                 * @example null
+                 */
+                address_line2?: string | null;
+                /**
+                 * The city of the customer's billing address
+                 * @example "Woodland Hills"
+                 */
+                city?: string;
+                /**
+                 * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+                 * @example "US"
+                 */
+                country?: Country;
+                /**
+                 * Unique identifier assigned to the customer in your application.
+                 * @example "hooli_1234"
+                 */
+                external_id?: string;
+                integration_customers?: {
+                    /**
+                     * The integration type used for accounting and tax syncs.
+                     * Accepted values: `anrok`.
+                     * @example "anrok"
+                     */
+                    integration_type: "anrok";
+                    /**
+                     * Unique code used to identify an integration connection.
+                     * @example "anrok1"
+                     */
+                    integration_code: string;
+                }[];
+                /**
+                 * The full name of the customer
+                 * @example "Gavin Belson"
+                 */
+                name?: string;
+                /**
+                 * The currency of the invoice.
+                 * @example "EUR"
+                 */
+                currency?: Currency;
+                /** 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;
+                /**
+                 * The state of the customer's billing address
+                 * @example "CA"
+                 */
+                state?: string;
+                /**
+                 * The tax identification number of the customer
+                 * @example "EU123456789"
+                 */
+                tax_identification_number?: string;
+                /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
+                timezone?: Timezone;
+            };
+            /**
+             * The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+             * @example "startup"
+             */
+            plan_code?: string;
+            /**
+             * The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_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"
+             */
+            subscription_at?: string;
+            /**
+             * The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
+             * @example "anniversary"
+             */
+            billing_time?: "calendar" | "anniversary";
+            coupons?: {
+                /**
+                 * The name of the coupon.
+                 * @example "Startup Deal"
+                 */
+                name?: string;
+                /**
+                 * Unique code used to identify the coupon.
+                 * @example "startup_deal"
+                 */
+                code: string;
+                /**
+                 * The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.
+                 *
+                 * - If set to `fixed_amount`, the coupon represents a fixed amount discount.
+                 * - If set to `percentage`, the coupon represents a percentage-based discount.
+                 * @example "fixed_amount"
+                 */
+                coupon_type?: "fixed_amount" | "percentage";
+                /**
+                 * The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.
+                 * @example 5000
+                 */
+                amount_cents?: number | null;
+                /**
+                 * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+                 * @example "USD"
+                 */
+                amount_currency?: Currency | null;
+                /**
+                 * The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
+                 * @pattern ^[0-9]+.?[0-9]*$
+                 * @example null
+                 */
+                percentage_rate?: string | null;
+                /**
+                 * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
+                 * @example 6
+                 */
+                frequency_duration?: number | null;
+            }[];
+            subscriptions?: {
+                external_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -6637,6 +6778,124 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             external_customer_id?: string;
         }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
     };
+    payments: {
+        /**
+         * @description This endpoint is used to create a manual payment
+         *
+         * @tags payments
+         * @name CreatePayment
+         * @summary Create a payment
+         * @request POST:/payments
+         * @secure
+         */
+        createPayment: (data: {
+            payment: {
+                /**
+                 * Unique identifier assigned to the invoice
+                 * @example "486b147a-02a1-4ccf-8603-f3541fc25e7a"
+                 */
+                invoice_id: string;
+                /**
+                 * The payment amount in cents
+                 * @example 100
+                 */
+                amount_cents: number;
+                /**
+                 * Reference for the payment
+                 * @example "ref1"
+                 */
+                reference: string;
+                /**
+                 * The date the payment was made
+                 * @format date
+                 * @example "2025-02-20"
+                 */
+                paid_at?: string;
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment: {
+                /**
+                 * The unique identifier of the payment, created by Lago.
+                 * @format uuid
+                 * @example "4cf085a7-c196-4f07-a543-97c50ec6e8b2"
+                 */
+                lago_id?: string;
+                /** List of invoice IDs associated with the payment. */
+                invoice_ids?: string[];
+                /**
+                 * The amount of the payment in cents.
+                 * @example 100
+                 */
+                amount_cents?: number;
+                /**
+                 * The currency of the payment amount.
+                 * @example "USD"
+                 */
+                amount_currency?: string;
+                /**
+                 * The current status of the payment.
+                 * @example "succeeded"
+                 */
+                payment_status?: string;
+                /**
+                 * The type of payment.
+                 * @example "manual"
+                 */
+                type?: string;
+                /**
+                 * Reference for the payment.
+                 * @example "ref1"
+                 */
+                reference?: string;
+                /**
+                 * External identifier for the payment (if applicable).
+                 * @example null
+                 */
+                external_payment_id?: string | null;
+                /**
+                 * Timestamp when the payment was created.
+                 * @format date-time
+                 * @example "2025-02-20T00:00:00Z"
+                 */
+                created_at?: string;
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all payments
+         *
+         * @tags payments
+         * @name FindAllPayments
+         * @summary List all payments
+         * @request GET:/payments
+         * @secure
+         */
+        findAllPayments: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+            /**
+             * 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.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_invoice_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payments: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
@@ -6982,6 +7241,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createWalletTransaction: (data: WalletTransactionCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to retrieve a specific wallet transactions.
+         *
+         * @tags wallets
+         * @name FindWalletTransaction
+         * @summary Retrieve a wallet transaction
+         * @request GET:/wallet_transactions/{lago_id}
+         * @secure
+         */
+        findWalletTransaction: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionObject, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     webhooks: {
         /**

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.20.0
+ * @version 1.22.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -723,11 +723,11 @@ export class Api extends HttpClient {
          * @tags customers
          * @name FindCustomer
          * @summary Retrieve a customer
-         * @request GET:/customers/{external_id}
+         * @request GET:/customers/{external_customer_id}
          * @secure
          */
-        findCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        findCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "GET",
             secure: true,
             format: "json",
@@ -739,11 +739,11 @@ export class Api extends HttpClient {
          * @tags customers
          * @name DestroyCustomer
          * @summary Delete a customer
-         * @request DELETE:/customers/{external_id}
+         * @request DELETE:/customers/{external_customer_id}
          * @secure
          */
-        destroyCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        destroyCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "DELETE",
             secure: true,
             format: "json",
@@ -1155,6 +1155,24 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for generating invoice preview.
+         *
+         * @tags invoices
+         * @name InvoicePreview
+         * @summary Create an invoice preview
+         * @request POST:/invoices/preview
+         * @secure
+         */
+        invoicePreview: (data, params = {}) => this.request({
+            path: `/invoices/preview`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -1244,6 +1262,43 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    payments = {
+        /**
+         * @description This endpoint is used to create a manual payment
+         *
+         * @tags payments
+         * @name CreatePayment
+         * @summary Create a payment
+         * @request POST:/payments
+         * @secure
+         */
+        createPayment: (data, params = {}) => this.request({
+            path: `/payments`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all payments
+         *
+         * @tags payments
+         * @name FindAllPayments
+         * @summary List all payments
+         * @request GET:/payments
+         * @secure
+         */
+        findAllPayments: (query, params = {}) => this.request({
+            path: `/payments`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
@@ -1663,6 +1718,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used to retrieve a specific wallet transactions.
+         *
+         * @tags wallets
+         * @name FindWalletTransaction
+         * @summary Retrieve a wallet transaction
+         * @request GET:/wallet_transactions/{lago_id}
+         * @secure
+         */
+        findWalletTransaction: (lagoId, params = {}) => this.request({
+            path: `/wallet_transactions/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     webhooks = {
         /**

package/package.json

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

package/script/openapi/client.d.ts

@@ -1557,8 +1557,8 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
-     * @example ["card","sepa_debit"]
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.
+     * @example ["card","sepa_debit","us_bank_account","bacs_debit","link","boleto","crypto","customer_balance"]
      */
     provider_payment_methods?: string[] | null;
 }
@@ -1949,9 +1949,9 @@ export interface CustomerIntegratrionErrorObject {
     external_customer_id: string;
     /**
      * The type of accounting provider code
-     * @example "anrock"
+     * @example "anrok"
      */
-    accounting_provider: "anrock" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
+    accounting_provider: "anrok" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
     /**
      * Code of the accounting provider
      * @example "Netsuite Prod"
@@ -2845,17 +2845,17 @@ export interface FeeObject {
     /** Item attached to the fee */
     item: {
         /**
-         * The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
+         * The fee type. Possible values are `add-on`, `charge`, `credit`, `subscription` or `commitment`.
          * @example "subscription"
          */
         type: "charge" | "add_on" | "subscription" | "credit";
         /**
-         * The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`.
+         * The code of the fee item. It can be the code of the `add-on`, the code of the `charge`, the code of the `credit` or the code of the `subscription`.
          * @example "startup"
          */
         code: string;
         /**
-         * The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`.
+         * The name of the fee item. It can be the name of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
          * @example "Startup"
          */
         name: string;
@@ -2872,13 +2872,13 @@ export interface FeeObject {
         /** Key value list of event properties */
         filters?: Record<string, string[]>;
         /**
-         * Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`.
+         * Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
          * @format uuid
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
         lago_item_id: string;
         /**
-         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`.
+         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription` or `Commitment`.
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
@@ -5452,7 +5452,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.20.0
+ * @version 1.22.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5991,20 +5991,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @tags customers
          * @name FindCustomer
          * @summary Retrieve a customer
-         * @request GET:/customers/{external_id}
+         * @request GET:/customers/{external_customer_id}
          * @secure
          */
-        findCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findCustomer: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint deletes an existing customer.
          *
          * @tags customers
          * @name DestroyCustomer
          * @summary Delete a customer
-         * @request DELETE:/customers/{external_id}
+         * @request DELETE:/customers/{external_customer_id}
          * @secure
          */
-        destroyCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        destroyCustomer: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to delete a specific coupon that has been applied to a customer.
          *
@@ -6048,6 +6048,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "sub_1234567890"
              */
             external_subscription_id: string;
+            /**
+             * Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.
+             * @default true
+             * @example true
+             */
+            apply_taxes?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
@@ -6427,8 +6433,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example true
              */
             payment_dispute_lost?: boolean;
-            /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off` or `advance_charges` */
-            invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges";
+            /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`. */
+            invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
             /**
              * Filter invoices by self billed. Possible values are `true` or `false`.
              * @example true
@@ -6548,6 +6554,141 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                 payment_url?: string | undefined;
             } | undefined;
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for generating invoice preview.
+         *
+         * @tags invoices
+         * @name InvoicePreview
+         * @summary Create an invoice preview
+         * @request POST:/invoices/preview
+         * @secure
+         */
+        invoicePreview: (data: {
+            customer: {
+                /**
+                 * The first line of the billing address
+                 * @example "5230 Penfield Ave"
+                 */
+                address_line1?: string;
+                /**
+                 * The second line of the billing address
+                 * @example null
+                 */
+                address_line2?: string | null;
+                /**
+                 * The city of the customer's billing address
+                 * @example "Woodland Hills"
+                 */
+                city?: string;
+                /**
+                 * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+                 * @example "US"
+                 */
+                country?: Country;
+                /**
+                 * Unique identifier assigned to the customer in your application.
+                 * @example "hooli_1234"
+                 */
+                external_id?: string;
+                integration_customers?: {
+                    /**
+                     * The integration type used for accounting and tax syncs.
+                     * Accepted values: `anrok`.
+                     * @example "anrok"
+                     */
+                    integration_type: "anrok";
+                    /**
+                     * Unique code used to identify an integration connection.
+                     * @example "anrok1"
+                     */
+                    integration_code: string;
+                }[];
+                /**
+                 * The full name of the customer
+                 * @example "Gavin Belson"
+                 */
+                name?: string;
+                /**
+                 * The currency of the invoice.
+                 * @example "EUR"
+                 */
+                currency?: Currency;
+                /** 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;
+                /**
+                 * The state of the customer's billing address
+                 * @example "CA"
+                 */
+                state?: string;
+                /**
+                 * The tax identification number of the customer
+                 * @example "EU123456789"
+                 */
+                tax_identification_number?: string;
+                /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
+                timezone?: Timezone;
+            };
+            /**
+             * The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+             * @example "startup"
+             */
+            plan_code?: string;
+            /**
+             * The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_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"
+             */
+            subscription_at?: string;
+            /**
+             * The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
+             * @example "anniversary"
+             */
+            billing_time?: "calendar" | "anniversary";
+            coupons?: {
+                /**
+                 * The name of the coupon.
+                 * @example "Startup Deal"
+                 */
+                name?: string;
+                /**
+                 * Unique code used to identify the coupon.
+                 * @example "startup_deal"
+                 */
+                code: string;
+                /**
+                 * The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.
+                 *
+                 * - If set to `fixed_amount`, the coupon represents a fixed amount discount.
+                 * - If set to `percentage`, the coupon represents a percentage-based discount.
+                 * @example "fixed_amount"
+                 */
+                coupon_type?: "fixed_amount" | "percentage";
+                /**
+                 * The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.
+                 * @example 5000
+                 */
+                amount_cents?: number | null;
+                /**
+                 * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+                 * @example "USD"
+                 */
+                amount_currency?: Currency | null;
+                /**
+                 * The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
+                 * @pattern ^[0-9]+.?[0-9]*$
+                 * @example null
+                 */
+                percentage_rate?: string | null;
+                /**
+                 * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
+                 * @example 6
+                 */
+                frequency_duration?: number | null;
+            }[];
+            subscriptions?: {
+                external_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -6637,6 +6778,124 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             external_customer_id?: string;
         }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
     };
+    payments: {
+        /**
+         * @description This endpoint is used to create a manual payment
+         *
+         * @tags payments
+         * @name CreatePayment
+         * @summary Create a payment
+         * @request POST:/payments
+         * @secure
+         */
+        createPayment: (data: {
+            payment: {
+                /**
+                 * Unique identifier assigned to the invoice
+                 * @example "486b147a-02a1-4ccf-8603-f3541fc25e7a"
+                 */
+                invoice_id: string;
+                /**
+                 * The payment amount in cents
+                 * @example 100
+                 */
+                amount_cents: number;
+                /**
+                 * Reference for the payment
+                 * @example "ref1"
+                 */
+                reference: string;
+                /**
+                 * The date the payment was made
+                 * @format date
+                 * @example "2025-02-20"
+                 */
+                paid_at?: string;
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment: {
+                /**
+                 * The unique identifier of the payment, created by Lago.
+                 * @format uuid
+                 * @example "4cf085a7-c196-4f07-a543-97c50ec6e8b2"
+                 */
+                lago_id?: string;
+                /** List of invoice IDs associated with the payment. */
+                invoice_ids?: string[];
+                /**
+                 * The amount of the payment in cents.
+                 * @example 100
+                 */
+                amount_cents?: number;
+                /**
+                 * The currency of the payment amount.
+                 * @example "USD"
+                 */
+                amount_currency?: string;
+                /**
+                 * The current status of the payment.
+                 * @example "succeeded"
+                 */
+                payment_status?: string;
+                /**
+                 * The type of payment.
+                 * @example "manual"
+                 */
+                type?: string;
+                /**
+                 * Reference for the payment.
+                 * @example "ref1"
+                 */
+                reference?: string;
+                /**
+                 * External identifier for the payment (if applicable).
+                 * @example null
+                 */
+                external_payment_id?: string | null;
+                /**
+                 * Timestamp when the payment was created.
+                 * @format date-time
+                 * @example "2025-02-20T00:00:00Z"
+                 */
+                created_at?: string;
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all payments
+         *
+         * @tags payments
+         * @name FindAllPayments
+         * @summary List all payments
+         * @request GET:/payments
+         * @secure
+         */
+        findAllPayments: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+            /**
+             * 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.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_invoice_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payments: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
@@ -6982,6 +7241,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createWalletTransaction: (data: WalletTransactionCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to retrieve a specific wallet transactions.
+         *
+         * @tags wallets
+         * @name FindWalletTransaction
+         * @summary Retrieve a wallet transaction
+         * @request GET:/wallet_transactions/{lago_id}
+         * @secure
+         */
+        findWalletTransaction: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionObject, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     webhooks: {
         /**

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.20.0
+ * @version 1.22.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -727,11 +727,11 @@ class Api extends HttpClient {
          * @tags customers
          * @name FindCustomer
          * @summary Retrieve a customer
-         * @request GET:/customers/{external_id}
+         * @request GET:/customers/{external_customer_id}
          * @secure
          */
-        findCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        findCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "GET",
             secure: true,
             format: "json",
@@ -743,11 +743,11 @@ class Api extends HttpClient {
          * @tags customers
          * @name DestroyCustomer
          * @summary Delete a customer
-         * @request DELETE:/customers/{external_id}
+         * @request DELETE:/customers/{external_customer_id}
          * @secure
          */
-        destroyCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        destroyCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "DELETE",
             secure: true,
             format: "json",
@@ -1159,6 +1159,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for generating invoice preview.
+         *
+         * @tags invoices
+         * @name InvoicePreview
+         * @summary Create an invoice preview
+         * @request POST:/invoices/preview
+         * @secure
+         */
+        invoicePreview: (data, params = {}) => this.request({
+            path: `/invoices/preview`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -1248,6 +1266,43 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    payments = {
+        /**
+         * @description This endpoint is used to create a manual payment
+         *
+         * @tags payments
+         * @name CreatePayment
+         * @summary Create a payment
+         * @request POST:/payments
+         * @secure
+         */
+        createPayment: (data, params = {}) => this.request({
+            path: `/payments`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all payments
+         *
+         * @tags payments
+         * @name FindAllPayments
+         * @summary List all payments
+         * @request GET:/payments
+         * @secure
+         */
+        findAllPayments: (query, params = {}) => this.request({
+            path: `/payments`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
@@ -1667,6 +1722,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used to retrieve a specific wallet transactions.
+         *
+         * @tags wallets
+         * @name FindWalletTransaction
+         * @summary Retrieve a wallet transaction
+         * @request GET:/wallet_transactions/{lago_id}
+         * @secure
+         */
+        findWalletTransaction: (lagoId, params = {}) => this.request({
+            path: `/wallet_transactions/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     webhooks = {
         /**