lago-javascript-client 1.54.0 → 1.55.0

package/esm/openapi/webhooks.d.ts

@@ -264,7 +264,13 @@ export interface paths {
         };
         /**
          * List MRR
-         * @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.
          */
         get: operations["findAllMrrs"];
         put?: never;
@@ -485,8 +491,8 @@ export interface paths {
         put?: never;
         post?: never;
         /**
-         * Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.
-         * @description Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
+         * Delete a privilege
+         * @description This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
          */
         delete: operations["deleteFeaturePrivilege"];
         options?: never;
@@ -2094,7 +2100,7 @@ export interface paths {
         head?: never;
         /**
          * Partial update of an entitlement
-         * @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.
          */
         patch: operations["updateEntitlement"];
         trace?: never;
@@ -2731,7 +2737,7 @@ export interface paths {
         head?: never;
         /**
          * Update subscription entitlements
-         * @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.
          */
         patch: operations["updateSubscriptionEntitlements"];
         trace?: never;
@@ -2753,7 +2759,7 @@ export interface paths {
         post?: never;
         /**
          * Remove an entitlement from a subscription
-         * @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.
          */
         delete: operations["destroySubscriptionEntitlement"];
         options?: never;
@@ -2780,7 +2786,7 @@ export interface paths {
         post?: never;
         /**
          * Remove a privilege from a subscription entitlement override
-         * @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.
          */
         delete: operations["destroySubscriptionEntitlementPrivilege"];
         options?: never;
@@ -4408,8 +4414,8 @@ export interface webhooks {
         get?: never;
         put?: never;
         /**
-         * An new payment request has been created
-         * @description An new payment request has been created
+         * A new payment request has been created
+         * @description A new payment request has been created
          */
         post: operations["paymentRequestCreated"];
         delete?: never;
@@ -4448,8 +4454,8 @@ export interface webhooks {
         get?: never;
         put?: never;
         /**
-         * The payment status of an invoice has been updated
-         * @description The payment status of an invoice has been updated
+         * The payment status of a payment request has been updated
+         * @description The payment status of a payment request has been updated
          */
         post: operations["paymentRequestPaymentStatusUpdated"];
         delete?: never;
@@ -5541,8 +5547,8 @@ export interface components {
              */
             user_email?: string | null;
             /**
-             * @description This field stores the actitivy action that was performed to the activity_object.
-             * @example billing_metric.created
+             * @description This field stores the activity action that was performed on the activity_object.
+             * @example billable_metric.created
              */
             activity_type: string;
             /**
@@ -5591,12 +5597,6 @@ export interface components {
              * @example BillableMetric
              */
             resource_type: string;
-            /**
-             * Format: uuid
-             * @description Unique identifier for the organization associated with the activity log.
-             * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
-             */
-            organization_id: string;
             /**
              * Format: date-time
              * @description 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
@@ -5765,10 +5765,14 @@ export interface components {
              */
             logged_at: string;
             /**
-             * Format: object
-             * @example { "billable_metric": { "name": "Storage", "code": "storage" } }
+             * @description 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: {
+                [key: string]: unknown;
+            };
             /**
              * @description This field represents the API origin of the requested URL
              * @example https://app.lago.dev/
@@ -5792,10 +5796,14 @@ export interface components {
              */
             request_id: string;
             /**
-             * Format: object
-             * @example { "lago_id": "b9155544-e261-4e92-b54e-f65d7609294c", ... }
+             * @description 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?: {
+                [key: string]: unknown;
+            } | null;
         };
         ApiLogsPaginated: {
             api_logs: components["schemas"]["ApiLogObject"][];
@@ -6291,10 +6299,10 @@ export interface components {
              */
             created_at: string;
             /**
-             * @description 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.
+             * @description 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;
             /**
              * @description Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
              * @example gb
@@ -6354,8 +6362,8 @@ export interface components {
              */
             recurring?: boolean;
             /**
-             * @description 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.
+             * @description 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)
              */
@@ -6398,8 +6406,8 @@ export interface components {
         };
         BillableMetricEvaluateExpressionInput: {
             /**
-             * @description 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.
+             * @description 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)
              */
@@ -10735,12 +10743,12 @@ export interface components {
             code: string;
             /**
              * Format: date-time
-             * @description 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.
+             * @description 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.
              * @example 2022-04-29T08:59:51.123Z
              */
             timestamp: string;
             /**
-             * @description The precise total amount that was sent in the event payload. This filed is used by the `dynamic` pricing model.
+             * @description 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;
@@ -10766,7 +10774,7 @@ export interface components {
              */
             lago_subscription_id: string | null;
             /**
-             * @description 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.
+             * @description 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;
@@ -10805,7 +10813,7 @@ export interface components {
             /**
              * @description 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;
@@ -10870,6 +10878,11 @@ export interface components {
                  * @example sub_1234567890
                  */
                 external_subscription_id: string;
+                /**
+                 * @description 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;
                 /** @description 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?: {
                     /**
@@ -12678,7 +12691,7 @@ export interface components {
              * @description 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;
             /**
              * @description 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
@@ -13077,7 +13090,7 @@ export interface components {
              * @description 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;
             /**
              * @description Unique code used to identify the add-on.
              * @example setup_fee
@@ -13132,6 +13145,23 @@ export interface components {
             /** @description List of taxes applied to the fixed charge. */
             taxes?: components["schemas"]["TaxObject"][];
         };
+        ApplicableUsageThreshold: {
+            /**
+             * @description The display name of the usage threshold.
+             * @example Threshold 1
+             */
+            threshold_display_name: string | null;
+            /**
+             * @description The amount to reach to trigger a `progressive_billing` invoice.
+             * @example 10000
+             */
+            amount_cents: number;
+            /**
+             * @description 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;
+        };
         PlanEntitlementPrivilegeObject: components["schemas"]["FeaturePrivilegeObject"] & {
             /**
              * @description Value assigned to this privilege in the entitlement. Type depends on the privilege's value_type.
@@ -13214,7 +13244,7 @@ export interface components {
              * @description 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;
             /**
              * Format: date-time
              * @description 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.
@@ -13234,9 +13264,9 @@ export interface components {
             interval: "weekly" | "monthly" | "quarterly" | "semiannual" | "yearly";
             /**
              * @description The description on the plan.
-             * @example
+             * @example Plan for early stage startups.
              */
-            description?: string;
+            description?: string | null;
             /**
              * @description 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
@@ -13251,7 +13281,7 @@ export interface components {
              * @description 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;
             /**
              * @description 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
@@ -13267,6 +13297,17 @@ export interface components {
              * @example null
              */
             bill_fixed_charges_monthly?: boolean | null;
+            /**
+             * Format: uuid
+             * @description 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.
+             * @example null
+             */
+            parent_id?: string | null;
+            /**
+             * @description 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?: components["schemas"]["MinimumCommitmentObject"];
             /**
              * @description Additional usage-based charges for this plan.
@@ -13519,6 +13560,8 @@ export interface components {
             taxes?: components["schemas"]["TaxObject"][];
             /** @description List of usage thresholds applied to the plan. */
             usage_thresholds?: components["schemas"]["UsageThresholdObject"][];
+            /** @description 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?: components["schemas"]["ApplicableUsageThreshold"][];
             /** @description List of all feature entitlements and their privileges available for this plan. */
             entitlements?: components["schemas"]["PlanEntitlement"][];
             metadata?: components["schemas"]["MetadataObject"];
@@ -13831,6 +13874,7 @@ export interface components {
                  *           "amount": "500"
                  *         },
                  *         "units": 1,
+                 *         "apply_units_immediately": false,
                  *         "tax_codes": [
                  *           "french_standard_vat"
                  *         ]
@@ -13933,6 +13977,12 @@ export interface components {
                     properties?: components["schemas"]["FixedChargeProperties"];
                     /** @description List of taxes applied to the fixed charge. */
                     tax_codes?: components["schemas"]["TaxCodes"];
+                    /**
+                     * @description 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;
                 }[];
                 /** @description List of usage thresholds to apply to the plan. */
                 usage_thresholds?: components["schemas"]["UsageThresholdInput"][];
@@ -15077,23 +15127,6 @@ export interface components {
                 activation_rules?: components["schemas"]["SubscriptionActivationRuleInput"][];
             };
         };
-        ApplicableUsageThreshold: {
-            /**
-             * @description The display name of the usage threshold.
-             * @example Threshold 1
-             */
-            threshold_display_name: string | null;
-            /**
-             * @description The amount to reach to trigger a `progressive_billing` invoice.
-             * @example 10000
-             */
-            amount_cents: number;
-            /**
-             * @description 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;
-        };
         SubscriptionObjectExtended: components["schemas"]["SubscriptionObject"] & {
             plan?: components["schemas"]["PlanObject"];
             /** @description List of usage thresholds applicable to this subscription. */
@@ -15372,15 +15405,15 @@ export interface components {
         };
         SubscriptionEntitlementPrivilegeObject: components["schemas"]["FeaturePrivilegeObject"] & {
             /**
-             * @description Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.
+             * @description 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;
             /**
-             * @description Value assigned to this privilege in the plan. Type depends on the privilege's value_type.
+             * @description 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;
             /**
              * @description Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.
              * @example 10
@@ -15463,9 +15496,6 @@ export interface components {
         SubscriptionEntitlements: {
             entitlements: components["schemas"]["SubscriptionEntitlementObject"][];
         };
-        SubscriptionEntitlement: {
-            entitlement: components["schemas"]["SubscriptionEntitlementObject"];
-        };
         SubscriptionChargeOverride: {
             charge: components["schemas"]["ChargeOverridableInput"];
         };
@@ -15846,7 +15876,7 @@ export interface components {
         WebhookEndpointObject: {
             /**
              * Format: uuid
-             * @description 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.
+             * @description 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.
              * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
              */
             lago_id: string;
@@ -15899,11 +15929,12 @@ export interface components {
                  */
                 webhook_url: string;
                 /**
-                 * @description The signature used for the webhook. If no value is passed,
+                 * @description The algorithm used to sign the webhook payload. Defaults to `jwt` when no value is passed.
+                 * @default jwt
                  * @example hmac
                  * @enum {string|null}
                  */
-                signature_algo?: "jwt" | "hmac" | null;
+                signature_algo: "jwt" | "hmac" | null;
                 /**
                  * @description The name of the webhook.
                  * @example EC2-production
@@ -15928,9 +15959,9 @@ export interface components {
                  * @description The URL of the webhook endpoint.
                  * @example https://foo.bar
                  */
-                webhook_url: string;
+                webhook_url?: string;
                 /**
-                 * @description The signature used for the webhook. If no value is passed,
+                 * @description The algorithm used to sign the webhook payload. When the field is omitted, the current value is kept.
                  * @example hmac
                  * @enum {string|null}
                  */
@@ -16452,6 +16483,9 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        SubscriptionEntitlement: {
+            entitlement: components["schemas"]["SubscriptionEntitlementObject"];
+        };
     };
     responses: {
         /** @description Unauthorized error */
@@ -16518,6 +16552,8 @@ export interface components {
         external_customer_id: string;
         /** @description External subscription ID */
         external_subscription_id: string;
+        /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+        billing_entity_code: string;
         /** @description Show data only for given number of months. */
         months: number;
         /** @description Filter by the invoice purchase order number. The match is exact but case-insensitive. */
@@ -16913,8 +16949,10 @@ export interface operations {
                 "http_statuses[]"?: (("succeeded" | "failed") | number)[];
                 /** @description Filter results by API version */
                 api_version?: string;
-                /** @description Filter results by the path of the request */
-                request_paths?: string;
+                /** @description Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly. */
+                "request_paths[]"?: string[];
+                /** @description Filter results by the client that issued the request, as reported by its user agent. */
+                "clients[]"?: string[];
             };
             header?: never;
             path?: never;
@@ -16966,6 +17004,8 @@ export interface operations {
                 currency?: components["schemas"]["Currency"] & unknown;
                 /** @description The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. */
                 external_customer_id?: string;
+                /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+                billing_entity_code?: components["parameters"]["billing_entity_code"];
                 /** @description Show data only for given number of months. */
                 months?: components["parameters"]["months"];
             };
@@ -16993,6 +17033,8 @@ export interface operations {
             query?: {
                 /** @description The currency of revenue analytics. Format must be ISO 4217. */
                 currency?: components["schemas"]["Currency"] & unknown;
+                /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+                billing_entity_code?: components["parameters"]["billing_entity_code"];
                 /** @description Show data only for given number of months. */
                 months?: components["parameters"]["months"];
             };
@@ -17019,6 +17061,8 @@ export interface operations {
             query?: {
                 /** @description The currency of invoiced usage analytics. Format must be ISO 4217. */
                 currency?: components["schemas"]["Currency"] & unknown;
+                /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+                billing_entity_code?: components["parameters"]["billing_entity_code"];
                 /** @description Show data only for given number of months. */
                 months?: components["parameters"]["months"];
             };
@@ -17043,16 +17087,10 @@ export interface operations {
     findAllMrrs: {
         parameters: {
             query?: {
-                /**
-                 * @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.
-                 */
+                /** @description The currency of MRR analytics. Format must be ISO 4217. */
                 currency?: components["schemas"]["Currency"] & unknown;
+                /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+                billing_entity_code?: components["parameters"]["billing_entity_code"];
                 /** @description Show data only for given number of months. */
                 months?: components["parameters"]["months"];
             };
@@ -17082,6 +17120,8 @@ export interface operations {
                 currency?: components["schemas"]["Currency"] & unknown;
                 /** @description The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. */
                 external_customer_id?: string;
+                /** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
+                billing_entity_code?: components["parameters"]["billing_entity_code"];
                 /** @description Show data only for given number of months. */
                 months?: components["parameters"]["months"];
             };
@@ -17107,7 +17147,7 @@ export interface operations {
     findAllUsages: {
         parameters: {
             query?: {
-                /** @description The time granularity of usage analytics. Possible values are 'daily', 'weekly', 'monthly', 'yearly'. */
+                /** @description The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'. */
                 time_granularity?: "daily" | "weekly" | "monthly";
                 /** @description The currency of usage analytics. Format must be ISO 4217. */
                 currency?: components["schemas"]["Currency"] & unknown;
@@ -19160,7 +19200,7 @@ export interface operations {
                 external_subscription_id?: components["parameters"]["external_subscription_id"];
                 /** @description Filter events by its code. */
                 code?: string;
-                /** @description Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime. */
+                /** @description Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the subscription started at datetime. */
                 timestamp_from_started_at?: boolean;
                 /** @description Filter events by timestamp starting from a specific date. */
                 timestamp_from?: string;
@@ -22052,13 +22092,13 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Subscription entitlement removed */
+            /** @description Remaining subscription entitlements */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["SubscriptionEntitlement"];
+                    "application/json": components["schemas"]["SubscriptionEntitlements"];
                 };
             };
             401: components["responses"]["Unauthorized"];
@@ -22084,13 +22124,13 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Subscription entitlement with privilege override removed */
+            /** @description Remaining subscription entitlements */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["SubscriptionEntitlement"];
+                    "application/json": components["schemas"]["SubscriptionEntitlements"];
                 };
             };
             400: components["responses"]["BadRequest"];
@@ -24071,6 +24111,12 @@ export interface operations {
                     webhook_type: "credit_note.refund_failure";
                     /** @enum {string} */
                     object_type: "credit_note_payment_provider_refund_error";
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier of the organization, created by Lago.
+                     * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
+                     */
+                    organization_id: string;
                     credit_note_payment_provider_refund_error: components["schemas"]["CreditNotePaymentProviderRefundError"];
                 };
             };

package/package.json

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