lago-javascript-client 1.11.0 → 1.12.3

package/README.md

@@ -5,6 +5,13 @@ This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, an
 [![PyPI version](https://badge.fury.io/js/lago-javascript-client.svg)](https://badge.fury.io/js/lago-javascript-client)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html)
 
+## Current Releases
+
+| Project            | Release Badge                                                                                       |
+|--------------------|-----------------------------------------------------------------------------------------------------|
+| **Lago**           | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
+| **Lago JavaScript Client**     | [![Lago JavaScript Client Release](https://img.shields.io/github/v/release/getlago/lago-javascript-client)](https://github.com/getlago/lago-javascript-client/releases) |
+
 ## Installation
 
 For npm users:

package/esm/openapi/client.d.ts

@@ -560,8 +560,8 @@ export interface ChargeObject {
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
-    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. */
-    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`. */
+    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
     /**
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
@@ -1633,6 +1633,22 @@ export interface CustomerCreateInput {
          * @example "Gavin Belson"
          */
         name?: string | null;
+        /**
+         * First name of the customer
+         * @example "Gavin"
+         */
+        firstname?: string | null;
+        /**
+         * Last name of the customer
+         * @example "Belson"
+         */
+        lastname?: string | null;
+        /**
+         * The type of the customer. It can have one of the following values:
+         * - `company`: the customer is a company.
+         * - `individual`: the customer is an individual.
+         */
+        customer_type?: "company" | "individual" | null;
         /**
          * The phone number of the customer
          * @example "1-171-883-3711 x245"
@@ -1841,6 +1857,22 @@ export type CustomerObject = {
      * @example "Gavin Belson"
      */
     name?: string | null;
+    /**
+     * First name of the customer
+     * @example "Gavin"
+     */
+    firstname?: string | null;
+    /**
+     * Last name of the customer
+     * @example "Belson"
+     */
+    lastname?: string | null;
+    /**
+     * The type of the customer. It can have one of the following values:
+     * - `company`: the customer is a company.
+     * - `individual`: the customer is an individual.
+     */
+    customer_type?: "company" | "individual" | null;
     /**
      * The phone number of the customer
      * @example "1-171-883-3711 x245"
@@ -1992,10 +2024,10 @@ export interface EventInput {
          */
         transaction_id: string;
         /**
-         * 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 in your application. This field is mandatory in order to link events to the correct customer subscription.
          * @example "sub_1234567890"
          */
-        external_subscription_id?: string;
+        external_subscription_id: string;
         /**
          * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
          * @example "storage"
@@ -2008,6 +2040,11 @@ export interface EventInput {
          * @example "1651240791.123"
          */
         timestamp?: number | string;
+        /**
+         * The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.
+         * @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.
          * @example {"gb":10}
@@ -2044,6 +2081,11 @@ export interface EventObject {
      * @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.
+     * @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.
      * @example {"gb":10}
@@ -2505,6 +2547,84 @@ export interface GrossRevenueObject {
 export interface GrossRevenues {
     gross_revenues: GrossRevenueObject[];
 }
+export interface LifetimeUsage {
+    lifetime_usage: LifetimeUsageObject;
+}
+export interface LifetimeUsageInput {
+    lifetime_usage: {
+        /**
+         * The historical usage amount in cents for the subscription (provided by your own application).
+         * @example 100
+         */
+        external_historical_usage_amount_cents: number;
+    };
+}
+export interface LifetimeUsageObject {
+    /**
+     * Unique identifier assigned to the lifetime usage record within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the lifetime usage record within the Lago system
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier assigned to the subscription record within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription record within the Lago system
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_subscription_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    external_subscription_id: string;
+    /**
+     * The historical usage amount in cents for the subscription (provided by your own application).
+     * @example 100
+     */
+    external_historical_usage_amount_cents: number;
+    /**
+     * The total invoiced usage amount in cents for the subscription.
+     * @example 100
+     */
+    invoiced_usage_amount_cents: number;
+    /**
+     * The current usage amount in cents for the subscription on the current billing period.
+     * @example 100
+     */
+    current_usage_amount_cents: number;
+    /**
+     * The recording start date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-01-01T00:00:00Z"
+     */
+    from_datetime: string;
+    /**
+     * The recording end date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-12-31T23:59:59Z"
+     */
+    to_datetime: string;
+    /** Array of usage thresholds attached to the subscription's plan. */
+    usage_thresholds?: LifetimeUsageThresholdObject[];
+}
+export interface LifetimeUsageThresholdObject {
+    /**
+     * The usage threshold amount in cents.
+     * @example 100
+     */
+    amount_cents: number;
+    /**
+     * The completion ratio of the usage threshold.
+     * @example 0.5
+     */
+    completion_ratio: number;
+    /**
+     * The date and time when the usage threshold was reached. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-01-01T00:00:00Z"
+     */
+    reached_at: string | null;
+}
 /** Minimum commitment for this plan. */
 export type MinimumCommitmentInput = {
     /**
@@ -3179,6 +3299,48 @@ export interface PaginationMeta {
      */
     total_count: number;
 }
+export interface PaymentRequestObject {
+    /**
+     * Unique identifier of the payment request, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The customer's email address used for sending dunning notifications
+     * @format email
+     * @example "dinesh@piedpiper.test"
+     */
+    email: string;
+    /**
+     * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+     * @example 100
+     */
+    amount_cents: number;
+    /** The currency of the payment request. */
+    amount_currency: Currency;
+    /**
+     * The status of the payment associated with the payment request. It can have one of the following values:
+     * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+     * - `succeeded`: the payment of the payment request has been successfully processed.
+     * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+     * @example "succeeded"
+     */
+    payment_status: "pending" | "succeeded" | "failed";
+    /**
+     * The date and time when the payment request 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 payment request was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+    customer: any;
+    invoices: any[];
+}
+export interface PaymentRequestsPaginated {
+    payment_requests: PaymentRequestObject[];
+    meta: PaginationMeta;
+}
 export interface Plan {
     plan: PlanObject;
 }
@@ -3250,10 +3412,10 @@ export interface PlanCreateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3452,10 +3614,10 @@ export interface PlanUpdateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3772,6 +3934,18 @@ export interface SubscriptionObject {
      * @example "2022-08-08T00:00:00Z"
      */
     trial_ended_at?: string | null;
+    /**
+     * The date and time when the current billing period started, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    current_billing_period_started_at?: string | null;
+    /**
+     * The date and time when the current billing period ends, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-09-08T00:00:00Z"
+     */
+    current_billing_period_ending_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4098,13 +4272,13 @@ export interface WalletObject {
      */
     rate_amount: string;
     /**
-     * The current wallet balance expressed in credits.
+     * The current wallet balance expressed in credits. This reflects the available balance after all transactions are settled.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "28.0"
      */
     credits_balance: string;
     /**
-     * The current wallet balance expressed in cents.
+     * The current wallet balance expressed in cents. This reflects the available balance after all transactions are settled.
      * @example 1000
      */
     balance_cents: number;
@@ -4225,23 +4399,23 @@ export interface WalletObject {
         }[];
     }[];
     /**
-     * The wallet ongoing balance expressed in cents.
+     * The ongoing wallet balance expressed in cents. This represents the `balance_cents` minus the `ongoing_usage_balance_cents`, showing the real time balance after accounting for current usage including taxes.
      * @example 800
      */
     ongoing_balance_cents: number;
     /**
-     * The wallet ongoing usage balance expressed in cents.
+     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage including taxes.
      * @example 200
      */
     ongoing_usage_balance_cents: number;
     /**
-     * The wallet ongoing balance expressed in credits.
+     * The ongoing wallet balance expressed in credits. This represents the `credits_balance` minus the `credits_ongoing_usage_balance`, showing the real time balance after accounting for current usage including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "8.0"
      */
     credits_ongoing_balance: string;
     /**
-     * The wallet ongoing usage balance expressed in credits.
+     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "2.0"
      */
@@ -4587,9 +4761,9 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.11.0
+ * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -5104,7 +5278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                  */
                 portal_url: string;
             };
-        }, ApiErrorForbidden | ApiErrorUnauthorized | ApiErrorNotFound>>;
+        }, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
          *
@@ -5202,6 +5376,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * External subscription ID
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_subscription_id?: string;
+            /**
+             * Filter events by its code.
+             * @example "event-123"
+             */
+            code?: string;
+            /**
+             * Filter events by timestamp starting from a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_from?: string;
+            /**
+             * Filter events by timestamp up to a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_to?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            events: EventObject[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -5373,7 +5593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createInvoice: (data: InvoiceOneOffCreateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices
@@ -5604,44 +5824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                 lago_invoice_ids: string[];
             };
         }, params?: RequestParams) => Promise<HttpResponse<{
-            payment_request: {
-                /**
-                 * Unique identifier of the payment request, created by Lago.
-                 * @format uuid
-                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-                 */
-                lago_id: string;
-                /**
-                 * The customer's email address used for sending dunning notifications
-                 * @format email
-                 * @example "dinesh@piedpiper.test"
-                 */
-                email: string;
-                /**
-                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
-                 * @example 100
-                 */
-                amount_cents: number;
-                /** The currency of the payment request. */
-                amount_currency: Currency;
-                /**
-                 * The status of the payment associated with the payment request. It can have one of the following values:
-                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
-                 * - `succeeded`: the payment of the payment request has been successfully processed.
-                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
-                 * @example "succeeded"
-                 */
-                payment_status: "pending" | "succeeded" | "failed";
-                /**
-                 * The date and time when the payment request 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 payment request was initially created.
-                 * @format date-time
-                 * @example "2022-04-29T08:59:51Z"
-                 */
-                created_at: string;
-                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
-                customer: any;
-                invoices: any[];
-            };
+            payment_request: PaymentRequestObject;
         }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
          * @description This endpoint is used to list all existing payment requests.
@@ -5668,10 +5851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<{
-            payment_requests: any[];
-            meta: PaginationMeta;
-        }, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
     };
     plans: {
         /**
@@ -5819,6 +5999,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             status?: string;
         }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionLifetimeUsage
+         * @summary Retrive subscription lifetime usage
+         * @request GET:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        getSubscriptionLifetimeUsage: (externalId: string, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to update the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionLifetimeUsage
+         * @summary Update a subscription lifetime usage
+         * @request PUT:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        updateSubscriptionLifetimeUsage: (externalId: string, data: LifetimeUsageInput, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     taxes: {
         /**

package/esm/openapi/client.js

@@ -16,7 +16,7 @@ export var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType || (ContentType = {}));
 export class HttpClient {
-    baseUrl = "https://{region}.getlago.com/api/v1";
+    baseUrl = "https://api{region}getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -148,9 +148,9 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.11.0
+ * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -833,6 +833,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query, params = {}) => this.request({
+            path: `/events`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -974,7 +991,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices
@@ -1383,6 +1400,40 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionLifetimeUsage
+         * @summary Retrive subscription lifetime usage
+         * @request GET:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        getSubscriptionLifetimeUsage: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/lifetime_usage`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows you to update the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionLifetimeUsage
+         * @summary Update a subscription lifetime usage
+         * @request PUT:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        updateSubscriptionLifetimeUsage: (externalId, data, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/lifetime_usage`,
+            method: "PUT",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
     };
     taxes = {
         /**

package/package.json

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

package/script/openapi/client.d.ts

@@ -560,8 +560,8 @@ export interface ChargeObject {
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
-    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. */
-    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`. */
+    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
     /**
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
@@ -1633,6 +1633,22 @@ export interface CustomerCreateInput {
          * @example "Gavin Belson"
          */
         name?: string | null;
+        /**
+         * First name of the customer
+         * @example "Gavin"
+         */
+        firstname?: string | null;
+        /**
+         * Last name of the customer
+         * @example "Belson"
+         */
+        lastname?: string | null;
+        /**
+         * The type of the customer. It can have one of the following values:
+         * - `company`: the customer is a company.
+         * - `individual`: the customer is an individual.
+         */
+        customer_type?: "company" | "individual" | null;
         /**
          * The phone number of the customer
          * @example "1-171-883-3711 x245"
@@ -1841,6 +1857,22 @@ export type CustomerObject = {
      * @example "Gavin Belson"
      */
     name?: string | null;
+    /**
+     * First name of the customer
+     * @example "Gavin"
+     */
+    firstname?: string | null;
+    /**
+     * Last name of the customer
+     * @example "Belson"
+     */
+    lastname?: string | null;
+    /**
+     * The type of the customer. It can have one of the following values:
+     * - `company`: the customer is a company.
+     * - `individual`: the customer is an individual.
+     */
+    customer_type?: "company" | "individual" | null;
     /**
      * The phone number of the customer
      * @example "1-171-883-3711 x245"
@@ -1992,10 +2024,10 @@ export interface EventInput {
          */
         transaction_id: string;
         /**
-         * 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 in your application. This field is mandatory in order to link events to the correct customer subscription.
          * @example "sub_1234567890"
          */
-        external_subscription_id?: string;
+        external_subscription_id: string;
         /**
          * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
          * @example "storage"
@@ -2008,6 +2040,11 @@ export interface EventInput {
          * @example "1651240791.123"
          */
         timestamp?: number | string;
+        /**
+         * The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.
+         * @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.
          * @example {"gb":10}
@@ -2044,6 +2081,11 @@ export interface EventObject {
      * @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.
+     * @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.
      * @example {"gb":10}
@@ -2505,6 +2547,84 @@ export interface GrossRevenueObject {
 export interface GrossRevenues {
     gross_revenues: GrossRevenueObject[];
 }
+export interface LifetimeUsage {
+    lifetime_usage: LifetimeUsageObject;
+}
+export interface LifetimeUsageInput {
+    lifetime_usage: {
+        /**
+         * The historical usage amount in cents for the subscription (provided by your own application).
+         * @example 100
+         */
+        external_historical_usage_amount_cents: number;
+    };
+}
+export interface LifetimeUsageObject {
+    /**
+     * Unique identifier assigned to the lifetime usage record within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the lifetime usage record within the Lago system
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier assigned to the subscription record within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription record within the Lago system
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_subscription_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    external_subscription_id: string;
+    /**
+     * The historical usage amount in cents for the subscription (provided by your own application).
+     * @example 100
+     */
+    external_historical_usage_amount_cents: number;
+    /**
+     * The total invoiced usage amount in cents for the subscription.
+     * @example 100
+     */
+    invoiced_usage_amount_cents: number;
+    /**
+     * The current usage amount in cents for the subscription on the current billing period.
+     * @example 100
+     */
+    current_usage_amount_cents: number;
+    /**
+     * The recording start date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-01-01T00:00:00Z"
+     */
+    from_datetime: string;
+    /**
+     * The recording end date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-12-31T23:59:59Z"
+     */
+    to_datetime: string;
+    /** Array of usage thresholds attached to the subscription's plan. */
+    usage_thresholds?: LifetimeUsageThresholdObject[];
+}
+export interface LifetimeUsageThresholdObject {
+    /**
+     * The usage threshold amount in cents.
+     * @example 100
+     */
+    amount_cents: number;
+    /**
+     * The completion ratio of the usage threshold.
+     * @example 0.5
+     */
+    completion_ratio: number;
+    /**
+     * The date and time when the usage threshold was reached. The date and time must be in ISO 8601 format.
+     * @format date-time
+     * @example "2024-01-01T00:00:00Z"
+     */
+    reached_at: string | null;
+}
 /** Minimum commitment for this plan. */
 export type MinimumCommitmentInput = {
     /**
@@ -3179,6 +3299,48 @@ export interface PaginationMeta {
      */
     total_count: number;
 }
+export interface PaymentRequestObject {
+    /**
+     * Unique identifier of the payment request, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The customer's email address used for sending dunning notifications
+     * @format email
+     * @example "dinesh@piedpiper.test"
+     */
+    email: string;
+    /**
+     * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+     * @example 100
+     */
+    amount_cents: number;
+    /** The currency of the payment request. */
+    amount_currency: Currency;
+    /**
+     * The status of the payment associated with the payment request. It can have one of the following values:
+     * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+     * - `succeeded`: the payment of the payment request has been successfully processed.
+     * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+     * @example "succeeded"
+     */
+    payment_status: "pending" | "succeeded" | "failed";
+    /**
+     * The date and time when the payment request 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 payment request was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+    customer: any;
+    invoices: any[];
+}
+export interface PaymentRequestsPaginated {
+    payment_requests: PaymentRequestObject[];
+    meta: PaginationMeta;
+}
 export interface Plan {
     plan: PlanObject;
 }
@@ -3250,10 +3412,10 @@ export interface PlanCreateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3452,10 +3614,10 @@ export interface PlanUpdateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3772,6 +3934,18 @@ export interface SubscriptionObject {
      * @example "2022-08-08T00:00:00Z"
      */
     trial_ended_at?: string | null;
+    /**
+     * The date and time when the current billing period started, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    current_billing_period_started_at?: string | null;
+    /**
+     * The date and time when the current billing period ends, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-09-08T00:00:00Z"
+     */
+    current_billing_period_ending_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4098,13 +4272,13 @@ export interface WalletObject {
      */
     rate_amount: string;
     /**
-     * The current wallet balance expressed in credits.
+     * The current wallet balance expressed in credits. This reflects the available balance after all transactions are settled.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "28.0"
      */
     credits_balance: string;
     /**
-     * The current wallet balance expressed in cents.
+     * The current wallet balance expressed in cents. This reflects the available balance after all transactions are settled.
      * @example 1000
      */
     balance_cents: number;
@@ -4225,23 +4399,23 @@ export interface WalletObject {
         }[];
     }[];
     /**
-     * The wallet ongoing balance expressed in cents.
+     * The ongoing wallet balance expressed in cents. This represents the `balance_cents` minus the `ongoing_usage_balance_cents`, showing the real time balance after accounting for current usage including taxes.
      * @example 800
      */
     ongoing_balance_cents: number;
     /**
-     * The wallet ongoing usage balance expressed in cents.
+     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage including taxes.
      * @example 200
      */
     ongoing_usage_balance_cents: number;
     /**
-     * The wallet ongoing balance expressed in credits.
+     * The ongoing wallet balance expressed in credits. This represents the `credits_balance` minus the `credits_ongoing_usage_balance`, showing the real time balance after accounting for current usage including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "8.0"
      */
     credits_ongoing_balance: string;
     /**
-     * The wallet ongoing usage balance expressed in credits.
+     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "2.0"
      */
@@ -4587,9 +4761,9 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.11.0
+ * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -5104,7 +5278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                  */
                 portal_url: string;
             };
-        }, ApiErrorForbidden | ApiErrorUnauthorized | ApiErrorNotFound>>;
+        }, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
          *
@@ -5202,6 +5376,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * External subscription ID
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_subscription_id?: string;
+            /**
+             * Filter events by its code.
+             * @example "event-123"
+             */
+            code?: string;
+            /**
+             * Filter events by timestamp starting from a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_from?: string;
+            /**
+             * Filter events by timestamp up to a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_to?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            events: EventObject[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -5373,7 +5593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createInvoice: (data: InvoiceOneOffCreateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices
@@ -5604,44 +5824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                 lago_invoice_ids: string[];
             };
         }, params?: RequestParams) => Promise<HttpResponse<{
-            payment_request: {
-                /**
-                 * Unique identifier of the payment request, created by Lago.
-                 * @format uuid
-                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-                 */
-                lago_id: string;
-                /**
-                 * The customer's email address used for sending dunning notifications
-                 * @format email
-                 * @example "dinesh@piedpiper.test"
-                 */
-                email: string;
-                /**
-                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
-                 * @example 100
-                 */
-                amount_cents: number;
-                /** The currency of the payment request. */
-                amount_currency: Currency;
-                /**
-                 * The status of the payment associated with the payment request. It can have one of the following values:
-                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
-                 * - `succeeded`: the payment of the payment request has been successfully processed.
-                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
-                 * @example "succeeded"
-                 */
-                payment_status: "pending" | "succeeded" | "failed";
-                /**
-                 * The date and time when the payment request 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 payment request was initially created.
-                 * @format date-time
-                 * @example "2022-04-29T08:59:51Z"
-                 */
-                created_at: string;
-                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
-                customer: any;
-                invoices: any[];
-            };
+            payment_request: PaymentRequestObject;
         }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
          * @description This endpoint is used to list all existing payment requests.
