lago-javascript-client 1.47.1 → 1.49.0

package/esm/openapi/client.d.ts

@@ -2030,6 +2030,16 @@ export interface PricingUnitDetailsObject {
      */
     conversion_rate: string;
 }
+/** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+export type PresentationBreakdownsObject = {
+    /** Key value list of event properties used for presentation grouping. */
+    presentation_by?: Record<string, string>;
+    /**
+     * The number of units consumed for a specific presentation group.
+     * @example "9.0"
+     */
+    units?: 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.
@@ -2313,6 +2323,8 @@ export interface FeeObject {
     applied_taxes?: FeeAppliedTaxObject[];
     /** Details about the pricing unit used and amounts for this fee. */
     pricing_unit_details?: object | null;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
 }
 export interface CreditNoteItemObject {
     /**
@@ -3505,54 +3517,6 @@ export interface InvoiceBaseObject {
      */
     updated_at: string;
 }
-export interface BillingPeriodObject {
-    /**
-     * Unique identifier assigned to the subscription, created by Lago.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_subscription_id: string;
-    /**
-     * Unique identifier assigned to the subscription in your application.
-     * @example "external_id"
-     */
-    external_subscription_id: string;
-    /**
-     * Unique identifier assigned to the plan, created by Lago.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    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
-     * @example "2022-04-29T08:59:51Z"
-     */
-    subscription_from_datetime: string;
-    /**
-     * The ending date of the subscription billing period. This field indicates the end date of the billing period associated with the subscription fee.
-     * @format date-time
-     * @example "2022-05-29T08:59:51Z"
-     */
-    subscription_to_datetime: string;
-    /**
-     * The beginning date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the start date of the billing period or subscription period associated with the fees.
-     * @format date-time
-     * @example "2022-04-29T08:59:51Z"
-     */
-    charges_from_datetime: string;
-    /**
-     * The ending date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the end date of the billing period or subscription period associated with the fees.
-     * @format date-time
-     * @example "2022-05-29T08:59:51Z"
-     */
-    charges_to_datetime: string;
-    /**
-     * The reason explaining why this subscription appears on the invoice.
-     * @example "subscription_starting"
-     */
-    invoicing_reason: "subscription_starting" | "subscription_periodic" | "subscription_terminating" | "in_advance_charge" | "in_advance_charge_periodic" | "progressive_billing";
-}
 export interface InvoiceMetadataObject {
     /**
      * Unique identifier assigned to the invoice metadata within the Lago application.
@@ -3677,7 +3641,6 @@ export interface AppliedUsageThresholdObject {
 export type InvoiceObject = InvoiceBaseObject & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
-    billing_periods?: BillingPeriodObject[];
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
     /** The invoice custom sections applied to this invoice for PDF generation. */
@@ -3899,6 +3862,11 @@ export interface SubscriptionObject {
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string;
+    /**
+     * The code of the billing entity associated with the subscription.
+     * @example "default"
+     */
+    billing_entity_code?: string;
     /**
      * The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
      * @example "anniversary"
@@ -4030,6 +3998,15 @@ export interface SubscriptionObject {
     applied_invoice_custom_sections?: AppliedInvoiceCustomSectionObject[];
     /** The payment method assigned to this subscription for processing payments. */
     payment_method?: PaymentMethodReference;
+    /**
+     * Controls whether this subscription is eligible to be grouped with other subscriptions of the same customer on a consolidated recurring invoice.
+     *
+     * - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).
+     * - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice, regardless of other grouping criteria.
+     * @default true
+     * @example true
+     */
+    consolidate_invoice?: boolean;
 }
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
@@ -4081,6 +4058,11 @@ export interface WalletRecurringTransactionRule {
      * @example "10.0"
      */
     granted_credits: string;
+    /**
+     * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
+     * @example false
+     */
+    grants_target_top_up: boolean | 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
@@ -4153,6 +4135,11 @@ export interface WalletObject {
      * @example "hooli_1234"
      */
     external_customer_id: string;
+    /**
+     * The code of the billing entity associated with the wallet.
+     * @example "default"
+     */
+    billing_entity_code?: string;
     /**
      * The status of the wallet. Possible values are `active` or `terminated`.
      * @example "active"
@@ -4359,6 +4346,11 @@ export interface WalletCreateInput {
          * @example "hooli_1234"
          */
         external_customer_id: string;
+        /**
+         * The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.
+         * @example "default"
+         */
+        billing_entity_code?: string;
         /**
          * The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
          * @format date-time
@@ -4451,6 +4443,11 @@ export interface WalletUpdateInput {
          * @example false
          */
         invoice_requires_successful_payment?: boolean;
+        /**
+         * The code of the billing entity associated with the wallet.
+         * @example "default"
+         */
+        billing_entity_code?: string;
         /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
         invoice_custom_section?: InvoiceCustomSectionInput;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
@@ -4494,6 +4491,11 @@ export interface WalletUpdateInput {
              * @example "10.0"
              */
             granted_credits?: string | null;
+            /**
+             * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
+             * @example false
+             */
+            grants_target_top_up?: boolean | 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
@@ -4784,6 +4786,8 @@ export type CustomerChargeFiltersUsageObject = {
      * @example {"region":["us-east-1"]}
      */
     values?: Record<string, string[]>;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
 }[];
 /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
 export type CustomerChargeGroupedUsageObject = {
@@ -4815,6 +4819,8 @@ export type CustomerChargeGroupedUsageObject = {
     grouped_by?: Record<string, string>;
     /** Array of filter object, representing multiple dimensions for a charge item. */
     filters?: CustomerChargeFiltersUsageObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
 }[];
 export interface CustomerChargeUsageObject {
     /**
@@ -4863,7 +4869,7 @@ export interface CustomerChargeUsageObject {
          * 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 related billable metric object. */
     billable_metric: {
@@ -4893,6 +4899,8 @@ export interface CustomerChargeUsageObject {
     filters?: CustomerChargeFiltersUsageObject;
     /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
     grouped_usage?: CustomerChargeGroupedUsageObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
 }
 export interface CustomerUsageObject {
     /**
@@ -4945,6 +4953,179 @@ export interface CustomerUsageObject {
 export interface CustomerUsage {
     customer_usage: CustomerUsageObject;
 }
+/** Array of filter object, representing multiple dimensions for a charge item. */
+export type CustomerProjectedChargeFiltersUsageObject = {
+    /**
+     * The number of units consumed for a specific charge filter related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The projected number of units that can be consumed for a specific charge filter related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.8"
+     */
+    projected_units?: string;
+    /**
+     * The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The projected amount in cents, tax excluded, that can be consumed for a specific charge filter related to a charge item.
+     * @example 2000
+     */
+    projected_amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * Specifies the name that will be displayed on an invoice.
+     * @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"]}
+     */
+    values?: Record<string, string[]>;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    projected_presentation_breakdowns?: PresentationBreakdownsObject;
+}[];
+/** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+export type CustomerProjectedChargeGroupedUsageObject = {
+    /**
+     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The projected amount in cents, tax excluded, that can be consumed for a specific group related to a charge item.
+     * @example 2000
+     */
+    projected_amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * The number of units consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The projected number of units that can be consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.8"
+     */
+    projected_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. */
+    filters?: CustomerProjectedChargeFiltersUsageObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    projected_presentation_breakdowns?: PresentationBreakdownsObject;
+}[];
+export interface CustomerProjectedChargeUsageObject {
+    /**
+     * The number of units consumed by the customer for a specific charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    units: string;
+    /**
+     * The projected number of units that can be consumed by the customer for a specific charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "2.0"
+     */
+    projected_units: string;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count: number;
+    /**
+     * The amount in cents, tax excluded, consumed by the customer for a specific charge item.
+     * @example 123
+     */
+    amount_cents: number;
+    /**
+     * The projected amount in cents, tax excluded, that can be consumed by the customer for a specific charge item.
+     * @example 256
+     */
+    projected_amount_cents: number;
+    /**
+     * The currency of a usage item consumed by the customer.
+     * @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: {
+        /**
+         * Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string;
+        /**
+         * The pricing model applied to this charge. Possible values are standard, `graduated`, `percentage`, `package` or `volume`.
+         * @example "graduated"
+         */
+        charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
+        /**
+         * 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;
+    };
+    /** The related billable metric object. */
+    billable_metric: {
+        /**
+         * Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string;
+        /**
+         * The name of the billable metric used for this charge.
+         * @example "Storage"
+         */
+        name: string;
+        /**
+         * The code of the billable metric used for this charge.
+         * @example "storage"
+         */
+        code: string;
+        /**
+         * The aggregation type of the billable metric used for this charge. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
+         * @example "sum_agg"
+         */
+        aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg" | "latest_agg";
+    };
+    /** Array of filter object, representing multiple dimensions for a charge item. */
+    filters?: CustomerProjectedChargeFiltersUsageObject;
+    /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+    grouped_usage?: CustomerProjectedChargeGroupedUsageObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    presentation_breakdowns?: PresentationBreakdownsObject;
+    /** Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation. */
+    projected_presentation_breakdowns?: PresentationBreakdownsObject;
+}
 export interface CustomerProjectedUsageObject {
     /**
      * The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).
@@ -4996,13 +5177,13 @@ export interface CustomerProjectedUsageObject {
      */
     total_amount_cents: number;
     /** Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage. */
-    charges_usage: CustomerChargeUsageObject[];
+    charges_usage: CustomerProjectedChargeUsageObject[];
 }
 export interface CustomerProjectedUsage {
     customer_projected_usage: CustomerProjectedUsageObject;
 }
 export interface CustomerPastUsage {
-    usage_periods: CustomerUsage[];
+    usage_periods: CustomerUsageObject[];
     meta: PaginationMeta;
 }
 export interface CustomerCheckoutUrl {
@@ -5457,6 +5638,11 @@ export interface InvoiceOneOffCreateInput {
          * @example "hooli_1234"
          */
         external_customer_id: string;
+        /**
+         * The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.
+         * @example "default"
+         */
+        billing_entity_code?: string;
         /**
          * The currency of the invoice.
          * @example "EUR"
@@ -5516,7 +5702,56 @@ export interface InvoiceOneOffCreateInput {
         payment_method?: PaymentMethodReference;
     };
 }
+export interface BillingPeriodObject {
+    /**
+     * Unique identifier assigned to the subscription, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_subscription_id: string;
+    /**
+     * Unique identifier assigned to the subscription in your application.
+     * @example "external_id"
+     */
+    external_subscription_id: string;
+    /**
+     * Unique identifier assigned to the plan, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    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
+     * @example "2022-04-29T08:59:51Z"
+     */
+    subscription_from_datetime: string;
+    /**
+     * The ending date of the subscription billing period. This field indicates the end date of the billing period associated with the subscription fee.
+     * @format date-time
+     * @example "2022-05-29T08:59:51Z"
+     */
+    subscription_to_datetime: string;
+    /**
+     * The beginning date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the start date of the billing period or subscription period associated with the fees.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    charges_from_datetime: string;
+    /**
+     * The ending date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the end date of the billing period or subscription period associated with the fees.
+     * @format date-time
+     * @example "2022-05-29T08:59:51Z"
+     */
+    charges_to_datetime: string;
+    /**
+     * The reason explaining why this subscription appears on the invoice.
+     * @example "subscription_starting"
+     */
+    invoicing_reason: "subscription_starting" | "subscription_periodic" | "subscription_terminating" | "in_advance_charge" | "in_advance_charge_periodic" | "progressive_billing";
+}
 export type InvoiceObjectExtended = InvoiceObject & {
+    billing_periods?: BillingPeriodObject[];
     credits?: CreditObject[];
     fees?: FeeObject[];
     subscriptions?: SubscriptionObject[];
@@ -5981,6 +6216,8 @@ export interface OrganizationObject {
      * @example false
      */
     finalize_zero_amount_invoice?: boolean;
+    /** @example "clickhouse" */
+    events_store?: "clickhouse" | "postgres";
 }
 export interface Organization {
     organization: OrganizationObject;
@@ -6262,6 +6499,23 @@ export interface ChargeProperties {
         per_unit_amount: string;
     }[];
 }
+export type ChargeObjectProperties = ChargeProperties & {
+    /**
+     * Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.
+     * @example [{"value":"region","options":{"display_in_invoice":true}}]
+     */
+    presentation_group_keys?: {
+        /**
+         * The event property to group by.
+         * @example "region"
+         */
+        value?: string;
+        options?: {
+            /** @example true */
+            display_in_invoice?: boolean;
+        };
+    }[];
+};
 /** Values used to apply differentiated pricing based on additional event properties. */
 export interface ChargeFilterObject {
     /**
@@ -6356,7 +6610,7 @@ export interface ChargeObject {
      */
     min_amount_cents: number;
     /** List of all thresholds utilized for calculating the charge. */
-    properties: ChargeProperties;
+    properties: ChargeObjectProperties;
     /** List of filters used to apply differentiated pricing based on additional event properties. */
     filters: ChargeFilterObject[];
     /** All taxes applied to the charge. */
@@ -6506,6 +6760,8 @@ export interface FixedChargeObject {
     properties: FixedChargeProperties;
     /**
      * The number of units for the fixed charge.
+     *
+     * When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units.
      * @example 1
      */
     units: number;
@@ -6820,7 +7076,7 @@ export interface PlanCreateInput {
              */
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
-            properties?: ChargeProperties;
+            properties?: ChargeObjectProperties;
             /** List of filters used to apply differentiated pricing based on additional event properties. */
             filters?: ChargeFilterInput[];
             /** List of unique code used to identify the taxes. */
@@ -7043,7 +7299,7 @@ export interface PlanUpdateInput {
              */
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
-            properties?: ChargeProperties;
+            properties?: ChargeObjectProperties;
             /** List of filters used to apply differentiated pricing based on additional event properties. */
             filters?: ChargeFilterInput[];
             /** List of unique code used to identify the taxes. */
@@ -7175,7 +7431,7 @@ export interface ChargeOverridableInput {
      */
     min_amount_cents?: number;
     /** List of all thresholds utilized for calculating the charge. */
-    properties?: ChargeProperties;
+    properties?: ChargeObjectProperties;
     /** List of filters used to apply differentiated pricing based on additional event properties. */
     filters?: ChargeFilterInput[];
     /** List of unique code used to identify the taxes. */
@@ -7541,7 +7797,7 @@ export interface PlanOverridesObject {
          */
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
-        properties?: ChargeProperties;
+        properties?: ChargeObjectProperties;
         /** List of filters used to apply differentiated pricing based on additional event properties. */
         filters?: ChargeFilterInput[];
         /** List of unique code used to identify the taxes. */
@@ -7557,7 +7813,7 @@ export interface PlanOverridesObject {
             conversion_rate?: string;
         };
     }[];
-    /** Additional fixed charges for this plan. */
+    /** Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead. */
     fixed_charges?: {
         /**
          * Unique identifier of the fixed charge created by Lago.
@@ -7656,12 +7912,21 @@ export interface SubscriptionCreateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
-        /** Based plan overrides. */
+        /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
         plan_overrides?: PlanOverridesObject;
         /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
         invoice_custom_section?: InvoiceCustomSectionInput;
         /** Optional payment method to use for processing subscription payments. */
         payment_method?: PaymentMethodReference;
+        /**
+         * Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.
+         *
+         * - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).
+         * - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.
+         * @default true
+         * @example true
+         */
+        consolidate_invoice?: boolean;
     };
 }
 export interface ApplicableUsageThreshold {
@@ -7713,12 +7978,25 @@ export interface SubscriptionUpdateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
-        /** Based plan overrides. */
+        /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
         plan_overrides?: PlanOverridesObject;
         /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
         invoice_custom_section?: InvoiceCustomSectionInput;
         /** Optional payment method to use for processing subscription payments. */
         payment_method?: PaymentMethodReference;
+        /**
+         * Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.
+         *
+         * - `true`: the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).
+         * - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.
+         * @example false
+         */
+        consolidate_invoice?: boolean;
+        /**
+         * The code of the billing entity associated with the subscription. Updates take effect on future invoices only.
+         * @example "default"
+         */
+        billing_entity_code?: string;
     };
 }
 export interface Subscription {
@@ -8857,7 +9135,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.45.2
+ * @version 1.49.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -10070,6 +10348,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             payment_status?: "pending" | "failed" | "succeeded";
+            /**
+             * Filter payment requests by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
@@ -10119,6 +10402,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example ["active","pending"]
              */
             "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
+            /**
+             * Filter subscriptions by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to create a wallet with prepaid credits.
@@ -10150,6 +10438,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter wallets by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to update an existing wallet with prepaid credits.
@@ -10348,6 +10641,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example true
              */
             full_usage?: boolean;
+            /**
+             * Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable `presentation_breakdowns` entirely.
+             * @example "["engineering", "operations"]"
+             */
+            filter_by_presentation?: string;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.
@@ -11009,6 +11307,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             payment_status?: "pending" | "failed" | "succeeded";
+            /**
+             * Filter payment requests by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves a specific payment request by its ID.
@@ -11467,6 +11770,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example ["active","pending"]
              */
             "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
+            /**
+             * Filter subscriptions by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves a specific subscription.
@@ -11732,7 +12040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlement, ApiErrorUnauthorized | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
-         * @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
+         * @description This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
          *
          * @tags subscriptions
          * @name FindAllSubscriptionFixedCharges
@@ -11915,7 +12223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
         }, params?: RequestParams) => Promise<HttpResponse<ChargeFilterResponse, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
+         * @description This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
          *
          * @tags subscriptions
          * @name FindSubscriptionFixedCharge
@@ -11932,7 +12240,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
         }, params?: RequestParams) => Promise<HttpResponse<FixedCharge, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
+         * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead. With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period. This is a premium feature.
          *
          * @tags subscriptions
          * @name OverrideSubscriptionFixedCharge
@@ -12048,6 +12356,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id: string;
+            /**
+             * Filter wallets by billing entity codes.
+             * @example ["billing_entity_code_1","billing_entity_code_2"]
+             */
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden>>;
         /**
          * @description This endpoint is used to update an existing wallet with prepaid credits.