lago-javascript-client 1.0.0 → 1.2.0

package/esm/openapi/client.d.ts

@@ -401,6 +401,7 @@ export interface BillableMetricObject {
     weighted_interval?: "seconds" | null;
     /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
     group?: BillableMetricGroup;
+    filters?: BillableMetricFilterObject[];
     /**
      * Number of active subscriptions using this billable metric.
      * @example 4
@@ -459,14 +460,38 @@ export interface BillableMetricBaseInput {
     weighted_interval?: "seconds" | null;
     /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
     group?: BillableMetricGroup;
+    filters?: BillableMetricFilterInput[];
 }
 export interface BillableMetricCreateInput {
     billable_metric: BillableMetricBaseInput;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterInput {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterObject {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
 export interface BillableMetricUpdateInput {
     billable_metric: BillableMetricBaseInput;
 }
-/** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
+/**
+ * Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric.
+ * @deprecated
+ */
 export interface BillableMetricGroup {
     /**
      * Name of the event property used to group values.
@@ -494,6 +519,36 @@ export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
     meta: PaginationMeta;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterInput {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name?: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    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 used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterObject {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    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[]>;
+}
 export interface ChargeObject {
     /**
      * Unique identifier of charge, created by Lago.
@@ -551,7 +606,12 @@ export interface ChargeObject {
     min_amount_cents?: number;
     /** List of all thresholds utilized for calculating the charge. */
     properties?: ChargeProperties;
-    /** All charge information, sorted by groups. */
+    /** List of filters used to apply differentiated pricing based on additional event properties. */
+    filters?: ChargeFilterObject[];
+    /**
+     * All charge information, sorted by groups.
+     * @deprecated
+     */
     group_properties?: GroupPropertiesObject[];
     /** All taxes applied to the charge. */
     taxes?: TaxObject[];
@@ -1351,6 +1411,35 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of filter object, representing multiple dimensions for a charge item. */
+export type CustomerChargeFiltersUsageObject = {
+    /**
+     * 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 amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
+     * @example 1000
+     */
+    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;
+    /**
+     * List of filter values applied to the usage.
+     * @example {"region":"us-east-1"}
+     */
+    values?: Record<string, string>;
+}[];
 /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
 export type CustomerChargeGroupedUsageObject = {
     /**
@@ -1371,10 +1460,15 @@ export type CustomerChargeGroupedUsageObject = {
     units?: string;
     /** 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?: CustomerChargeFiltersUsageObject;
     /** Array of group object, representing multiple dimensions for a charge item. */
     groups?: CustomerChargeGroupsUsageObject;
 }[];
-/** Array of group object, representing multiple dimensions for a charge item. */
+/**
+ * Array of group object, representing multiple dimensions for a charge item.
+ * @deprecated
+ */
 export type CustomerChargeGroupsUsageObject = {
     /**
      * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
@@ -1471,6 +1565,8 @@ export interface CustomerChargeUsageObject {
          */
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
     };
+    /** Array of filter object, representing multiple dimensions for a charge item. */
+    filters?: CustomerChargeFiltersUsageObject;
     /** Array of group object, representing multiple dimensions for a charge item. */
     groups: CustomerChargeGroupsUsageObject;
     /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
@@ -1951,10 +2047,17 @@ export interface FeeObject {
     lago_id?: string | null;
     /**
      * Unique identifier assigned to the group that the fee belongs to
+     * @deprecated
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_group_id?: string | null;
+    /**
+     * 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;
     /**
      * Unique identifier assigned to the invoice that the fee belongs to
      * @format uuid
@@ -2289,8 +2392,16 @@ export interface FeeObject {
          * @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;
+        /** Key value list of event properties */
+        filters?: Record<string, 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.
+         * @deprecated
          * @example "Transactions - ACH"
          */
         group_invoice_display_name?: string;
@@ -2380,6 +2491,66 @@ export interface GroupsPaginated {
     groups: GroupObject[];
     meta: PaginationMeta;
 }
+/** Minimum commitment for this plan. */
+export type MinimumCommitmentInput = {
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of unique code used to identify the taxes.
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+} | null;
+export type MinimumCommitmentObject = {
+    /**
+     * Unique identifier of the minimum commitment, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The unique code representing the plan to be attached to the customer.
+     * @example "premium"
+     */
+    plan_code?: string;
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`.
+     * @example "monthly"
+     */
+    interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+    /**
+     * The date and time when the minimum commitment 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 minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at?: string;
+    /** All taxes applied to the minimum commitment. */
+    taxes?: TaxObject[];
+} | null;
 export interface MrrObject {
     /**
      * Identifies the month to analyze MRR.
@@ -2497,7 +2668,7 @@ export interface InvoiceObject {
      * This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.
      * @example 2
      */
-    sequential_id: number;
+    sequential_id?: number;
     /**
      * The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.
      * @example "LAG-1234-001-002"
@@ -2509,6 +2680,12 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     issuing_date: string;
+    /**
+     * The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-09-14T16:35:31Z"
+     */
+    payment_dispute_lost_at?: string;
     /**
      * The payment due date for the invoice, specified in the ISO 8601 date format.
      * @format date
@@ -2982,6 +3159,8 @@ export interface PlanCreateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","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"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
@@ -3029,7 +3208,10 @@ export interface PlanCreateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3039,6 +3221,8 @@ export interface PlanCreateInput {
                 /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
                 values: ChargeProperties;
             }[];
+            /** List of filters used to apply differentiated pricing based on additional event properties. */
+            filters?: ChargeFilterInput[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3081,6 +3265,7 @@ export interface PlanOverridesObject {
      * @example 5
      */
     trial_period?: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /** Additional usage-based charges for this plan. */
     charges?: {
         /**
@@ -3107,7 +3292,10 @@ export interface PlanOverridesObject {
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
         properties?: ChargeProperties;
-        /** All charge information, sorted by groups. */
+        /**
+         * All charge information, sorted by groups.
+         * @deprecated
+         */
         group_properties?: {
             /**
              * Unique identifier of a billable metric group, created by Lago.
@@ -3117,6 +3305,8 @@ export interface PlanOverridesObject {
             /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
             values: ChargeProperties;
         }[];
+        /** List of filters used to apply differentiated pricing based on additional event properties. */
+        filters?: ChargeFilterInput[];
         /**
          * List of unique code used to identify the taxes.
          * @example ["french_standard_vat"]
@@ -3178,6 +3368,8 @@ export interface PlanUpdateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","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"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
@@ -3231,7 +3423,10 @@ export interface PlanUpdateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3241,6 +3436,8 @@ export interface PlanUpdateInput {
                 /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
                 values: ChargeProperties;
             }[];
+            /** List of filters used to apply differentiated pricing based on additional event properties. */
+            filters?: ChargeFilterInput[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3319,9 +3516,10 @@ export interface PlanObject {
      * @example 0
      */
     draft_invoices_count: number;
+    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,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"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"}]},"group_properties":[]},{"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":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"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"}]},"group_properties":[]},{"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+     * @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,"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,"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. */
@@ -3394,7 +3592,7 @@ export interface SubscriptionUpdateInput {
          * @format date-time
          * @example "2022-10-08T00:00:00Z"
          */
-        ending_at?: string;
+        ending_at: string | null;
         /**
          * The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
          * @format date-time
@@ -3504,6 +3702,12 @@ export interface SubscriptionObject {
      * @example "2022-04-30"
      */
     downgrade_plan_date?: string | null;
+    /**
+     * The date when the free trial is ended, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    trial_ended_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4082,7 +4286,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.57.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4337,6 +4541,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code: string, query?: {
@@ -4922,6 +5127,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         finalizeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *
@@ -5111,7 +5326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
              * @example ["active","pending"]
              */
-            status?: ("pending" | "canceled" | "terminated" | "active")[];
+            "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific subscription.

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.57.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -444,6 +444,7 @@ export class Api extends HttpClient {
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code, query, params = {}) => this.request({
@@ -1040,6 +1041,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/lose_dispute`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -401,6 +401,7 @@ export interface BillableMetricObject {
     weighted_interval?: "seconds" | null;
     /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
     group?: BillableMetricGroup;
+    filters?: BillableMetricFilterObject[];
     /**
      * Number of active subscriptions using this billable metric.
      * @example 4
@@ -459,14 +460,38 @@ export interface BillableMetricBaseInput {
     weighted_interval?: "seconds" | null;
     /** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
     group?: BillableMetricGroup;
+    filters?: BillableMetricFilterInput[];
 }
 export interface BillableMetricCreateInput {
     billable_metric: BillableMetricBaseInput;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterInput {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface BillableMetricFilterObject {
+    /**
+     * Filter key to add to the event properties payload
+     * @example "region"
+     */
+    key: string;
+    /** List of possible filter values */
+    values: string[];
+}
 export interface BillableMetricUpdateInput {
     billable_metric: BillableMetricBaseInput;
 }
-/** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
+/**
+ * Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric.
+ * @deprecated
+ */
 export interface BillableMetricGroup {
     /**
      * Name of the event property used to group values.
@@ -494,6 +519,36 @@ export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
     meta: PaginationMeta;
 }
+/** Values used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterInput {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name?: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    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 used to apply differentiated pricing based on additional event properties. */
+export interface ChargeFilterObject {
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name: string | null;
+    /** List of all thresholds utilized for calculating the charge. */
+    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[]>;
+}
 export interface ChargeObject {
     /**
      * Unique identifier of charge, created by Lago.
@@ -551,7 +606,12 @@ export interface ChargeObject {
     min_amount_cents?: number;
     /** List of all thresholds utilized for calculating the charge. */
     properties?: ChargeProperties;
-    /** All charge information, sorted by groups. */
+    /** List of filters used to apply differentiated pricing based on additional event properties. */
+    filters?: ChargeFilterObject[];
+    /**
+     * All charge information, sorted by groups.
+     * @deprecated
+     */
     group_properties?: GroupPropertiesObject[];
     /** All taxes applied to the charge. */
     taxes?: TaxObject[];
@@ -1351,6 +1411,35 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of filter object, representing multiple dimensions for a charge item. */
+export type CustomerChargeFiltersUsageObject = {
+    /**
+     * 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 amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
+     * @example 1000
+     */
+    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;
+    /**
+     * List of filter values applied to the usage.
+     * @example {"region":"us-east-1"}
+     */
+    values?: Record<string, string>;
+}[];
 /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
 export type CustomerChargeGroupedUsageObject = {
     /**
@@ -1371,10 +1460,15 @@ export type CustomerChargeGroupedUsageObject = {
     units?: string;
     /** 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?: CustomerChargeFiltersUsageObject;
     /** Array of group object, representing multiple dimensions for a charge item. */
     groups?: CustomerChargeGroupsUsageObject;
 }[];
-/** Array of group object, representing multiple dimensions for a charge item. */
+/**
+ * Array of group object, representing multiple dimensions for a charge item.
+ * @deprecated
+ */
 export type CustomerChargeGroupsUsageObject = {
     /**
      * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
@@ -1471,6 +1565,8 @@ export interface CustomerChargeUsageObject {
          */
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
     };
+    /** Array of filter object, representing multiple dimensions for a charge item. */
+    filters?: CustomerChargeFiltersUsageObject;
     /** Array of group object, representing multiple dimensions for a charge item. */
     groups: CustomerChargeGroupsUsageObject;
     /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
@@ -1951,10 +2047,17 @@ export interface FeeObject {
     lago_id?: string | null;
     /**
      * Unique identifier assigned to the group that the fee belongs to
+     * @deprecated
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_group_id?: string | null;
+    /**
+     * 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;
     /**
      * Unique identifier assigned to the invoice that the fee belongs to
      * @format uuid
@@ -2289,8 +2392,16 @@ export interface FeeObject {
          * @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;
+        /** Key value list of event properties */
+        filters?: Record<string, 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.
+         * @deprecated
          * @example "Transactions - ACH"
          */
         group_invoice_display_name?: string;
@@ -2380,6 +2491,66 @@ export interface GroupsPaginated {
     groups: GroupObject[];
     meta: PaginationMeta;
 }
+/** Minimum commitment for this plan. */
+export type MinimumCommitmentInput = {
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of unique code used to identify the taxes.
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+} | null;
+export type MinimumCommitmentObject = {
+    /**
+     * Unique identifier of the minimum commitment, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The unique code representing the plan to be attached to the customer.
+     * @example "premium"
+     */
+    plan_code?: string;
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`.
+     * @example "monthly"
+     */
+    interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+    /**
+     * The date and time when the minimum commitment 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 minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at?: string;
+    /** All taxes applied to the minimum commitment. */
+    taxes?: TaxObject[];
+} | null;
 export interface MrrObject {
     /**
      * Identifies the month to analyze MRR.
@@ -2497,7 +2668,7 @@ export interface InvoiceObject {
      * This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.
      * @example 2
      */
-    sequential_id: number;
+    sequential_id?: number;
     /**
      * The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.
      * @example "LAG-1234-001-002"
@@ -2509,6 +2680,12 @@ export interface InvoiceObject {
      * @example "2022-04-30"
      */
     issuing_date: string;
+    /**
+     * The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-09-14T16:35:31Z"
+     */
+    payment_dispute_lost_at?: string;
     /**
      * The payment due date for the invoice, specified in the ISO 8601 date format.
      * @format date
@@ -2982,6 +3159,8 @@ export interface PlanCreateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","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"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
@@ -3029,7 +3208,10 @@ export interface PlanCreateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3039,6 +3221,8 @@ export interface PlanCreateInput {
                 /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
                 values: ChargeProperties;
             }[];
+            /** List of filters used to apply differentiated pricing based on additional event properties. */
+            filters?: ChargeFilterInput[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3081,6 +3265,7 @@ export interface PlanOverridesObject {
      * @example 5
      */
     trial_period?: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /** Additional usage-based charges for this plan. */
     charges?: {
         /**
@@ -3107,7 +3292,10 @@ export interface PlanOverridesObject {
         min_amount_cents?: number;
         /** List of all thresholds utilized for calculating the charge. */
         properties?: ChargeProperties;
-        /** All charge information, sorted by groups. */
+        /**
+         * All charge information, sorted by groups.
+         * @deprecated
+         */
         group_properties?: {
             /**
              * Unique identifier of a billable metric group, created by Lago.
@@ -3117,6 +3305,8 @@ export interface PlanOverridesObject {
             /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
             values: ChargeProperties;
         }[];
+        /** List of filters used to apply differentiated pricing based on additional event properties. */
+        filters?: ChargeFilterInput[];
         /**
          * List of unique code used to identify the taxes.
          * @example ["french_standard_vat"]
@@ -3178,6 +3368,8 @@ export interface PlanUpdateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","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"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
@@ -3231,7 +3423,10 @@ export interface PlanUpdateInput {
             min_amount_cents?: number;
             /** List of all thresholds utilized for calculating the charge. */
             properties?: ChargeProperties;
-            /** All charge information, sorted by groups. */
+            /**
+             * All charge information, sorted by groups.
+             * @deprecated
+             */
             group_properties?: {
                 /**
                  * Unique identifier of a billable metric group, created by Lago.
@@ -3241,6 +3436,8 @@ export interface PlanUpdateInput {
                 /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
                 values: ChargeProperties;
             }[];
+            /** List of filters used to apply differentiated pricing based on additional event properties. */
+            filters?: ChargeFilterInput[];
             /**
              * List of unique code used to identify the taxes.
              * @example ["french_standard_vat"]
@@ -3319,9 +3516,10 @@ export interface PlanObject {
      * @example 0
      */
     draft_invoices_count: number;
+    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,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"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"}]},"group_properties":[]},{"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":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"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"}]},"group_properties":[]},{"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,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+     * @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,"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,"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. */
@@ -3394,7 +3592,7 @@ export interface SubscriptionUpdateInput {
          * @format date-time
          * @example "2022-10-08T00:00:00Z"
          */
-        ending_at?: string;
+        ending_at: string | null;
         /**
          * The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
          * @format date-time
@@ -3504,6 +3702,12 @@ export interface SubscriptionObject {
      * @example "2022-04-30"
      */
     downgrade_plan_date?: string | null;
+    /**
+     * The date when the free trial is ended, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    trial_ended_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4082,7 +4286,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.57.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4337,6 +4541,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code: string, query?: {
@@ -4922,6 +5127,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         finalizeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *
@@ -5111,7 +5326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
              * @example ["active","pending"]
              */
-            status?: ("pending" | "canceled" | "terminated" | "active")[];
+            "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific subscription.

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.57.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -448,6 +448,7 @@ class Api extends HttpClient {
          * @name FindAllBillableMetricGroups
          * @summary Find a billable metric's groups
          * @request GET:/billable_metrics/{code}/groups
+         * @deprecated
          * @secure
          */
         findAllBillableMetricGroups: (code, query, params = {}) => this.request({
@@ -1044,6 +1045,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for setting invoice's payment dispute as lost.
+         *
+         * @tags invoices
+         * @name LoseDisputeInvoice
+         * @summary Mark an invoice payment dispute as lost
+         * @request POST:/invoices/{lago_id}/lose_dispute
+         * @secure
+         */
+        loseDisputeInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/lose_dispute`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used for refreshing a draft invoice.
          *