@@ -5668,10 +5851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<{
-            payment_requests: any[];
-            meta: PaginationMeta;
-        }, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
     };
     plans: {
         /**
@@ -5819,6 +5999,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             status?: string;
         }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionLifetimeUsage
+         * @summary Retrive subscription lifetime usage
+         * @request GET:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        getSubscriptionLifetimeUsage: (externalId: string, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to update the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionLifetimeUsage
+         * @summary Update a subscription lifetime usage
+         * @request PUT:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        updateSubscriptionLifetimeUsage: (externalId: string, data: LifetimeUsageInput, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     taxes: {
         /**

package/script/openapi/client.js

@@ -19,7 +19,7 @@ var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType = exports.ContentType || (exports.ContentType = {}));
 class HttpClient {
-    baseUrl = "https://{region}.getlago.com/api/v1";
+    baseUrl = "https://api{region}getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -152,9 +152,9 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.11.0
+ * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -837,6 +837,23 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query, params = {}) => this.request({
+            path: `/events`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -978,7 +995,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices
@@ -1387,6 +1404,40 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionLifetimeUsage
+         * @summary Retrive subscription lifetime usage
+         * @request GET:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        getSubscriptionLifetimeUsage: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/lifetime_usage`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows you to update the lifetime usage of a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionLifetimeUsage
+         * @summary Update a subscription lifetime usage
+         * @request PUT:/subscriptions/{external_id}/lifetime_usage
+         * @secure
+         */
+        updateSubscriptionLifetimeUsage: (externalId, data, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/lifetime_usage`,
+            method: "PUT",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
     };
     taxes = {
         /**