lago-javascript-client 1.16.0 → 1.18.0

package/script/openapi/client.d.ts

@@ -19,7 +19,10 @@ export interface AddOnBaseInput {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of the add-on. */
+    /**
+     * The currency of the add-on.
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The description of the add-on.
@@ -62,7 +65,10 @@ export interface AddOnObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of the add-on. */
+    /**
+     * The currency of the add-on.
+     * @example "USD"
+     */
     amount_currency: Currency;
     /**
      * The description of the add-on.
@@ -185,8 +191,11 @@ export interface AppliedCouponInput {
          * @example 2000
          */
         amount_cents?: number | null;
-        /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-        amount_currency?: Currency;
+        /**
+         * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+         * @example "EUR"
+         */
+        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]*$
@@ -244,8 +253,11 @@ export interface AppliedCouponObject {
      * @example 50
      */
     amount_cents_remaining?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "EUR"
+     */
+    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]*$
@@ -348,7 +360,10 @@ export interface BaseAppliedTax {
      * @example 2000
      */
     amount_cents?: number;
-    /** Currency of the tax */
+    /**
+     * Currency of the tax
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.
@@ -428,21 +443,6 @@ export interface BillableMetricObject {
      */
     weighted_interval?: "seconds" | null;
     filters?: BillableMetricFilterObject[];
-    /**
-     * 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 {
     /**
@@ -844,8 +844,11 @@ export interface CouponBaseInput {
      * @example 5000
      */
     amount_cents?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "USD"
+     */
+    amount_currency?: Currency | null;
     /**
      * Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.
      * @example false
@@ -937,8 +940,11 @@ export interface CouponObject {
      * @example 5000
      */
     amount_cents?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "USD"
+     */
+    amount_currency?: Currency | null;
     /**
      * Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.
      * @example true
@@ -1009,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[];
@@ -1058,7 +1064,10 @@ export interface CreditNoteEstimated {
          * @example "LAG-1234"
          */
         invoice_number: string;
-        /** The currency of the credit note. */
+        /**
+         * The currency of the credit note.
+         * @example "EUR"
+         */
         currency: Currency;
         /**
          * The tax amount of the credit note, expressed in cents.
@@ -1138,7 +1147,10 @@ export interface CreditNoteEstimated {
              * @example 2000
              */
             amount_cents?: number;
-            /** Currency of the tax */
+            /**
+             * Currency of the tax
+             * @example "USD"
+             */
             amount_currency?: Currency;
         }[];
     };
