lago-javascript-client 0.53.0-beta → 1.0.0

package/esm/openapi/client.d.ts

@@ -174,7 +174,7 @@ export interface AppliedCouponInput {
          * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
          * @example "recurring"
          */
-        frequency?: "once" | "recurring" | null;
+        frequency?: "once" | "recurring" | "forever" | null;
         /**
          * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
          * @example 3
@@ -260,7 +260,7 @@ export interface AppliedCouponObject {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency: "once" | "recurring";
+    frequency: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 3
@@ -663,6 +663,11 @@ export interface ChargeProperties {
      * @example "1.75"
      */
     per_transaction_min_amount?: string | null;
+    /**
+     * The list of event properties that are used to group the events on the invoice for a `standard` charge model.
+     * @example ["agent_name"]
+     */
+    grouped_by?: string[];
     /** Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. */
     volume_ranges?: {
         /**
@@ -746,7 +751,7 @@ export interface CouponBaseInput {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency?: "once" | "recurring";
+    frequency?: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 6
@@ -859,7 +864,7 @@ export interface CouponObject {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency: "once" | "recurring";
+    frequency: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 6
@@ -1315,6 +1320,11 @@ export interface CustomerBillingConfiguration {
      * @example "stripe"
      */
     payment_provider?: "stripe" | "adyen" | "gocardless";
+    /**
+     * Unique code used to identify a payment provider connection.
+     * @example "stripe-eu-1"
+     */
+    payment_provider_code?: string;
     /**
      * The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer
      * @example "cus_12345"
@@ -1341,6 +1351,64 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+export type CustomerChargeGroupedUsageObject = {
+    /**
+     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * The number of units consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /** Key value list of event properties aggregated by the charge model */
+    grouped_by?: Record<string, string>;
+    /** Array of group object, representing multiple dimensions for a charge item. */
+    groups?: CustomerChargeGroupsUsageObject;
+}[];
+/** Array of group object, representing multiple dimensions for a charge item. */
+export type CustomerChargeGroupsUsageObject = {
+    /**
+     * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id?: string;
+    /**
+     * The group key, only returned for groups with two dimensions.
+     * @example null
+     */
+    key?: string | null;
+    /**
+     * The group value.
+     * @example "europe"
+     */
+    value?: string;
+    /**
+     * The number of units consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+}[];
 export interface CustomerChargeUsageObject {
     /**
      * The number of units consumed by the customer for a specific charge item.
@@ -1404,40 +1472,9 @@ export interface CustomerChargeUsageObject {
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
     };
     /** Array of group object, representing multiple dimensions for a charge item. */
-    groups: {
-        /**
-         * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
-         * @format uuid
-         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-         */
-        lago_id?: string;
-        /**
-         * The group key, only returned for groups with two dimensions.
-         * @example null
-         */
-        key?: string | null;
-        /**
-         * The group value.
-         * @example "europe"
-         */
-        value?: string;
-        /**
-         * The number of units consumed for a specific group related to a charge item.
-         * @pattern ^[0-9]+.?[0-9]*$
-         * @example "0.9"
-         */
-        units?: string;
-        /**
-         * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
-         * @example 10
-         */
-        events_count?: number;
-        /**
-         * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
-         * @example 1000
-         */
-        amount_cents?: number;
-    }[];
+    groups: CustomerChargeGroupsUsageObject;
+    /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+    grouped_usage?: CustomerChargeGroupedUsageObject;
 }
 export interface CustomerCreateInput {
     customer: {
@@ -1768,42 +1805,7 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    event: {
-        /**
-         * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
-         * @example "transaction_1234567890"
-         */
-        transaction_id: string;
-        /**
-         * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_ids`, targeting a specific subscription.
-         * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-         */
-        external_customer_id?: string;
-        /**
-         * Array of unique identifiers of the targeted subscriptions within your application.
-         * @example ["sub_1234567890","sub_0987654321"]
-         */
-        external_subscription_ids: 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"
-         */
-        code: string;
-        /**
-         * This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.
-         * @example 1651240791
-         */
-        timestamp?: number;
-        /**
-         * 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}
-         */
-        properties?: {
-            /** The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. */
-            operation_type?: "add" | "remove";
-            [key: string]: any;
-        };
-    };
+    events: EventInput[];
 }
 export interface EventEstimateFeesInput {
     event: {
@@ -1814,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1835,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1882,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -2156,10 +2164,11 @@ export interface FeeObject {
              */
             flat_unit_amount: string;
             /**
-             * Amount per unit within a specified tier.
+             * Percentage rate applied within a specified tier.
+             * @format ^[0-9]+.?[0-9]*$
              * @example "1.0"
              */
-            per_unit_amount: string;
+            rate: string;
             /**
              * Total amount of received units to be charged within a specified tier.
              * @example "10.0"
@@ -2206,10 +2215,11 @@ export interface FeeObject {
          */
         free_events?: number;
         /**
-         * Amount per unit for the Percentage charge model.
+         * Percentage rate applied for the Percentage charge model.
+         * @format ^[0-9]+.?[0-9]*$
          * @example "1.0"
          */
-        per_unit_amount?: string;
+        rate?: string;
         /**
          * Total amount of received units to be charged for the Percentage charge model.
          * @example "10.0"
@@ -2295,6 +2305,8 @@ export interface FeeObject {
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
+        /** Key value list of event properties aggregated by the charge model */
+        grouped_by?: Record<string, string>;
     };
     /** List of fee applied taxes */
     applied_taxes?: FeeAppliedTaxObject[];
@@ -2517,9 +2529,10 @@ export interface InvoiceObject {
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
      * @example "finalized"
      */
-    status: "draft" | "finalized";
+    status: "draft" | "finalized" | "voided";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -3789,6 +3802,28 @@ export interface WalletObject {
          */
         created_at: string;
     }[];
+    /**
+     * The wallet ongoing balance expressed in cents.
+     * @example 800
+     */
+    ongoing_balance_cents: number;
+    /**
+     * The wallet ongoing usage balance expressed in cents.
+     * @example 200
+     */
+    ongoing_usage_balance_cents: number;
+    /**
+     * The wallet ongoing balance expressed in credits.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "8.0"
+     */
+    credits_ongoing_balance: string;
+    /**
+     * The wallet ongoing usage balance expressed in credits.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "2.0"
+     */
+    credits_ongoing_usage_balance: string;
 }
 export interface WalletsPaginated {
     wallets: WalletObject[];
@@ -4047,7 +4082,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.53.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4458,11 +4493,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4610,26 +4645,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         generateCustomerCheckoutUrl: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<{
-            /**
-             * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            lago_customer_id?: string | undefined;
-            /**
-             * The customer external unique identifier (provided by your own application)
-             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-             */
-            external_customer_id?: string | undefined;
-            /**
-             * The Payment Provider name linked to the Customer.
-             * @example "stripe"
-             */
-            payment_provider?: string | undefined;
-            /**
-             * The new generated Payment Provider Checkout URL for the Customer.
-             * @example "https://foo.bar"
-             */
-            checkout_url?: string | undefined;
+            customer?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The new generated Payment Provider Checkout URL for the Customer.
+                 * @example "https://foo.bar"
+                 */
+                checkout_url?: string | undefined;
+            } | undefined;
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     events: {
@@ -4644,13 +4681,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for transmitting a batch of usage measurement events to multiple subscriptions for a single customer.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
-         * @deprecated
          * @secure
          */
         createBatchEvents: (data: EventBatchInput, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
@@ -4896,6 +4932,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.53.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -647,11 +647,11 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -834,13 +834,12 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for transmitting a batch of usage measurement events to multiple subscriptions for a single customer.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
-         * @deprecated
          * @secure
          */
         createBatchEvents: (data, params = {}) => this.request({
@@ -1057,6 +1056,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -174,7 +174,7 @@ export interface AppliedCouponInput {
          * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
          * @example "recurring"
          */
-        frequency?: "once" | "recurring" | null;
+        frequency?: "once" | "recurring" | "forever" | null;
         /**
          * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
          * @example 3
@@ -260,7 +260,7 @@ export interface AppliedCouponObject {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency: "once" | "recurring";
+    frequency: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 3
@@ -663,6 +663,11 @@ export interface ChargeProperties {
      * @example "1.75"
      */
     per_transaction_min_amount?: string | null;
+    /**
+     * The list of event properties that are used to group the events on the invoice for a `standard` charge model.
+     * @example ["agent_name"]
+     */
+    grouped_by?: string[];
     /** Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. */
     volume_ranges?: {
         /**
@@ -746,7 +751,7 @@ export interface CouponBaseInput {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency?: "once" | "recurring";
+    frequency?: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 6
@@ -859,7 +864,7 @@ export interface CouponObject {
      * - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.
      * @example "recurring"
      */
-    frequency: "once" | "recurring";
+    frequency: "once" | "recurring" | "forever";
     /**
      * Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type
      * @example 6
@@ -1315,6 +1320,11 @@ export interface CustomerBillingConfiguration {
      * @example "stripe"
      */
     payment_provider?: "stripe" | "adyen" | "gocardless";
+    /**
+     * Unique code used to identify a payment provider connection.
+     * @example "stripe-eu-1"
+     */
+    payment_provider_code?: string;
     /**
      * The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer
      * @example "cus_12345"
@@ -1341,6 +1351,64 @@ export interface CustomerBillingConfiguration {
      */
     provider_payment_methods?: string[] | null;
 }
+/** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+export type CustomerChargeGroupedUsageObject = {
+    /**
+     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * The number of units consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /** Key value list of event properties aggregated by the charge model */
+    grouped_by?: Record<string, string>;
+    /** Array of group object, representing multiple dimensions for a charge item. */
+    groups?: CustomerChargeGroupsUsageObject;
+}[];
+/** Array of group object, representing multiple dimensions for a charge item. */
+export type CustomerChargeGroupsUsageObject = {
+    /**
+     * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id?: string;
+    /**
+     * The group key, only returned for groups with two dimensions.
+     * @example null
+     */
+    key?: string | null;
+    /**
+     * The group value.
+     * @example "europe"
+     */
+    value?: string;
+    /**
+     * The number of units consumed for a specific group related to a charge item.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "0.9"
+     */
+    units?: string;
+    /**
+     * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
+     * @example 10
+     */
+    events_count?: number;
+    /**
+     * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
+     * @example 1000
+     */
+    amount_cents?: number;
+}[];
 export interface CustomerChargeUsageObject {
     /**
      * The number of units consumed by the customer for a specific charge item.
@@ -1404,40 +1472,9 @@ export interface CustomerChargeUsageObject {
         aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
     };
     /** Array of group object, representing multiple dimensions for a charge item. */
-    groups: {
-        /**
-         * Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system.
-         * @format uuid
-         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-         */
-        lago_id?: string;
-        /**
-         * The group key, only returned for groups with two dimensions.
-         * @example null
-         */
-        key?: string | null;
-        /**
-         * The group value.
-         * @example "europe"
-         */
-        value?: string;
-        /**
-         * The number of units consumed for a specific group related to a charge item.
-         * @pattern ^[0-9]+.?[0-9]*$
-         * @example "0.9"
-         */
-        units?: string;
-        /**
-         * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
-         * @example 10
-         */
-        events_count?: number;
-        /**
-         * The amount in cents, tax excluded, consumed for a specific group related to a charge item.
-         * @example 1000
-         */
-        amount_cents?: number;
-    }[];
+    groups: CustomerChargeGroupsUsageObject;
+    /** Array of aggregated fees, grouped by the event properties defined in a `standard` charge model. */
+    grouped_usage?: CustomerChargeGroupedUsageObject;
 }
 export interface CustomerCreateInput {
     customer: {
@@ -1768,42 +1805,7 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    event: {
-        /**
-         * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
-         * @example "transaction_1234567890"
-         */
-        transaction_id: string;
-        /**
-         * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_ids`, targeting a specific subscription.
-         * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-         */
-        external_customer_id?: string;
-        /**
-         * Array of unique identifiers of the targeted subscriptions within your application.
-         * @example ["sub_1234567890","sub_0987654321"]
-         */
-        external_subscription_ids: 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"
-         */
-        code: string;
-        /**
-         * This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.
-         * @example 1651240791
-         */
-        timestamp?: number;
-        /**
-         * 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}
-         */
-        properties?: {
-            /** The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. */
-            operation_type?: "add" | "remove";
-            [key: string]: any;
-        };
-    };
+    events: EventInput[];
 }
 export interface EventEstimateFeesInput {
     event: {
@@ -1814,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1835,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1882,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -2156,10 +2164,11 @@ export interface FeeObject {
              */
             flat_unit_amount: string;
             /**
-             * Amount per unit within a specified tier.
+             * Percentage rate applied within a specified tier.
+             * @format ^[0-9]+.?[0-9]*$
              * @example "1.0"
              */
-            per_unit_amount: string;
+            rate: string;
             /**
              * Total amount of received units to be charged within a specified tier.
              * @example "10.0"
@@ -2206,10 +2215,11 @@ export interface FeeObject {
          */
         free_events?: number;
         /**
-         * Amount per unit for the Percentage charge model.
+         * Percentage rate applied for the Percentage charge model.
+         * @format ^[0-9]+.?[0-9]*$
          * @example "1.0"
          */
-        per_unit_amount?: string;
+        rate?: string;
         /**
          * Total amount of received units to be charged for the Percentage charge model.
          * @example "10.0"
@@ -2295,6 +2305,8 @@ export interface FeeObject {
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
+        /** Key value list of event properties aggregated by the charge model */
+        grouped_by?: Record<string, string>;
     };
     /** List of fee applied taxes */
     applied_taxes?: FeeAppliedTaxObject[];
@@ -2517,9 +2529,10 @@ export interface InvoiceObject {
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
      * @example "finalized"
      */
-    status: "draft" | "finalized";
+    status: "draft" | "finalized" | "voided";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -3789,6 +3802,28 @@ export interface WalletObject {
          */
         created_at: string;
     }[];
+    /**
+     * The wallet ongoing balance expressed in cents.
+     * @example 800
+     */
+    ongoing_balance_cents: number;
+    /**
+     * The wallet ongoing usage balance expressed in cents.
+     * @example 200
+     */
+    ongoing_usage_balance_cents: number;
+    /**
+     * The wallet ongoing balance expressed in credits.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "8.0"
+     */
+    credits_ongoing_balance: string;
+    /**
+     * The wallet ongoing usage balance expressed in credits.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "2.0"
+     */
+    credits_ongoing_usage_balance: string;
 }
 export interface WalletsPaginated {
     wallets: WalletObject[];
@@ -4047,7 +4082,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.53.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4458,11 +4493,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4610,26 +4645,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         generateCustomerCheckoutUrl: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<{
-            /**
-             * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
-             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-             */
-            lago_customer_id?: string | undefined;
-            /**
-             * The customer external unique identifier (provided by your own application)
-             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-             */
-            external_customer_id?: string | undefined;
-            /**
-             * The Payment Provider name linked to the Customer.
-             * @example "stripe"
-             */
-            payment_provider?: string | undefined;
-            /**
-             * The new generated Payment Provider Checkout URL for the Customer.
-             * @example "https://foo.bar"
-             */
-            checkout_url?: string | undefined;
+            customer?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The new generated Payment Provider Checkout URL for the Customer.
+                 * @example "https://foo.bar"
+                 */
+                checkout_url?: string | undefined;
+            } | undefined;
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     events: {
@@ -4644,13 +4681,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for transmitting a batch of usage measurement events to multiple subscriptions for a single customer.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
-         * @deprecated
          * @secure
          */
         createBatchEvents: (data: EventBatchInput, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
@@ -4896,6 +4932,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.53.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -651,11 +651,11 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -838,13 +838,12 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for transmitting a batch of usage measurement events to multiple subscriptions for a single customer.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
-         * @deprecated
          * @secure
          */
         createBatchEvents: (data, params = {}) => this.request({
@@ -1061,6 +1060,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *