lago-javascript-client 1.54.0 → 1.55.0

package/esm/openapi/client.d.ts

@@ -629,8 +629,8 @@ export interface ActivityLogObject {
      */
     user_email?: string | null;
     /**
-     * This field stores the actitivy action that was performed to the activity_object.
-     * @example "billing_metric.created"
+     * This field stores the activity action that was performed on the activity_object.
+     * @example "billable_metric.created"
      */
     activity_type: string;
     /**
@@ -670,12 +670,6 @@ export interface ActivityLogObject {
      * @example "BillableMetric"
      */
     resource_type: string;
-    /**
-     * Unique identifier for the organization associated with the activity log.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    organization_id: string;
     /**
      * The logged date of the activity, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
      * @format date-time
@@ -844,10 +838,10 @@ export interface ApiLogObject {
      */
     logged_at: string;
     /**
-     * @format object
-     * @example "{ "billable_metric": { "name": "Storage", "code": "storage" } }"
+     * The parameters of the request, keyed by their top-level name. Nested values are returned JSON-encoded.
+     * @example {"billable_metric":"{\"name\":\"Storage\",\"code\":\"storage\"}"}
      */
-    request_body: string;
+    request_body: Record<string, any>;
     /**
      * This field represents the API origin of the requested URL
      * @example "https://app.lago.dev/"
@@ -871,10 +865,10 @@ export interface ApiLogObject {
      */
     request_id: string;
     /**
-     * @format object
-     * @example "{ "lago_id": "b9155544-e261-4e92-b54e-f65d7609294c", ... }"
+     * The body Lago returned for the request, keyed by its top-level name. Nested values are returned JSON-encoded. Null when the response had no body.
+     * @example {"billable_metric":"{\"lago_id\":\"b9155544-e261-4e92-b54e-f65d7609294c\"}"}
      */
-    request_response?: string;
+    request_response?: object | null;
 }
 export interface ApiLogsPaginated {
     api_logs: ApiLogObject[];
@@ -1355,10 +1349,10 @@ export interface BillableMetricObject {
      */
     created_at: string;
     /**
-     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
+     * Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
      * @example "round((ended_at - started_at) * units)"
      */
-    expression?: string;
+    expression?: string | null;
     /**
      * Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
      * @example "gb"
@@ -1416,8 +1410,8 @@ export interface BillableMetricBaseInput {
      */
     recurring?: boolean;
     /**
-     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
-     * Accepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
+     * Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
+     * Accepted functions are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
      * Round is accepting an optional second parameter to specify the number of decimal.
      * @example "round((ended_at - started_at) * units)"
      */
@@ -1457,8 +1451,8 @@ export interface BillableMetric {
 }
 export interface BillableMetricEvaluateExpressionInput {
     /**
-     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
-     * Accepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
+     * Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
+     * Accepted functions are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
      * Round is accepting an optional second parameter to specify the number of decimal.
      * @example "round((ended_at - started_at) * units)"
      */
@@ -5539,13 +5533,13 @@ export interface EventObject {
      */
     code: string;
     /**
-     * This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.
+     * The date and time at which the event occurred, in ISO 8601 format with millisecond precision and expressed in Coordinated Universal Time (UTC). When no timestamp is sent on the event, it is set to the time of event reception.
      * @format date-time
      * @example "2022-04-29T08:59:51.123Z"
      */
     timestamp: string;
     /**
-     * The precise total amount that was sent in the event payload. This filed is used by the `dynamic` pricing model.
+     * The precise total amount that was sent in the event payload. This field is used by the `dynamic` pricing model.
      * @example "1234.56"
      */
     precise_total_amount_cents?: string | null;
@@ -5565,7 +5559,7 @@ export interface EventObject {
      */
     lago_subscription_id: string | null;
     /**
-     * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
+     * The unique identifier of the subscription within your application, as sent on the event. It is the value Lago uses to attach the event to a subscription.
      * @example "sub_1234567890"
      */
     external_subscription_id: string;
@@ -5604,7 +5598,7 @@ export interface EventInputObject {
     /**
      * This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
      * If this timestamp is not provided, the API will automatically set it to the time of event reception.
-     * You can also provide miliseconds precision by appending decimals to the timestamp.
+     * You can also provide milliseconds precision by appending decimals to the timestamp.
      * @example "1651240791.123"
      */
     timestamp?: number | string;
@@ -5666,6 +5660,11 @@ export interface EventEstimateFeesInput {
          * @example "sub_1234567890"
          */
         external_subscription_id: string;
+        /**
+         * The precise total amount in cents with precision used by the `dynamic` pricing model to compute the estimated usage amount. Defaults to `0` when omitted.
+         * @example "1234.56"
+         */
+        precise_total_amount_cents?: string | null;
         /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. Any property of the targeted billable metric can be sent here, in addition to the documented fields below. */
         properties?: {
             /**
@@ -7292,7 +7291,7 @@ export interface MinimumCommitmentObject {
      * 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;
+    invoice_display_name?: string | null;
     /**
      * 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`, `semiannual`, `quarterly`, `monthly` or `weekly`.
      * @example "monthly"
@@ -7694,7 +7693,7 @@ export interface FixedChargeObject {
      * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
      * @example "Setup fee"
      */
-    invoice_display_name: string;
+    invoice_display_name: string | null;
     /**
      * Unique code used to identify the add-on.
      * @example "setup_fee"
@@ -7748,6 +7747,23 @@ export interface FixedChargeObject {
     /** List of taxes applied to the fixed charge. */
     taxes?: TaxObject[];
 }
+export interface ApplicableUsageThreshold {
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
+     * @example true
+     */
+    recurring: boolean;
+}
 export type PlanEntitlementPrivilegeObject = FeaturePrivilegeObject & {
     /**
      * Value assigned to this privilege in the entitlement. Type depends on the privilege's value_type.
@@ -7796,7 +7812,7 @@ export interface PlanObject {
      * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.
      * @example "Startup plan"
      */
-    invoice_display_name?: string;
+    invoice_display_name?: string | null;
     /**
      * The date and time when the plan 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 plan was initially created.
      * @format date-time
@@ -7815,9 +7831,9 @@ export interface PlanObject {
     interval: "weekly" | "monthly" | "quarterly" | "semiannual" | "yearly";
     /**
      * The description on the plan.
-     * @example ""
+     * @example "Plan for early stage startups."
      */
-    description?: string;
+    description?: string | null;
     /**
      * The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.
      * @example 10000
@@ -7832,7 +7848,7 @@ export interface PlanObject {
      * The duration in days during which the base cost of the plan is offered for free.
      * @example 5
      */
-    trial_period?: number;
+    trial_period?: number | null;
     /**
      * This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.
      * @example true
@@ -7848,6 +7864,17 @@ export interface PlanObject {
      * @example null
      */
     bill_fixed_charges_monthly?: boolean | null;
+    /**
+     * Unique identifier of the parent plan, created by Lago. It is set on plans that override a parent plan for a single subscription, and `null` on standard plans.
+     * @format uuid
+     * @example null
+     */
+    parent_id?: string | null;
+    /**
+     * This field is set to `true` when the plan is scheduled for deletion but still attached to subscriptions that have to be billed first.
+     * @example false
+     */
+    pending_deletion?: boolean;
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
@@ -7863,6 +7890,8 @@ export interface PlanObject {
     taxes?: TaxObject[];
     /** List of usage thresholds applied to the plan. */
     usage_thresholds?: UsageThresholdObject[];
+    /** List of usage thresholds that actually apply to the plan. For an overriding plan these are inherited from its parent plan; for a standard plan they match `usage_thresholds`. */
+    applicable_usage_thresholds?: ApplicableUsageThreshold[];
     /** List of all feature entitlements and their privileges available for this plan. */
     entitlements?: PlanEntitlement[];
     /**
@@ -8078,7 +8107,7 @@ export interface PlanCreateInput {
         }[];
         /**
          * Additional fixed charges for this plan.
-         * @example [{"add_on_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","code":"setup_fee","invoice_display_name":"Setup Fee","charge_model":"standard","pay_in_advance":true,"prorated":false,"properties":{"amount":"500"},"units":1,"tax_codes":["french_standard_vat"]},{"add_on_id":"4d604d60-4d60-4d60-4d60-4d604d604d60","invoice_display_name":"Support Tier","charge_model":"graduated","pay_in_advance":false,"prorated":true,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"per_unit_amount":"5","flat_amount":"200"},{"from_value":11,"to_value":null,"per_unit_amount":"1","flat_amount":"300"}]},"units":2},{"add_on_id":"6f406f40-6f40-6f40-6f40-6f406f406f40","charge_model":"volume","properties":{"volume_ranges":[{"from_value":0,"to_value":100,"per_unit_amount":"2","flat_amount":"1"},{"from_value":101,"to_value":null,"per_unit_amount":"1","flat_amount":"0"}]},"units":50}]
+         * @example [{"add_on_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","code":"setup_fee","invoice_display_name":"Setup Fee","charge_model":"standard","pay_in_advance":true,"prorated":false,"properties":{"amount":"500"},"units":1,"apply_units_immediately":false,"tax_codes":["french_standard_vat"]},{"add_on_id":"4d604d60-4d60-4d60-4d60-4d604d604d60","invoice_display_name":"Support Tier","charge_model":"graduated","pay_in_advance":false,"prorated":true,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"per_unit_amount":"5","flat_amount":"200"},{"from_value":11,"to_value":null,"per_unit_amount":"1","flat_amount":"300"}]},"units":2},{"add_on_id":"6f406f40-6f40-6f40-6f40-6f406f406f40","charge_model":"volume","properties":{"volume_ranges":[{"from_value":0,"to_value":100,"per_unit_amount":"2","flat_amount":"1"},{"from_value":101,"to_value":null,"per_unit_amount":"1","flat_amount":"0"}]},"units":50}]
          */
         fixed_charges?: {
             /**
@@ -8130,6 +8159,12 @@ export interface PlanCreateInput {
             properties?: FixedChargeProperties;
             /** List of taxes applied to the fixed charge. */
             tax_codes?: TaxCodes;
+            /**
+             * When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.
+             * @default false
+             * @example false
+             */
+            apply_units_immediately?: boolean;
         }[];
         /** List of usage thresholds to apply to the plan. */
         usage_thresholds?: UsageThresholdInput[];
@@ -9157,23 +9192,6 @@ export interface SubscriptionCreateInput {
         activation_rules?: SubscriptionActivationRuleInput[];
     };
 }
-export interface ApplicableUsageThreshold {
-    /**
-     * The display name of the usage threshold.
-     * @example "Threshold 1"
-     */
-    threshold_display_name: string | null;
-    /**
-     * The amount to reach to trigger a `progressive_billing` invoice.
-     * @example 10000
-     */
-    amount_cents: number;
-    /**
-     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
-     * @example true
-     */
-    recurring: boolean;
-}
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
     /** List of usage thresholds applicable to this subscription. */
@@ -9448,15 +9466,15 @@ export interface AlertUpdateInput {
 }
 export type SubscriptionEntitlementPrivilegeObject = FeaturePrivilegeObject & {
     /**
-     * Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.
+     * Applicable value for this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.
      * @example 10
      */
     value: number | boolean | string;
     /**
-     * Value assigned to this privilege in the plan. Type depends on the privilege's value_type.
+     * Value assigned to this privilege in the plan. Type depends on the privilege's value_type. Null when the privilege only exists as a subscription override.
      * @example 10
      */
-    plan_value: number | boolean | string;
+    plan_value: number | boolean | string | null;
     /**
      * Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.
      * @example 10
@@ -9490,9 +9508,6 @@ export interface SubscriptionEntitlementObject {
 export interface SubscriptionEntitlements {
     entitlements: SubscriptionEntitlementObject[];
 }
-export interface SubscriptionEntitlement {
-    entitlement: SubscriptionEntitlementObject;
-}
 export interface SubscriptionChargeOverride {
     /** Properties of a charge that can be overridden at the subscription level. */
     charge: ChargeOverridableInput;
@@ -9859,7 +9874,7 @@ export interface WebhookPublicKey {
 }
 export interface WebhookEndpointObject {
     /**
-     * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
+     * Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
@@ -9909,7 +9924,8 @@ export interface WebhookEndpointCreateInput {
          */
         webhook_url: string;
         /**
-         * The signature used for the webhook. If no value is passed,
+         * The algorithm used to sign the webhook payload. Defaults to `jwt` when no value is passed.
+         * @default "jwt"
          * @example "hmac"
          */
         signature_algo?: "jwt" | "hmac";
@@ -9934,9 +9950,9 @@ export interface WebhookEndpointUpdateInput {
          * The URL of the webhook endpoint.
          * @example "https://foo.bar"
          */
-        webhook_url: string;
+        webhook_url?: string;
         /**
-         * The signature used for the webhook. If no value is passed,
+         * The algorithm used to sign the webhook payload. When the field is omitted, the current value is kept.
          * @example "hmac"
          */
         signature_algo?: "jwt" | "hmac";
@@ -10412,6 +10428,9 @@ export interface WalletTransactionPaymentFailureObject {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
+export interface SubscriptionEntitlement {
+    entitlement: SubscriptionEntitlementObject;
+}
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
 export interface FullRequestParams extends Omit<RequestInit, "body"> {
@@ -10472,7 +10491,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.54.0
+ * @version 1.55.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -10567,7 +10586,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             to_date?: string;
             /**
              * Filter results by activity types
-             * @example ["billing_metric.created","billing_metric.updated"]
+             * @example ["billable_metric.created","billable_metric.updated"]
              */
             "activity_types[]"?: string[];
             /**
@@ -10724,10 +10743,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             api_version?: string;
             /**
-             * Filter results by the path of the request
-             * @example "/billable_metrics/"
+             * Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly.
+             * @example ["/api/v1/billable_metrics","*billable_metrics*"]
+             */
+            "request_paths[]"?: string[];
+            /**
+             * Filter results by the client that issued the request, as reported by its user agent.
+             * @example ["Lago Ruby v1.26.0"]
              */
-            request_paths?: string;
+            "clients[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<ApiLogsPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.
@@ -10758,6 +10782,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization.
+             * @example "acme_corp"
+             */
+            billing_entity_code?: string;
             /**
              * Show data only for given number of months.
              * @example 12
@@ -10776,6 +10805,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoiceCollections: (query?: {
             /** The currency of revenue analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization.
+             * @example "acme_corp"
+             */
+            billing_entity_code?: string;
             /**
              * Show data only for given number of months.
              * @example 12
@@ -10794,6 +10828,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoicedUsages: (query?: {
             /** The currency of invoiced usage analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization.
+             * @example "acme_corp"
+             */
+            billing_entity_code?: string;
             /**
              * Show data only for given number of months.
              * @example 12
@@ -10801,7 +10840,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
         /**
-         * @description This endpoint is used to list MRR.
+         * @description Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle: - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing). - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
          *
          * @tags analytics
          * @name FindAllMrrs
@@ -10810,16 +10849,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         findAllMrrs: (query?: {
+            /** The currency of MRR analytics. Format must be ISO 4217. */
+            currency?: Currency;
             /**
-             * Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:
-             *
-             * - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.
-             * - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).
-             * - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
-             * - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
-             * - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
+             * Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization.
+             * @example "acme_corp"
              */
-            currency?: Currency;
+            billing_entity_code?: string;
             /**
              * Show data only for given number of months.
              * @example 12
@@ -10843,6 +10879,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization.
+             * @example "acme_corp"
+             */
+            billing_entity_code?: string;
             /**
              * Show data only for given number of months.
              * @example 12
@@ -10860,7 +10901,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         findAllUsages: (query?: {
             /**
-             * The time granularity of usage analytics. Possible values are 'daily', 'weekly', 'monthly', 'yearly'.
+             * The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'.
+             * @default "daily"
              * @example "monthly"
              */
             time_granularity?: "daily" | "weekly" | "monthly";
@@ -11098,11 +11140,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         findFeature: (code: string, params?: RequestParams) => Promise<HttpResponse<Feature, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
+         * @description This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
          *
          * @tags features
          * @name DeleteFeaturePrivilege
-         * @summary Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.
+         * @summary Delete a privilege
          * @request DELETE:/features/{code}/privileges/{privilege_code}
          * @secure
          */
@@ -12194,7 +12236,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             code?: string;
             /**
-             * Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime.
+             * Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the subscription started at datetime.
              * @example true
              */
             timestamp_from_started_at?: boolean;
@@ -13089,7 +13131,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         findAllEntitlements: (code: string, params?: RequestParams) => Promise<HttpResponse<PlanEntitlements, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateEntitlement
@@ -13773,7 +13815,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlements, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateSubscriptionEntitlements
@@ -13790,7 +13832,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlements, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
-         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
+         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlement
@@ -13805,9 +13847,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "active"
              */
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
-        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlement, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlements, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
+         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlementPrivilege
@@ -13822,7 +13864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "active"
              */
             subscription_status?: "pending" | "active" | "terminated" | "canceled";
-        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlement, ApiErrorUnauthorized | ApiErrorBadRequest | ApiErrorNotFound>>;
+        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlements, ApiErrorUnauthorized | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @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.
          *

package/esm/openapi/client.js

@@ -156,7 +156,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.54.0
+ * @version 1.55.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -445,7 +445,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to list MRR.
+         * @description Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle: - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing). - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
          *
          * @tags analytics
          * @name FindAllMrrs
@@ -725,11 +725,11 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
+         * @description This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
          *
          * @tags features
          * @name DeleteFeaturePrivilege
-         * @summary Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.
+         * @summary Delete a privilege
          * @request DELETE:/features/{code}/privileges/{privilege_code}
          * @secure
          */
@@ -2439,7 +2439,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateEntitlement
@@ -3200,7 +3200,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateSubscriptionEntitlements
@@ -3219,7 +3219,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
+         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlement
@@ -3236,7 +3236,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
+         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlementPrivilege