lago-javascript-client 1.31.0 → 1.32.0

package/esm/openapi/client.d.ts

@@ -1,5 +1,5 @@
 /** @example "USD" */
-export type Currency = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
+export type Currency = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
 /** @example "US" */
 export type Country = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
 /** @example "America/Los_Angeles" */
@@ -535,7 +535,7 @@ export interface BillingEntityUpdateInput {
      */
     eu_tax_management?: boolean;
     /**
-     * The base64 encoded logo image for the billing entity
+     * The base64 encoded logo image for the billing entity. Sending "null" will remove the logo, if any exist.
      * @format uri
      * @example "data:image/png;base64,..."
      */
@@ -670,7 +670,7 @@ export interface AddOnObject {
      * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
      * @example "Setup Fee (SF1)"
      */
-    invoice_display_name?: string;
+    invoice_display_name: string | null;
     /**
      * Unique code used to identify the add-on.
      * @example "setup_fee"
@@ -690,7 +690,7 @@ export interface AddOnObject {
      * The description of the add-on.
      * @example "Implementation fee for new customers."
      */
-    description?: string | null;
+    description: string | null;
     /**
      * The date and time when the add-on 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 add-on was initially created.
      * @format date-time
@@ -714,7 +714,7 @@ export interface AddOnBaseInput {
      * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
      * @example "Setup Fee (SF1)"
      */
-    invoice_display_name?: string;
+    invoice_display_name?: string | null;
     /**
      * Unique code used to identify the add-on.
      * @example "setup_fee"
@@ -907,12 +907,12 @@ export interface MrrObject {
      * The total amount of MRR, expressed in cents.
      * @example 50000
      */
-    amount_cents?: number;
+    amount_cents: number;
     /**
      * The currency of MRR analytics. Format must be ISO 4217.
      * @example "USD"
      */
-    currency?: Currency;
+    currency: Currency;
 }
 export interface Mrrs {
     mrrs: MrrObject[];
@@ -1562,6 +1562,11 @@ export interface CouponUpdateInput {
     coupon: CouponBaseInput;
 }
 export interface FeeAmountDetails {
+    /**
+     * The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.
+     * @example 10000
+     */
+    plan_amount_cents?: number;
     /** Graduated ranges, used for a `graduated` charge model. */
     graduated_ranges?: {
         /**
@@ -1790,6 +1795,49 @@ export type FeeAppliedTaxObject = BaseAppliedTax & {
      */
     lago_fee_id?: string;
 };
+export interface PricingUnitDetailsObject {
+    /**
+     * Unique identifier of the pricing unit, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_pricing_unit_id: string;
+    /**
+     * The code of the pricing unit.
+     * @example "credits"
+     */
+    pricing_unit_code: string;
+    /**
+     * The short name of the pricing unit. Will be used as currency name in the UI and PDFs.
+     * @example "CR"
+     */
+    short_name: string;
+    /**
+     * The amount in cents in the pricing unit.
+     * @example 200
+     */
+    amount_cents: number;
+    /**
+     * The precise amount in cents in the pricing unit.
+     * @example "200.0"
+     */
+    precise_amount_cents: string;
+    /**
+     * The unit amount in cents in the pricing unit.
+     * @example 100
+     */
+    unit_amount_cents: number;
+    /**
+     * The precise unit amount in the pricing unit.
+     * @example "100.0"
+     */
+    precise_unit_amount: string;
+    /**
+     * The conversion rate from pricing units to the plan's currency.
+     * @example "0.5"
+     */
+    conversion_rate: string;
+}
 export interface FeeObject {
     /**
      * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
@@ -2022,6 +2070,8 @@ export interface FeeObject {
     };
     /** List of fee applied taxes */
     applied_taxes?: FeeAppliedTaxObject[];
+    /** Details about the pricing unit used and amounts for this fee. */
+    pricing_unit_details?: object | null;
 }
 export interface CreditNoteItemObject {
     /**
@@ -2053,6 +2103,21 @@ export type CreditNoteAppliedTaxObject = BaseAppliedTax & {
     /** @example 100 */
     base_amount_cents?: number;
 };
+export interface CreditNoteErrorDetailsObject {
+    /**
+     * The credit note error details unique identifier, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The type of the error.
+     * @example "tax_error"
+     */
+    error_code: "not_provided" | "tax_error" | "tax_voiding_error" | "invoice_generation_error";
+    /** The details of the error. */
+    details: object;
+}
 export interface CreditNoteObject {
     /**
      * The credit note unique identifier, created by Lago.
@@ -2191,6 +2256,7 @@ export interface CreditNoteObject {
      * @example false
      */
     self_billed?: boolean;
+    error_details?: any[] | null;
 }
 export interface CreditNotesPaginated {
     credit_notes: CreditNoteObject[];
@@ -2310,6 +2376,11 @@ export interface CreditNoteEstimated {
          * @example 20
          */
         taxes_amount_cents: number;
+        /**
+         * The precise tax amount of the credit note, expressed in cents with decimal precision.
+         * @example 20.1
+         */
+        precise_taxes_amount_cents: number;
         /**
          * The tax rate associated with this specific credit note.
          * @example 20
@@ -2335,6 +2406,11 @@ export interface CreditNoteEstimated {
          * @example 20
          */
         coupons_adjustment_amount_cents: number;
+        /**
+         * The precise pro-rated amount with decimal precision of the coupons applied to the source invoice.
+         * @example 20.1
+         */
+        precise_coupons_adjustment_amount_cents: number;
         /** Array of credit note's items. */
         items: {
             /**
@@ -2686,33 +2762,43 @@ export interface IntegrationCustomer {
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_id?: string;
+    lago_id: string;
     /**
      * The integration type used for accounting and tax syncs.
      * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite" | "anrok";
+    type: "netsuite" | "anrok" | "xero" | "hubspot" | "salesforce";
     /**
      * Unique code used to identify an integration connection.
      * @example "netsuite-eu-1"
      */
-    integration_code?: string;
+    integration_code: string;
     /**
      * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
      * @example "cus_12345"
      */
-    external_customer_id?: string;
+    external_customer_id: string;
     /**
      * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
      * @example true
      */
-    sync_with_provider?: boolean;
+    sync_with_provider?: boolean | null;
     /**
      * This optional field is needed only when working with `netsuite` connection.
      * @example "2"
      */
     subsidiary_id?: string;
+    /**
+     * This optional field is present only when working with `hubspot` connection.
+     * @example "contacts"
+     */
+    targeted_object?: string | null;
+    /**
+     * This optional field is present only when working with `hubspot` connection.
+     * @example "dinesh@piedpiper.test"
+     */
+    email?: string | null;
 }
 export type CustomerObject = CustomerBaseObject & {
     integration_customers?: IntegrationCustomer[];
@@ -2933,6 +3019,24 @@ export interface CustomerCreateInput {
 export interface Customer {
     customer: CustomerObjectExtended;
 }
+/** Details about the pricing unit used for charge usage. */
+export interface UsagePricingUnitDetailsObject {
+    /**
+     * The amount in cents in the pricing unit.
+     * @example 200
+     */
+    amount_cents: number;
+    /**
+     * The short name of the pricing unit.
+     * @example "CR"
+     */
+    short_name: string;
+    /**
+     * The conversion rate from pricing units to the plan's currency.
+     * @example "0.5"
+     */
+    conversion_rate: string;
+}
 /** Array of filter object, representing multiple dimensions for a charge item. */
 export type CustomerChargeFiltersUsageObject = {
     /**
@@ -2956,6 +3060,8 @@ export type CustomerChargeFiltersUsageObject = {
      * @example "AWS eu-east-1"
      */
     invoice_display_name?: string;
+    /** Details about the pricing unit used for charge usage. */
+    pricing_unit_details?: UsagePricingUnitDetailsObject;
     /**
      * List of filter values applied to the usage.
      * @example {"region":"us-east-1"}
@@ -2980,6 +3086,8 @@ export type CustomerChargeGroupedUsageObject = {
      * @example "0.9"
      */
     units?: string;
+    /** Details about the pricing unit used for charge usage. */
+    pricing_unit_details?: UsagePricingUnitDetailsObject;
     /** Key value list of event properties aggregated by the charge model */
     grouped_by?: Record<string, string>;
     /** Array of filter object, representing multiple dimensions for a charge item. */
@@ -3007,6 +3115,8 @@ export interface CustomerChargeUsageObject {
      * @example "EUR"
      */
     amount_currency: Currency;
+    /** Details about the pricing unit used for charge usage. */
+    pricing_unit_details?: UsagePricingUnitDetailsObject;
     /** Object listing all the properties for a specific charge item. */
     charge: {
         /**
@@ -3242,17 +3352,32 @@ export interface EventInputObject {
      * This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
      * @example {"gb":10}
      */
-    properties?: Record<string, string | number>;
+    properties?: object | null;
 }
 export interface EventInput {
     event: EventInputObject;
 }
-export interface Event {
-    event: EventObject;
+export interface EventCreated {
+    event: EventObject & {
+        /**
+         * The value will always be null in this response as the event processing is done asynchronously
+         * @example null
+         */
+        lago_customer_id?: null;
+    };
 }
 export interface EventBatchInput {
     events: EventInputObject[];
 }
+export interface EventsCreated {
+    events: (EventObject & {
+        /**
+         * The value will always be null in this response as the event processing is done asynchronously
+         * @example null
+         */
+        lago_customer_id?: null;
+    })[];
+}
 export interface EventEstimateFeesInput {
     event: {
         /**
@@ -3272,6 +3397,215 @@ export interface EventEstimateFeesInput {
 export interface Fees {
     fees: FeeObject[];
 }
+export interface EventEstimateInstantFeesInput {
+    event: {
+        /**
+         * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
+         * @example "storage"
+         */
+        code: string;
+        /**
+         * The unique identifier of the subscription within your application.
+         * @example "sub_1234567890"
+         */
+        external_subscription_id: string;
+        /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
+        properties?: object;
+        /**
+         * This field represents a unique identifier for the event.
+         * @example "transaction_1234567890"
+         */
+        transaction_id?: string | null;
+    };
+}
+export interface FeeEstimateObject {
+    lago_id?: null;
+    /**
+     * Unique identifier assigned to the charge that the fee belongs to
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_charge_id?: string;
+    /**
+     * Unique identifier assigned to the charge filter that the fee belongs to
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_charge_filter_id?: string | null;
+    lago_invoice_id?: null;
+    lago_true_up_fee_id?: null;
+    lago_true_up_parent_fee_id?: null;
+    /**
+     * Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_subscription_id?: string;
+    /**
+     * Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_customer_id?: string;
+    /**
+     * Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.
+     * @example "external_id"
+     */
+    external_customer_id?: string;
+    /**
+     * Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.
+     * @example "external_id"
+     */
+    external_subscription_id?: string;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes.
+     * @example 100
+     */
+    amount_cents: number;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes, with precision.
+     * @example 1.0001
+     */
+    precise_amount?: number;
+    /**
+     * The cost of this specific fee, including any applicable taxes, with precision.
+     * @example 1.0212
+     */
+    precise_total_amount?: number;
+    /**
+     * 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.
+     * @example 0
+     */
+    taxes_amount_cents: number;
+    /**
+     * The cost of the tax associated with this specific fee, with precision.
+     * @example 0
+     */
+    taxes_precise_amount?: number;
+    /**
+     * The tax rate associated with this specific fee.
+     * @example 20
+     */
+    taxes_rate: number;
+    /**
+     * The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer.
+     * @example "0.32"
+     */
+    units: string;
+    description?: null;
+    /**
+     * The unit amount of the fee per unit, with precision.
+     * @example 312.5
+     */
+    precise_unit_amount: number;
+    /**
+     * The coupon amount applied to the estimated instant fee. It will always returns 0
+     * @example "0.0"
+     */
+    precise_coupons_amount_cents?: string;
+    /**
+     * The cost of this specific fee, including any applicable taxes.
+     * @example 120
+     */
+    total_amount_cents: number;
+    /**
+     * 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.
+     * @example 1
+     */
+    events_count?: number;
+    /**
+     * Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where `true` represents that the fee was paid in advance (straightaway), and `false` indicates that the fee was not paid in arrears (at the end of the period).
+     * @example true
+     */
+    pay_in_advance: boolean;
+    /**
+     * Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where `true` represents that the fee was included on the invoice, and `false` indicates that the fee was not included on the invoice.
+     * @example true
+     */
+    invoiceable: boolean;
+    /**
+     * Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The value will always `pending`.
+     * @example "pending"
+     */
+    payment_status: "pending";
+    created_at?: null;
+    succeeded_at?: null;
+    failed_at?: null;
+    refunded_at?: null;
+    /**
+     * Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`).
+     * @example "transaction_1234567890"
+     */
+    event_transaction_id?: string;
+    amount_details?: null;
+    /** Item attached to the fee */
+    item: {
+        /**
+         * The fee type. The value will be `charge`.
+         * @example "charge"
+         */
+        type: "charge";
+        /**
+         * The code of the fee item. It will be the code of the `billable_metric`.
+         * @example "startup"
+         */
+        code: string;
+        /**
+         * The name of the fee item. It will be the name of the `billable_metric`.
+         * @example "Startup"
+         */
+        name: string;
+        /**
+         * The description of the fee item. It will be the name of the `billable_metric`.
+         * @example "Startup description"
+         */
+        description?: string;
+        /**
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
+         * @example "Setup Fee (SF1)"
+         */
+        invoice_display_name?: string;
+        /**
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, the actual charge filter values will be used as the default display name.
+         * @example "AWS eu-east-1"
+         */
+        filter_invoice_display_name?: string | null;
+        /** Key value list of event properties */
+        filters?: object | null;
+        /**
+         * Unique identifier of the fee item, created by Lago. It will be the identifier of the `billable_metric`.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_item_id: string;
+        /**
+         * The type of the fee item. Values is `BillableMetric`.
+         * @example "BillableMetric"
+         */
+        item_type: "BillableMetric";
+        /** Key value list of event properties aggregated by the charge model */
+        grouped_by?: Record<string, string>;
+    };
+}
+export interface FeesEstimate {
+    fees: FeeEstimateObject[];
+}
+export interface EventBatchEstimateInstantFeesInput {
+    events: EventEstimateInstantFeesInput[];
+}
+export interface Event {
+    event: EventObject;
+}
 export type FeesPaginated = Fees & {
     meta: PaginationMeta;
 };
@@ -3461,7 +3795,7 @@ export interface BillingPeriodObject {
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_plan_id?: string;
+    lago_plan_id: string;
     /**
      * The beginning date of the subscription billing period. This field indicates the start date of the billing period associated with the subscription fee.
      * @format date-time
@@ -3540,7 +3874,7 @@ export interface UsageThresholdObject {
      * The display name of the usage threshold.
      * @example "Threshold 1"
      */
-    threshold_display_name?: string | null;
+    threshold_display_name: string | null;
     /**
      * The amount to reach to trigger a `progressive_billing` invoice.
      * @example 10000
@@ -3573,6 +3907,7 @@ export interface AppliedUsageThresholdObject {
     /**
      * The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard.
      * @format date-time
+     * @example "2025-03-31T12:31:44Z"
      */
     created_at: string;
     usage_threshold: UsageThresholdObject;
@@ -3583,7 +3918,7 @@ export type InvoiceObject = InvoiceBaseObject & {
     billing_periods?: BillingPeriodObject[];
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
-    applied_usage_thresholds?: any[] | null;
+    applied_usage_thresholds?: AppliedUsageThresholdObject[];
 };
 export interface InvoicesPaginated {
     invoices: InvoiceObject[];
@@ -3759,6 +4094,27 @@ export interface SubscriptionObject {
      * @example "2022-09-08T00:00:00Z"
      */
     current_billing_period_ending_at?: string | null;
+    /**
+     * When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default.
+     * This field allows you to control the behavior of the credit note generation:
+     *
+     * - `credit`: A credit note is generated for the unused subscription time. The unused amount is credited to the credit note wallet.
+     * - `skip`: No credit note is generated for the unused subscription time.
+     *
+     * _Note: This field is only applicable to pay-in-advance plans and will be `null` for pay-in-arrears plans._
+     * @example "credit"
+     */
+    on_termination_credit_note: "credit" | "skip";
+    /**
+     * When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage.
+     * This field allows you to control the behavior of the invoice generation:
+     *
+     * - `generate`: An invoice is generated for the unbilled usage.
+     * - `skip`: No invoice is generated for the unbilled usage.
+     * @default "generate"
+     * @example "generate"
+     */
+    on_termination_invoice: "generate" | "skip";
 }
 export interface ErrorDetailObject {
     /**
@@ -4704,7 +5060,7 @@ export interface ChargeObject {
      * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
      * @example "Setup"
      */
-    invoice_display_name?: string;
+    invoice_display_name: string | null;
     /**
      * The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
      * @format date-time
@@ -4717,12 +5073,12 @@ export interface ChargeObject {
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
      */
-    pay_in_advance?: boolean;
+    pay_in_advance: boolean;
     /**
      * This field specifies whether the charge should be included in a proper invoice. If set to `false`, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.
      * @example true
      */
-    invoiceable?: boolean;
+    invoiceable: boolean;
     /**
      * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
      * This field determines whether and when the charge fee should be included in
@@ -4731,7 +5087,7 @@ export interface ChargeObject {
      * consolidating all charge fees with a succeeded payment status.
      * @example "invoice"
      */
-    regroup_paid_fees?: "invoice";
+    regroup_paid_fees: "invoice";
     /**
      * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
      *
@@ -4740,18 +5096,31 @@ export interface ChargeObject {
      * - If not defined in the request, default value is `false`.
      * @example false
      */
-    prorated?: boolean;
+    prorated: boolean;
     /**
      * The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.
      * @example 1200
      */
-    min_amount_cents?: number;
+    min_amount_cents: number;
     /** List of all thresholds utilized for calculating the charge. */
-    properties?: ChargeProperties;
+    properties: ChargeProperties;
     /** List of filters used to apply differentiated pricing based on additional event properties. */
-    filters?: ChargeFilterObject[];
+    filters: ChargeFilterObject[];
     /** All taxes applied to the charge. */
     taxes?: TaxObject[];
+    /** The pricing unit applied to the charge. */
+    applied_pricing_unit?: {
+        /**
+         * The code of the pricing unit.
+         * @example "unit_code"
+         */
+        code: string;
+        /**
+         * The conversion rate from pricing units to the plan's currency.
+         * @example "0.5"
+         */
+        conversion_rate: string;
+    };
 }
 export interface PlanObject {
     /**
@@ -4819,7 +5188,7 @@ export interface PlanObject {
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
-     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
+     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"filters":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
@@ -4857,12 +5226,12 @@ export interface ChargeFilterInput {
      */
     invoice_display_name?: string | null;
     /** List of all thresholds utilized for calculating the charge. */
-    properties?: ChargeProperties;
+    properties: ChargeProperties;
     /**
      * List of possible filter values. The key and values must match one of the billable metric filters.
      * @example {"region":["us-east-1"]}
      */
-    values?: Record<string, string[]>;
+    values: Record<string, string[]>;
 }
 export interface UsageThresholdInput {
     /**
@@ -5009,6 +5378,21 @@ export interface PlanCreateInput {
              * @example ["french_standard_vat"]
              */
             tax_codes?: string[];
+            /** The pricing unit to apply to the charge. */
+            applied_pricing_unit?: {
+                /**
+                 * The code of the pricing unit.
+                 * @example "credits"
+                 */
+                code?: string;
+                /**
+                 * The conversion rate from pricing units to the plan's currency.
+                 * This rate determines how many currency units (in the plan's base currency) equal one pricing unit.
+                 * For example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.
+                 * @example "0.5"
+                 */
+                conversion_rate?: string;
+            };
         }[];
         /** List of usage thresholds to apply to the plan. */
         usage_thresholds?: UsageThresholdInput[];
@@ -5145,6 +5529,16 @@ export interface PlanUpdateInput {
              * @example ["french_standard_vat"]
              */
             tax_codes?: string[];
+            /** Updates the pricing unit conversion rate for this charge. Only applies if the charge has applied pricing unit. */
+            applied_pricing_unit?: {
+                /**
+                 * The conversion rate from pricing units to the plan's currency.
+                 * This rate determines how many currency units (in the plan's base currency) equal one pricing unit.
+                 * For example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50 USD.
+                 * @example "0.5"
+                 */
+                conversion_rate?: string;
+            };
         }[];
         /** List of usage thresholds to apply to the plan. */
         usage_thresholds?: UsageThresholdInput[];
@@ -5230,6 +5624,16 @@ export interface PlanOverridesObject {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Updates the pricing unit conversion rate for this charge. Only applies if the charge has applied pricing unit. */
+        applied_pricing_unit?: {
+            /**
+             * The conversion rate from pricing units to the plan's currency.
+             * This rate determines how many currency units (in the plan's base currency) equal one pricing unit.
+             * For example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50 USD.
+             * @example "0.5"
+             */
+            conversion_rate?: string;
+        };
     }[];
     /** List of usage thresholds applied to the subscription. */
     usage_thresholds?: UsageThresholdObject[];
@@ -5613,13 +6017,13 @@ export interface WalletRecurringTransactionRule {
      * @format date-time
      * @example "2022-08-08T00:00:00Z"
      */
-    started_at?: string;
+    started_at?: string | null;
     /**
      * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "200.0"
      */
-    target_ongoing_balance: string;
+    target_ongoing_balance: string | null;
     /**
      * The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created
      * @format date-time
@@ -5631,7 +6035,7 @@ export interface WalletRecurringTransactionRule {
      * @format date-time
      * @example "2023-09-30T23:59:59Z"
      */
-    expiration_at?: string;
+    expiration_at?: string | null;
     /**
      * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
      * @example false
@@ -5680,7 +6084,7 @@ export interface WalletObject {
      * The name of the wallet.
      * @example "Prepaid"
      */
-    name?: string;
+    name?: string | null;
     /**
      * The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.
      * @pattern ^[0-9]+.?[0-9]*$
@@ -5738,14 +6142,14 @@ export interface WalletObject {
      * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
      * @example false
      */
-    invoice_requires_successful_payment?: boolean;
+    invoice_requires_successful_payment: boolean;
     /** Set wallet limitations to fee types. */
     applies_to?: {
         /**
          * An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.
          * @example ["charge"]
          */
-        fee_types?: any[] | null;
+        fee_types?: ("charge" | "subscription" | "commitment")[];
     };
     /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
     recurring_transaction_rules?: WalletRecurringTransactionRule[];
@@ -5782,7 +6186,7 @@ export interface WalletCreateInput {
          * The name of the wallet.
          * @example "Prepaid"
          */
-        name?: string;
+        name?: string | null;
         /**
          * The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.
          * @pattern ^[0-9]+.?[0-9]*$
@@ -5826,12 +6230,7 @@ export interface WalletCreateInput {
          * This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.
          * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
          */
-        transaction_metadata?: {
-            /** The unique identifier for the attribute. */
-            key?: string;
-            /** The corresponding value for the key. */
-            value?: string;
-        }[];
+        transaction_metadata?: any[] | null;
         /** Set wallet limitations to fee types. */
         applies_to?: {
             /**
@@ -5841,74 +6240,7 @@ export interface WalletCreateInput {
             fee_types?: any[] | null;
         };
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
-        recurring_transaction_rules?: {
-            /**
-             * The number of paid credits used for recurring top-up.
-             * @pattern ^[0-9]+.?[0-9]*$
-             * @example "20.0"
-             */
-            paid_credits?: string | null;
-            /**
-             * The number of free granted credits used for recurring top-up.
-             * @pattern ^[0-9]+.?[0-9]*$
-             * @example "10.0"
-             */
-            granted_credits?: string | null;
-            /**
-             * The method used for recurring top-up. Possible values are `fixed` or `target`.
-             * @example "target"
-             */
-            method?: "fixed" | "target";
-            /**
-             * The trigger. Possible values are `interval` or `threshold`.
-             * @example "interval"
-             */
-            trigger: "interval" | "threshold";
-            /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is `interval`.
-             * @example "monthly"
-             */
-            interval?: "weekly" | "monthly" | "quarterly" | "yearly";
-            /**
-             * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
-             * @format date-time
-             * @example "2022-08-08T00:00:00Z"
-             */
-            started_at?: string;
-            /**
-             * The expiration date and time for this specific recurring transaction rule. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
-             * @format date-time
-             * @example "2023-09-30T23:59:59Z"
-             */
-            expiration_at?: string | null;
-            /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
-             * @pattern ^[0-9]+.?[0-9]*$
-             * @example "20.0"
-             */
-            threshold_credits?: string;
-            /**
-             * The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to `target`.
-             * @pattern ^[0-9]+.?[0-9]*$
-             * @example "200.0"
-             */
-            target_ongoing_balance?: string;
-            /**
-             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
-             * @example false
-             */
-            invoice_requires_successful_payment?: boolean;
-            /**
-             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
-             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
-             */
-            transaction_metadata?: {
-                /** The unique identifier for the attribute. */
-                key?: string;
-                /** The value associated with the key. */
-                value?: string;
-            }[];
-        }[];
+        recurring_transaction_rules?: any[] | null;
     };
 }
 export interface Wallet {
@@ -5966,19 +6298,19 @@ export interface WalletUpdateInput {
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
-            paid_credits?: string;
+            paid_credits?: string | null;
             /**
              * The number of free granted credits. Required only if there is no paid credits.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "10.0"
              */
-            granted_credits?: string;
+            granted_credits?: string | null;
             /**
              * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
              * @format date-time
              * @example "2022-08-08T00:00:00Z"
              */
-            started_at?: string;
+            started_at?: string | null;
             /**
              * The expiration date and time for this specific recurring transaction rule. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
              * @format date-time
@@ -6030,19 +6362,19 @@ export interface WalletTransactionCreateInput {
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
-        paid_credits?: string;
+        paid_credits?: string | null;
         /**
          * The number of free granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10.0"
          */
-        granted_credits?: string;
+        granted_credits?: string | null;
         /**
          * The number of voided credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "5.0"
          */
-        voided_credits?: string;
+        voided_credits?: string | null;
         /**
          * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
          * @example false
@@ -6052,12 +6384,7 @@ export interface WalletTransactionCreateInput {
          * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
          * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
          */
-        metadata?: {
-            /** The unique identifier for the attribute. */
-            key?: string;
-            /** The value associated with the key. */
-            value?: string;
-        }[];
+        metadata?: any[] | null;
     };
 }
 export interface WalletTransactionObject {
@@ -6079,10 +6406,10 @@ export interface WalletTransactionObject {
      */
     status: "pending" | "settled" | "failed";
     /**
-     * The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`. `threshold`
+     * The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`, `threshold`
      * @example "manual"
      */
-    source?: "manual" | "interval" | "threshold";
+    source: "manual" | "interval" | "threshold";
     /**
      * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
      * @example "purchased"
@@ -6125,13 +6452,13 @@ export interface WalletTransactionObject {
      * @format date-time
      * @example "2022-04-29T08:59:51Z"
      */
-    settled_at?: string;
+    settled_at?: string | null;
     /**
      * The date when the wallet transaction failed, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
      * @example "2022-04-29T08:59:51Z"
      */
-    failed_at?: string;
+    failed_at?: string | null;
     /**
      * The date of the wallet transaction creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -6435,8 +6762,8 @@ export interface EventErrorsObject {
      */
     status: number;
     /**
-     * HTTP error description. It will always be "Unprocessable Entity"
-     * @example "Unprocessable Entity"
+     * HTTP error description. It will always be "Unprocessable entity"
+     * @example "Unprocessable entity"
      */
     error: string;
     message: string | Record<string, any>;
@@ -6458,6 +6785,8 @@ export interface EventsErrorsObject {
      * @example ["transaction_1234567890"]
      */
     invalid_filter_values: string[];
+    /** @deprecated */
+    missing_group_key: string[];
 }
 export interface FeeTaxProviderErrorObject {
     /**
@@ -6645,9 +6974,6 @@ export interface WalletTransactionPaymentFailureObject {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
-export interface CreditNotes {
-    credit_notes: CreditNoteObject[];
-}
 export type CustomerPaymentProvidernErrorObject = CustomerPaymentProviderErrorObject;
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
@@ -6854,7 +7180,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/add_ons
          * @secure
          */
-        createAddOn: (data: AddOnCreateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createAddOn: (data: AddOnCreateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to list all existing add-ons.
          *
@@ -6875,7 +7201,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<AddOnsPaginated, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<AddOnsPaginated, ApiErrorUnauthorized | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to update an existing add-on.
          *
@@ -6885,7 +7211,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/add_ons/{code}
          * @secure
          */
-        updateAddOn: (code: string, data: AddOnUpdateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateAddOn: (code: string, data: AddOnUpdateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve a specific add-on.
          *
@@ -6895,7 +7221,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/add_ons/{code}
          * @secure
          */
-        findAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to delete an existing add-on.
          *
@@ -6905,7 +7231,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/add_ons/{code}
          * @secure
          */
-        destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
     };
     apiLogs: {
         /**
@@ -6952,9 +7278,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             "http_statuses[]"?: ("succeeded" | "failed" | number)[];
             /**
              * Filter results by API version
-             * @example ["v1"]
+             * @example "v1"
              */
-            "api_version[]"?: string[];
+            api_version?: string;
             /**
              * Filter results by the path of the request
              * @example "/billable_metrics/"
@@ -6995,7 +7321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 12
              */
             months?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<GrossRevenues, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<GrossRevenues, ApiErrorUnauthorized | ApiErrorForbidden>>;
         /**
          * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
          *
@@ -7056,7 +7382,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 12
              */
             months?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<Mrrs, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<Mrrs, ApiErrorUnauthorized | ApiErrorForbidden>>;
         /**
          * @description Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).
          *
@@ -7079,7 +7405,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 12
              */
             months?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<OverdueBalances, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<OverdueBalances, ApiErrorUnauthorized | ApiErrorForbidden>>;
     };
     appliedCoupons: {
         /**
@@ -7575,7 +7901,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/events
          * @secure
          */
-        createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<EventCreated, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used for retrieving all events.
          *
@@ -7618,7 +7944,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "2022-08-08T00:00:00Z"
              */
             timestamp_to?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<EventsPaginated, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<EventsPaginated, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorForbidden>>;
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -7628,7 +7954,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/events/batch
          * @secure
          */
-        createBatchEvents: (data: EventBatchInput, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createBatchEvents: (data: EventBatchInput, params?: RequestParams) => Promise<HttpResponse<EventsCreated, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges
          *
@@ -7638,7 +7964,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/events/estimate_fees
          * @secure
          */
-        eventEstimateFees: (data: EventEstimateFeesInput, params?: RequestParams) => Promise<HttpResponse<Fees, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        eventEstimateFees: (data: EventEstimateFeesInput, params?: RequestParams) => Promise<HttpResponse<Fees, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden | ApiErrorNotFound>>;
+        /**
+         * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges
+         *
+         * @tags events
+         * @name EventEstimateInstantFees
+         * @summary Estimate instant fees for a pay in advance charge
+         * @request POST:/events/estimate_instant_fees
+         * @secure
+         */
+        eventEstimateInstantFees: (data: EventEstimateInstantFeesInput, params?: RequestParams) => Promise<HttpResponse<FeesEstimate, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden | ApiErrorNotFound>>;
+        /**
+         * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges
+         *
+         * @tags events
+         * @name EventBatchEstimateInstantFees
+         * @summary Batch estimate instant fees for a pay in advance charge
+         * @request POST:/events/batch_estimate_instant_fees
+         * @secure
+         */
+        eventBatchEstimateInstantFees: (data: EventBatchEstimateInstantFeesInput, params?: RequestParams) => Promise<HttpResponse<FeesEstimate, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
          *
@@ -7648,7 +7994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/events/{transaction_id}
          * @secure
          */
-        findEvent: (transactionId: string, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findEvent: (transactionId: string, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
     };
     fees: {
         /**
@@ -8080,6 +8426,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.
+             * @example "pending"
+             */
+            payment_status?: "pending" | "failed" | "succeeded";
         }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
     };
     payments: {
@@ -8289,6 +8640,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             status?: string;
+            /**
+             * When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default.
+             * This field allows you to control the behavior of the credit note generation:
+             *
+             * - `credit`: A credit note is generated for the unused subscription time.
+             * - `skip`: No credit note is generated for the unused subscription time.
+             *
+             * _Note: This field is only applicable to pay-in-advance plans and is ignored for pay-in-arrears plans._
+             * @example "credit"
+             */
+            on_termination_credit_note?: "credit" | "skip";
+            /**
+             * When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage.
+             * This field allows you to control the behavior of the invoice generation:
+             *
+             * - `generate`: An invoice is generated for the unbilled usage.
+             * - `skip`: No invoice is generated for the unbilled usage.
+             * @example "generate"
+             */
+            on_termination_invoice?: "generate" | "skip";
         }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
          * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
@@ -8434,7 +8805,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/wallets
          * @secure
          */
-        createWallet: (data: WalletCreateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createWallet: (data: WalletCreateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to list all wallets with prepaid credits.
          *
@@ -8460,7 +8831,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id: string;
-        }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to update an existing wallet with prepaid credits.
          *
@@ -8470,7 +8841,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/wallets/{lago_id}
          * @secure
          */
-        updateWallet: (lagoId: string, data: WalletUpdateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateWallet: (lagoId: string, data: WalletUpdateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve an existing wallet with prepaid credits.
          *
@@ -8480,7 +8851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/wallets/{lago_id}
          * @secure
          */
-        findWallet: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findWallet: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to terminate an existing wallet with prepaid credits.
          *
@@ -8490,7 +8861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/wallets/{lago_id}
          * @secure
          */
-        destroyWallet: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
+        destroyWallet: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to list all wallet transactions.
          *
@@ -8526,7 +8897,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "inbound"
              */
             transaction_type?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<WalletTransactionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        }, params?: RequestParams) => Promise<HttpResponse<WalletTransactionsPaginated, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
     };
     walletTransactions: {
         /**
@@ -8538,7 +8909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/wallet_transactions
          * @secure
          */
-        createWalletTransaction: (data: WalletTransactionCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest>>;
+        createWalletTransaction: (data: WalletTransactionCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to retrieve a specific wallet transactions.
          *
@@ -8548,7 +8919,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/wallet_transactions/{lago_id}
          * @secure
          */
-        findWalletTransaction: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionObject, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findWalletTransaction: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionObject, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint generates a checkout link for a specific wallet transaction.
          *
@@ -8558,7 +8929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/wallet_transactions/{lago_id}/payment_url
          * @secure
          */
-        walletTransactionPaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionPaymentUrl, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        walletTransactionPaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WalletTransactionPaymentUrl, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorForbidden | ApiErrorNotFound>>;
     };
     webhooks: {
         /**