lago-javascript-client 1.17.0 → 1.18.0

package/esm/openapi/client.d.ts

@@ -373,7 +373,7 @@ export interface BaseAppliedTax {
     created_at?: string;
 }
 export interface BillableMetric {
-    billable_metric: BillableMetricObjectExtended;
+    billable_metric: BillableMetricObject;
 }
 export interface BillableMetricObject {
     /**
@@ -443,42 +443,7 @@ export interface BillableMetricObject {
      */
     weighted_interval?: "seconds" | null;
     filters?: BillableMetricFilterObject[];
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    active_subscriptions_count: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @deprecated
-     * @example 10
-     */
-    draft_invoices_count: number;
-    /**
-     * Number of plans using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    plans_count: number;
 }
-export type BillableMetricObjectExtended = BillableMetricObject & {
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @example 4
-     */
-    active_subscriptions_count?: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @example 10
-     */
-    draft_invoices_count?: number;
-    /**
-     * Number of plans using this billable metric.
-     * @example 4
-     */
-    plans_count?: number;
-};
 export interface BillableMetricBaseInput {
     /**
      * Name of the billable metric.
@@ -1050,7 +1015,7 @@ export interface CouponObject {
      * @format date-time
      * @example "2022-08-08T23:59:59Z"
      */
-    terminated_at?: string;
+    terminated_at?: string | null;
 }
 export interface CouponsPaginated {
     coupons: CouponObject[];
@@ -1889,6 +1854,16 @@ export interface CustomerCreateInput {
              */
             display_in_invoice: boolean;
         }[];
+        /**
+         * Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default
+         * @example false
+         */
+        skip_invoice_custom_sections?: boolean;
+        /**
+         * List of unique codes identifying the invoice custom sections.
+         * @example ["eu_bank_details"]
+         */
+        invoice_custom_section_codes?: string[];
     };
 }
 /** Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
@@ -2064,6 +2039,11 @@ export type CustomerObject = {
      * @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. */
@@ -2076,6 +2056,57 @@ export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
     taxes?: TaxObject[];