@@ -1155,7 +1167,10 @@ export interface CreditObject {
      * @example 1200
      */
     amount_cents: number;
-    /** The currency of the credit. */
+    /**
+     * The currency of the credit.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation
@@ -1221,7 +1236,10 @@ export interface CreditNoteItemObject {
      * @example 100
      */
     amount_cents: number;
-    /** The credit note's item currency. */
+    /**
+     * The credit note's item currency.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /** The fee object related to the credit note item. */
     fee: FeeObject;
@@ -1289,7 +1307,10 @@ export interface CreditNoteObject {
      * @example "Free text"
      */
     description?: string | null;
-    /** The currency of the credit note. */
+    /**
+     * The currency of the credit note.
+     * @example "EUR"
+     */
     currency: Currency;
     /**
      * The total amount of the credit note, expressed in cents.
@@ -1438,8 +1459,11 @@ export interface Address {
      * @example "Woodland Hills"
      */
     city?: string | null;
-    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-    country?: Country;
+    /**
+     * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+     * @example "US"
+     */
+    country?: Country | null;
     /**
      * The state of the customer's billing address
      * @example "CA"
@@ -1599,7 +1623,10 @@ export interface CustomerChargeUsageObject {
      * @example 123
      */
     amount_cents: number;
-    /** The currency of a usage item consumed by the customer. */
+    /**
+     * The currency of a usage item consumed by the customer.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /** Object listing all the properties for a specific charge item. */
     charge: {
@@ -1671,10 +1698,13 @@ export interface CustomerCreateInput {
          * @example "Woodland Hills"
          */
         city?: string | null;
-        /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-        country?: Country;
+        /**
+         * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+         * @example "US"
+         */
+        country?: Country | null;
         /** Currency of the customer. Format must be ISO 4217 */
-        currency?: Currency;
+        currency?: Currency | null;
         /**
          * The email of the customer
          * @format email
@@ -1738,7 +1768,7 @@ export interface CustomerCreateInput {
          */
         tax_identification_number?: string | null;
         /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
-        timezone?: Timezone;
+        timezone?: Timezone | null;
         /**
          * The custom website URL of the customer
          * @example "http://hooli.com"
@@ -1824,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 */
@@ -1895,10 +1935,16 @@ export type CustomerObject = {
      * @example "Woodland Hills"
      */
     city?: string | null;
-    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-    country?: Country;
-    /** Currency of the customer. Format must be ISO 4217 */
-    currency?: Currency;
+    /**
+     * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+     * @example "US"
+     */
+    country?: Country | null;
+    /**
+     * Currency of the customer. Format must be ISO 4217
+     * @example "USD"
+     */
+    currency?: Currency | null;
     /**
      * The email of the customer
      * @format email
@@ -1957,7 +2003,7 @@ export type CustomerObject = {
      */
     tax_identification_number?: string | null;
     /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
-    timezone?: Timezone;
+    timezone?: Timezone | null;
     /**
      * The custom website URL of the customer
      * @example "http://hooli.com"
@@ -1993,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. */
@@ -2005,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[];
@@ -2042,7 +2144,10 @@ export interface CustomerUsageObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_invoice_id?: string | null;
-    /** The currency of the customer's current usage. */
+    /**
+     * The currency of the customer's current usage.
+     * @example "EUR"
+     */
     currency?: Currency;
     /**
      * The amount in cents, tax excluded.
@@ -2271,7 +2376,10 @@ export interface FeeObject {
      * @example "1.0212"
      */
     precise_total_amount?: string;
-    /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
+    /**
+     * The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * The cost of the tax associated with this specific fee.
@@ -2303,7 +2411,10 @@ export interface FeeObject {
      * @example 120
      */
     total_amount_cents: number;
-    /** The currency of this specific fee, including any applicable taxes. */
+    /**
+     * The currency of this specific fee, including any applicable taxes.
+     * @example "EUR"
+     */
     total_amount_currency: Currency;
     /**
      * The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.
@@ -2610,7 +2721,10 @@ export interface GrossRevenueObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * Contains invoices count.
@@ -2770,7 +2884,10 @@ export interface MrrObject {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of MRR analytics. Format must be ISO 4217. */
+    /**
+     * The currency of MRR analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency?: Currency;
 }
 export interface Mrrs {
@@ -2813,7 +2930,10 @@ export interface InvoiceCollectionObject {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency?: Currency;
 }
 export interface InvoiceCollections {
@@ -2835,7 +2955,10 @@ export interface InvoicedUsageObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
 }
 export interface InvoicedUsages {
@@ -2916,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.
@@ -2932,7 +3056,10 @@ export type InvoiceObject = {
      * @example "succeeded"
      */
     payment_status: "pending" | "succeeded" | "failed";
-    /** The currency of the invoice issued. */
+    /**
+     * The currency of the invoice issued.
+     * @example "EUR"
+     */
     currency: Currency;
     /**
      * The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value.
@@ -2995,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;
@@ -3032,7 +3171,10 @@ export interface InvoiceOneOffCreateInput {
          * @example "hooli_1234"
          */
         external_customer_id: string;
-        /** The currency of the invoice. */
+        /**
+         * The currency of the invoice.
+         * @example "EUR"
+         */
         currency?: Currency;
         fees: {
             /**
@@ -3149,9 +3291,15 @@ export interface OrganizationObject {
      * @example ["https://webhook.brex.com","https://webhook2.brex.com"]
      */
     webhook_urls?: string[] | null;
-    /** The country of your organization. */
-    country?: Country;
-    /** The default currency of an organization. */
+    /**
+     * The country of your organization.
+     * @example "US"
+     */
+    country?: Country | null;
+    /**
+     * The default currency of an organization.
+     * @example "USD"
+     */
     default_currency?: Currency;
     /**
      * The first line of your organization's billing address.
@@ -3219,7 +3367,10 @@ export interface OrganizationObject {
      * @example "US123456789"
      */
     tax_identification_number?: string | null;
-    /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
+    /**
+     * Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
+     * @example "America/New_York"
+     */
     timezone?: Timezone;
     /** The custom billing settings for your organization. */
     billing_configuration: OrganizationBillingConfiguration;
@@ -3238,9 +3389,15 @@ export interface OrganizationUpdateInput {
          * @example "https://webhook.brex.com"
          */
         webhook_url?: string | null;
-        /** The country of your organization. */
-        country?: Country;
-        /** The default currency of an organization. */
+        /**
+         * The country of your organization.
+         * @example "US"
+         */
+        country?: Country | null;
+        /**
+         * The default currency of an organization.
+         * @example "USD"
+         */
         default_currency?: Currency;
         /**
          * The first line of your organization's billing address.
@@ -3308,7 +3465,10 @@ export interface OrganizationUpdateInput {
          * @example "US123456789"
          */
         tax_identification_number?: string | null;
-        /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
+        /**
+         * Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
+         * @example "America/New_York"
+         */
         timezone?: Timezone;
         /**
          * Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
@@ -3335,7 +3495,10 @@ export interface OverdueBalanceObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * The Lago invoice IDs associated with the revenue.
@@ -3391,7 +3554,10 @@ export interface PaymentRequestObject {
      * @example 100
      */
     amount_cents: number;
-    /** The currency of the payment request. */
+    /**
+     * The currency of the payment request.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * The status of the payment associated with the payment request. It can have one of the following values:
@@ -3450,7 +3616,10 @@ export interface PlanCreateInput {
          * @example 10000
          */
         amount_cents?: number;
-        /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+        /**
+         * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+         * @example "USD"
+         */
         amount_currency?: Currency;
         /**
          * The duration in days during which the base cost of the plan is offered for free.
@@ -3549,7 +3718,10 @@ export interface PlanOverridesObject {
      * @example 10000
      */
     amount_cents?: number;
-    /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+    /**
+     * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The description on the plan.
@@ -3646,7 +3818,10 @@ export interface PlanUpdateInput {
          * @example 10000
          */
         amount_cents?: number;
-        /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+        /**
+         * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+         * @example "USD"
+         */
         amount_currency?: Currency;
         /**
          * The duration in days during which the base cost of the plan is offered for free.
@@ -3792,7 +3967,10 @@ export interface PlanObject {
      * @example 10000
      */
     amount_cents: number;
-    /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+    /**
+     * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+     * @example "USD"
+     */
     amount_currency: Currency;
     /**
      * The duration in days during which the base cost of the plan is offered for free.
@@ -3809,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.
@@ -3978,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
@@ -4103,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
@@ -4209,7 +4357,10 @@ export interface WalletCreateInput {
          * @example "1.5"
          */
         rate_amount: string;
-        /** The currency of the wallet. */
+        /**
+         * The currency of the wallet.
+         * @example "USD"
+         */
         currency: Currency;
         /**
          * The number of paid credits. Required only if there is no granted credits.
@@ -4337,7 +4488,10 @@ export interface WalletObject {
      * @example "active"
      */
     status: "active" | "terminated";
-    /** The currency of the wallet. */
+    /**
+     * The currency of the wallet.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * The name of the wallet.
@@ -4483,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;
@@ -4494,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"
      */
@@ -4840,7 +4994,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.16.0
+ * @version 1.18.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5236,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.
@@ -5573,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;
             /**
@@ -5733,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;