+    /** The customer’s invoice custom section used for generating invoices. */
+    applicable_invoice_custom_sections?: {
+        /**
+         * Unique identifier for the invoice custom section in the Lago application, generated by Lago to ensure record uniqueness within the system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string;
+        /**
+         * Name of the invoice custom section.
+         * @example "EU Bank Details"
+         */
+        name: string;
+        /**
+         * Unique code identifying the invoice custom section for the API request.
+         * @example "eu_bank_details"
+         */
+        code: string;
+        /**
+         * Internal description of the invoice custom section.
+         * @example "This section contains the bank details for EU customers."
+         */
+        description?: string;
+        /**
+         * The value shown on the invoice PDF.
+         * @example "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143"
+         */
+        details?: string;
+        /**
+         * The name of the invoice custom section displayed on the invoice.
+         * @example "Bank Details:"
+         */
+        display_name?: string;
+        /**
+         * Set to true if the invoice custom section is a default for the organization.
+         * @example true
+         */
+        applied_to_organization?: boolean;
+        /**
+         * Unique identifier for the organization associated with the invoice custom section.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        organization_id?: string;
+        /**
+         * Creation date of the tax.
+         * @format date-time
+         * @example "2023-07-06T14:35:58Z"
+         */
+        created_at?: string;
+    }[];
 };
 export interface CustomerPastUsage {
     usage_periods: CustomerUsage[];
@@ -3008,14 +3039,15 @@ export type InvoiceObject = {
      */
     invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
-     * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
+     * The status of the invoice. It indicates the current state of the invoice and can have following values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `pending`: the invoice remains pending until the taxes are fetched from the external provider.
      * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided" | "failed";
+    status: "draft" | "finalized" | "voided" | "failed" | "pending";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -3090,6 +3122,18 @@ export type InvoiceObject = {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+    /**
+     * The date of the invoice creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the invoice object was created
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date of the invoice update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the invoice object was updated
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at: string;
 } & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
@@ -3943,16 +3987,6 @@ export interface PlanObject {
      * @example null
      */
     bill_charges_monthly?: boolean | null;
-    /**
-     * The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted.
-     * @example 0
-     */
-    active_subscriptions_count: number;
-    /**
-     * The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted.
-     * @example 0
-     */
-    draft_invoices_count: number;
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
@@ -4112,7 +4146,7 @@ export interface SubscriptionObject {
      * @format date-time
      * @example "2022-10-08T00:00:00Z"
      */
-    ending_at?: string;
+    ending_at?: string | null;
     /**
      * 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
@@ -4237,26 +4271,6 @@ export interface TaxObject {
      * @example true
      */
     applied_to_organization: boolean;
-    /**
-     * Number of add-ons this tax is applied to.
-     * @example 0
-     */
-    add_ons_count?: number;
-    /**
-     * Number of charges this tax is applied to.
-     * @example 0
-     */
-    charges_count?: number;
-    /**
-     * Number of customers this tax is applied to (directly or via the organization's default).
-     * @example 0
-     */
-    customers_count: number;
-    /**
-     * Number of plans this tax is applied to.
-     * @example 0
-     */
-    plans_count?: number;
     /**
      * Creation date of the tax.
      * @format date-time
@@ -4623,7 +4637,7 @@ export interface WalletObject {
      */
     ongoing_balance_cents: number;
     /**
-     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage and draft invoices including taxes.
      * @example 200
      */
     ongoing_usage_balance_cents: number;
@@ -4634,7 +4648,7 @@ export interface WalletObject {
      */
     credits_ongoing_balance: string;
     /**
-     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage and draft invoices including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "2.0"
      */
@@ -4980,7 +4994,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.17.0
+ * @version 1.18.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5376,6 +5390,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Filter credit notes starting from a specific date.
+             * @format date
+             * @example "2022-07-08"
+             */
+            issuing_date_from?: string;
+            /**
+             * Filter credit notes up to a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            issuing_date_to?: string;
+            /**
+             * Search credit notes by id, number, customer name, customer external_id or customer email.
+             * @example "Jane"
+             */
+            search_term?: string;
+            /**
+             * Filter credit notes by currency. Possible values ISO 4217 currency codes.
+             * @example "EUR"
+             */
+            currency?: string;
+            /** Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`. */
+            reason?: "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "duplicated_charge" | "other";
+            /** Filter credit notes by credit status. Possible values are `available`, `consumed`  or `voided`. */
+            credit_status?: "available" | "consumed" | "voided";
+            /** Filter credit notes by refund status. Possible values are `pending`, `succeeded`  or `failed`. */
+            refund_status?: "pending" | "succeeded" | "failed";
+            /**
+             * Filter credit notes by their related invoice number.
+             * @example "INV-001-002"
+             */
+            invoice_number?: string;
+            /**
+             * Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 9000
+             */
+            amount_from?: number;
+            /**
+             * Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 100000
+             */
+            amount_to?: number;
         }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint updates an existing credit note.
@@ -5713,6 +5770,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_subscription_id?: string;
+            /**
+             * Filter results by event transaction ID
+             * @example "et_12345678"
+             */
+            event_transaction_id?: string;
             /** Filter results by fee's currency. */
             currency?: Currency;
             /**
@@ -5873,7 +5935,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             search_term?: string;
             /**
-             * Filter invoices by currency in. Possible values ISO 4217 currency codes.
+             * Filter invoices by currency. Possible values ISO 4217 currency codes.
              * @example "EUR"
              */
             currency?: string;

package/esm/openapi/client.js

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

package/package.json

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

package/script/openapi/client.d.ts

@@ -373,7 +373,7 @@ export interface BaseAppliedTax {
     created_at?: string;
 }
 export interface BillableMetric {
-    billable_metric: BillableMetricObjectExtended;
+    billable_metric: BillableMetricObject;
 }
 export interface BillableMetricObject {
     /**
@@ -443,42 +443,7 @@ export interface BillableMetricObject {
      */
     weighted_interval?: "seconds" | null;
     filters?: BillableMetricFilterObject[];
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    active_subscriptions_count: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @deprecated
-     * @example 10
-     */
-    draft_invoices_count: number;
-    /**
-     * Number of plans using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    plans_count: number;
 }
-export type BillableMetricObjectExtended = BillableMetricObject & {
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @example 4
-     */
-    active_subscriptions_count?: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @example 10
-     */
-    draft_invoices_count?: number;
-    /**
-     * Number of plans using this billable metric.
-     * @example 4
-     */
-    plans_count?: number;
-};
 export interface BillableMetricBaseInput {
     /**
      * Name of the billable metric.
@@ -1050,7 +1015,7 @@ export interface CouponObject {
      * @format date-time
      * @example "2022-08-08T23:59:59Z"
      */
-    terminated_at?: string;
+    terminated_at?: string | null;
 }
 export interface CouponsPaginated {
     coupons: CouponObject[];
@@ -1889,6 +1854,16 @@ export interface CustomerCreateInput {
              */
             display_in_invoice: boolean;
         }[];
+        /**
+         * Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default
+         * @example false
+         */
+        skip_invoice_custom_sections?: boolean;
+        /**
+         * List of unique codes identifying the invoice custom sections.
+         * @example ["eu_bank_details"]
+         */
+        invoice_custom_section_codes?: string[];
     };
 }
 /** Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
@@ -2064,6 +2039,11 @@ export type CustomerObject = {
      * @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. */
@@ -2076,6 +2056,57 @@ export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
     taxes?: TaxObject[];
+    /** The customer’s invoice custom section used for generating invoices. */
+    applicable_invoice_custom_sections?: {
+        /**
+         * Unique identifier for the invoice custom section in the Lago application, generated by Lago to ensure record uniqueness within the system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string;
+        /**
+         * Name of the invoice custom section.
+         * @example "EU Bank Details"
+         */
+        name: string;
+        /**
+         * Unique code identifying the invoice custom section for the API request.
+         * @example "eu_bank_details"
+         */
+        code: string;
+        /**
+         * Internal description of the invoice custom section.
+         * @example "This section contains the bank details for EU customers."
+         */
+        description?: string;
+        /**
+         * The value shown on the invoice PDF.
+         * @example "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143"
+         */
+        details?: string;
+        /**
+         * The name of the invoice custom section displayed on the invoice.
+         * @example "Bank Details:"
+         */
+        display_name?: string;
+        /**
+         * Set to true if the invoice custom section is a default for the organization.
+         * @example true
+         */
+        applied_to_organization?: boolean;
+        /**
+         * Unique identifier for the organization associated with the invoice custom section.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        organization_id?: string;
+        /**
+         * Creation date of the tax.
+         * @format date-time
+         * @example "2023-07-06T14:35:58Z"
+         */
+        created_at?: string;
+    }[];
 };
 export interface CustomerPastUsage {
     usage_periods: CustomerUsage[];
@@ -3008,14 +3039,15 @@ export type InvoiceObject = {
      */
     invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
-     * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
+     * The status of the invoice. It indicates the current state of the invoice and can have following values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `pending`: the invoice remains pending until the taxes are fetched from the external provider.
      * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided" | "failed";
+    status: "draft" | "finalized" | "voided" | "failed" | "pending";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -3090,6 +3122,18 @@ export type InvoiceObject = {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+    /**
+     * The date of the invoice creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the invoice object was created
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date of the invoice update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the invoice object was updated
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at: string;
 } & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
@@ -3943,16 +3987,6 @@ export interface PlanObject {
      * @example null
      */
     bill_charges_monthly?: boolean | null;
-    /**
-     * The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted.
-     * @example 0
-     */
-    active_subscriptions_count: number;
-    /**
-     * The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted.
-     * @example 0
-     */
-    draft_invoices_count: number;
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
@@ -4112,7 +4146,7 @@ export interface SubscriptionObject {
      * @format date-time
      * @example "2022-10-08T00:00:00Z"
      */
-    ending_at?: string;
+    ending_at?: string | null;
     /**
      * 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
@@ -4237,26 +4271,6 @@ export interface TaxObject {
      * @example true
      */
     applied_to_organization: boolean;
-    /**
-     * Number of add-ons this tax is applied to.
-     * @example 0
-     */
-    add_ons_count?: number;
-    /**
-     * Number of charges this tax is applied to.
-     * @example 0
-     */
-    charges_count?: number;
-    /**
-     * Number of customers this tax is applied to (directly or via the organization's default).
-     * @example 0
-     */
-    customers_count: number;
-    /**
-     * Number of plans this tax is applied to.
-     * @example 0
-     */
-    plans_count?: number;
     /**
      * Creation date of the tax.
      * @format date-time
@@ -4623,7 +4637,7 @@ export interface WalletObject {
      */
     ongoing_balance_cents: number;
     /**
-     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage and draft invoices including taxes.
      * @example 200
      */
     ongoing_usage_balance_cents: number;
@@ -4634,7 +4648,7 @@ export interface WalletObject {
      */
     credits_ongoing_balance: string;
     /**
-     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage and draft invoices including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "2.0"
      */
@@ -4980,7 +4994,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.17.0
+ * @version 1.18.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5376,6 +5390,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Filter credit notes starting from a specific date.
+             * @format date
+             * @example "2022-07-08"
+             */
+            issuing_date_from?: string;
+            /**
+             * Filter credit notes up to a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            issuing_date_to?: string;
+            /**
+             * Search credit notes by id, number, customer name, customer external_id or customer email.
+             * @example "Jane"
+             */
+            search_term?: string;
+            /**
+             * Filter credit notes by currency. Possible values ISO 4217 currency codes.
+             * @example "EUR"
+             */
+            currency?: string;
+            /** Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`. */
+            reason?: "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "duplicated_charge" | "other";
+            /** Filter credit notes by credit status. Possible values are `available`, `consumed`  or `voided`. */
+            credit_status?: "available" | "consumed" | "voided";
+            /** Filter credit notes by refund status. Possible values are `pending`, `succeeded`  or `failed`. */
+            refund_status?: "pending" | "succeeded" | "failed";
+            /**
+             * Filter credit notes by their related invoice number.
+             * @example "INV-001-002"
+             */
+            invoice_number?: string;
+            /**
+             * Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 9000
+             */
+            amount_from?: number;
+            /**
+             * Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 100000
+             */
+            amount_to?: number;
         }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint updates an existing credit note.
@@ -5713,6 +5770,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_subscription_id?: string;
+            /**
+             * Filter results by event transaction ID
+             * @example "et_12345678"
+             */
+            event_transaction_id?: string;
             /** Filter results by fee's currency. */
             currency?: Currency;
             /**
@@ -5873,7 +5935,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             search_term?: string;
             /**
-             * Filter invoices by currency in. Possible values ISO 4217 currency codes.
+             * Filter invoices by currency. Possible values ISO 4217 currency codes.
              * @example "EUR"
              */
             currency?: string;

package/script/openapi/client.js

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