lago-javascript-client 0.51.0-beta → 0.56.0-beta

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.
@@ -1373,6 +1441,11 @@ export interface CustomerChargeUsageObject {
          * @example "graduated"
          */
         charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
+        /**
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
+         * @example "Setup"
+         */
+        invoice_display_name?: string;
     };
     /** The related billable metric object. */
     billable_metric: {
@@ -1399,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: {
@@ -1763,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: {
@@ -1961,24 +1968,24 @@ export interface FeeObject {
      */
     lago_true_up_parent_fee_id?: string | null;
     /**
-     * Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true).
+     * Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_subscription_id?: string | null;
     /**
-     * Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true).
+     * Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_customer_id?: string | null;
     /**
-     * Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true).
+     * Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.
      * @example "external_id"
      */
     external_customer_id?: string | null;
     /**
-     * Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true).
+     * Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.
      * @example "external_id"
      */
     external_subscription_id?: string | null;
@@ -2082,6 +2089,178 @@ export interface FeeObject {
      * @example "transaction_1234567890"
      */
     event_transaction_id?: string | null;
+    /** List of all unit amount details for calculating the fee. */
+    amount_details?: {
+        /** Graduated ranges, used for a `graduated` charge model. */
+        graduated_ranges?: {
+            /**
+             * Total units received in Lago.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            units: string;
+            /**
+             * Lower value of a tier. It is either 0 or the previous range's `to_value + 1`.
+             * @example 0
+             */
+            from_value: number;
+            /**
+             * Highest value of a tier.
+             * - This value is higher than the from_value of the same tier.
+             * - This value is null for the last tier.
+             * @example 10
+             */
+            to_value: number | null;
+            /**
+             * Flat unit amount within a specified tier.
+             * @example "1.0"
+             */
+            flat_unit_amount: string;
+            /**
+             * Amount per unit within a specified tier.
+             * @example "1.0"
+             */
+            per_unit_amount: string;
+            /**
+             * Total amount of received units to be charged within a specified tier.
+             * @example "10.0"
+             */
+            per_unit_total_amount: string;
+            /**
+             * Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.
+             * @example "11.0"
+             */
+            total_with_flat_amount: string;
+        }[];
+        /** Graduated percentage ranges, used for a `graduated_percentage` charge model. */
+        graduated_percentage_ranges?: {
+            /**
+             * Total units received in Lago.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            units: string;
+            /**
+             * Lower value of a tier. It is either 0 or the previous range's `to_value + 1`.
+             * @example 0
+             */
+            from_value: number;
+            /**
+             * Highest value of a tier.
+             * - This value is higher than the from_value of the same tier.
+             * - This value is null for the last tier.
+             * @example 10
+             */
+            to_value: number | null;
+            /**
+             * Flat unit amount within a specified tier.
+             * @example "1.0"
+             */
+            flat_unit_amount: string;
+            /**
+             * Percentage rate applied within a specified tier.
+             * @format ^[0-9]+.?[0-9]*$
+             * @example "1.0"
+             */
+            rate: string;
+            /**
+             * Total amount of received units to be charged within a specified tier.
+             * @example "10.0"
+             */
+            per_unit_total_amount: string;
+            /**
+             * Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.
+             * @example "11.0"
+             */
+            total_with_flat_amount: string;
+        }[];
+        /**
+         * The quantity of units that are provided free of charge for each billing period in a `package` charge model.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "10.0"
+         */
+        free_units?: string;
+        /**
+         * The quantity of units that are not provided free of charge for each billing period in a `package` charge model.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "40.0"
+         */
+        paid_units?: string;
+        /**
+         * The quantity of units included, defined for Package or Percentage charge model.
+         * @example 1000
+         */
+        per_package_size?: number;
+        /**
+         * Total amount to charge for received paid_units, defined for Package or Percentage charge model.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "0.5"
+         */
+        per_package_unit_amount?: string;
+        /**
+         * The total units received in Lago for the Percentage charge model.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "20.0"
+         */
+        units?: string;
+        /**
+         * Total number of free events allowed for the Percentage charge model.
+         * @example 10
+         */
+        free_events?: number;
+        /**
+         * Percentage rate applied for the Percentage charge model.
+         * @format ^[0-9]+.?[0-9]*$
+         * @example "1.0"
+         */
+        rate?: string;
+        /**
+         * Total amount of received units to be charged for the Percentage charge model.
+         * @example "10.0"
+         */
+        per_unit_total_amount?: string;
+        /**
+         * Total number of paid events for the Percentage charge model.
+         * @example 20
+         */
+        paid_events?: number;
+        /**
+         * Fixed fee unit price per received paid_event for the Percentage charge model.
+         * @example "1.0"
+         */
+        fixed_fee_unit_amount?: string;
+        /**
+         * Total amount to charge for received paid_events for the Percentage charge model.
+         * @example "20.0"
+         */
+        fixed_fee_total_amount?: string;
+        /**
+         * Total adjustment amount linked to minimum and maximum spending per transaction for the Percentage charge model.
+         * @example "20.0"
+         */
+        min_max_adjustment_total_amount?: string;
+        /** Volume ranges, used for a `volume` charge model. */
+        volume_ranges?: {
+            /**
+             * The flat amount for a whole tier, excluding tax, for a `volume` charge model.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "0.5"
+             */
+            per_unit_amount: string;
+            /**
+             * The unit price, excluding tax, for a specific tier of a `volume` charge model.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            flat_unit_amount: string;
+            /**
+             * Total amount of received units to be charged.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            per_unit_total_amount: string;
+        }[];
+    };
     /** Item attached to the fee */
     item: {
         /**
@@ -2120,6 +2299,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[];
@@ -2139,6 +2320,23 @@ export interface FeeUpdateInput {
         payment_status: "pending" | "succeeded" | "failed" | "refunded";
     };
 }
+export interface GrossRevenueObject {
+    /**
+     * Identifies the month to analyze revenue.
+     * @example "2023-11-01T00:00:00.000Z"
+     */
+    month: string;
+    /**
+     * The total amount of revenue for a period, expressed in cents.
+     * @example 50000
+     */
+    amount_cents?: number;
+    /** The currency of revenue analytics. Format must be ISO 4217. */
+    currency?: Currency;
+}
+export interface GrossRevenues {
+    gross_revenues: GrossRevenueObject[];
+}
 export interface GroupObject {
     /**
      * Unique identifier of a specific group associated with the billable metric.
@@ -2176,6 +2374,23 @@ export interface GroupsPaginated {
     groups: GroupObject[];
     meta: PaginationMeta;
 }
+export interface MrrObject {
+    /**
+     * Identifies the month to analyze MRR.
+     * @example "2023-11-01T00:00:00.000Z"
+     */
+    month: string;
+    /**
+     * The total amount of MRR, expressed in cents.
+     * @example 50000
+     */
+    amount_cents?: number;
+    /** The currency of MRR analytics. Format must be ISO 4217. */
+    currency?: Currency;
+}
+export interface Mrrs {
+    mrrs: MrrObject[];
+}
 export interface Invoice {
     invoice: InvoiceObjectExtended;
 }
@@ -2192,6 +2407,55 @@ export type InvoiceAppliedTaxObject = BaseAppliedTax & {
      */
     fees_amount_cents?: number;
 };
+export interface InvoiceCollectionObject {
+    /**
+     * Identifies the month to analyze revenue.
+     * @example "2023-11-01T00:00:00.000Z"
+     */
+    month: string;
+    /**
+     * The payment status of the invoices.
+     * @example "succeeded"
+     */
+    payment_status?: "pending" | "succeeded" | "failed";
+    /**
+     * Contains invoices count.
+     * @example 10
+     */
+    invoices_count: number;
+    /**
+     * The total amount of revenue for a period, expressed in cents.
+     * @example 50000
+     */
+    amount_cents: number;
+    /** The currency of revenue analytics. Format must be ISO 4217. */
+    currency?: Currency;
+}
+export interface InvoiceCollections {
+    invoice_collections: InvoiceCollectionObject[];
+}
+export interface InvoicedUsageObject {
+    /**
+     * Identifies the month to analyze revenue.
+     * @example "2023-11-01T00:00:00.000Z"
+     */
+    month: string;
+    /**
+     * The code of the usage-based billable metrics.
+     * @example "code1"
+     */
+    code?: string;
+    /**
+     * The total amount of revenue for a period, expressed in cents.
+     * @example 50000
+     */
+    amount_cents: number;
+    /** The currency of revenue analytics. Format must be ISO 4217. */
+    currency: Currency;
+}
+export interface InvoicedUsages {
+    invoiced_usages: InvoicedUsageObject[];
+}
 export interface InvoiceMetadataObject {
     /**
      * Unique identifier assigned to the invoice metadata within the Lago application.
@@ -2259,9 +2523,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.
@@ -2464,6 +2729,8 @@ export interface OrganizationObject {
     webhook_urls?: string[] | null;
     /** The country of your organization. */
     country?: Country;
+    /** The default currency of an organization. */
+    default_currency?: Currency;
     /**
      * The first line of your organization’s billing address.
      * @example "100 Brex Street"
@@ -2505,6 +2772,21 @@ export interface OrganizationObject {
      * @example null
      */
     legal_number?: string | null;
+    /**
+     * This parameter configures the method of incrementing invoice numbers for your customers.
+     *
+     * - `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.
+     * - `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
+     *
+     * The default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
+     * @example "per_customer"
+     */
+    document_numbering: "per_customer" | "per_organization";
+    /**
+     * Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
+     * @example "ORG-1234"
+     */
+    document_number_prefix: string;
     /**
      * The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
      * @example 30
@@ -2531,6 +2813,8 @@ export interface OrganizationUpdateInput {
         webhook_url?: string | null;
         /** The country of your organization. */
         country?: Country;
+        /** The default currency of an organization. */
+        default_currency?: Currency;
         /**
          * The first line of your organization’s billing address.
          * @example "100 Brex Street"
@@ -2572,6 +2856,21 @@ export interface OrganizationUpdateInput {
          * @example null
          */
         legal_number?: string | null;
+        /**
+         * This parameter configures the method of incrementing invoice numbers for your customers.
+         *
+         * - `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.
+         * - `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
+         *
+         * The default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
+         * @example "per_customer"
+         */
+        document_numbering?: "per_customer" | "per_organization";
+        /**
+         * Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
+         * @example "ORG-1234"
+         */
+        document_number_prefix?: string;
         /**
          * The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
          * @example 30
@@ -2784,6 +3083,12 @@ export interface PlanOverridesObject {
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
         id?: string;
+        /**
+         * Unique identifier of the billable metric created by Lago.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        billable_metric_id?: string;
         /**
          * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
          * @example "Setup"
@@ -3067,6 +3372,11 @@ export interface SubscriptionCreateInput {
     };
 }
 export interface SubscriptionUpdateInput {
+    /**
+     * If the field is not defined and multiple `active` and `pending` subscriptions exists, Lago will update the `active` subscription. However, if you wish to update a `pending` subscription, please ensure that you include the `status` attribute with the `pending` value in your request body.
+     * @example "active"
+     */
+    status?: "active" | "pending";
     subscription: {
         /**
          * The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.
@@ -3184,8 +3494,8 @@ export interface SubscriptionObject {
     next_plan_code?: string | null;
     /**
      * The date when the plan will be downgraded, represented in ISO 8601 date format.
-     * @format date-time
-     * @example null
+     * @format date
+     * @example "2022-04-30"
      */
     downgrade_plan_date?: string | null;
 }
@@ -3339,6 +3649,25 @@ export interface WalletCreateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
+        recurring_transaction_rules?: {
+            /**
+             * The rule type. Possible values are `interval` or `threshold`.
+             * @example "interval"
+             */
+            rule_type: "interval" | "threshold";
+            /**
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is `interval`.
+             * @example "monthly"
+             */
+            interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+            /**
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "20.0"
+             */
+            threshold_credits?: string;
+        }[];
     };
 }
 export interface WalletObject {
@@ -3424,6 +3753,71 @@ export interface WalletObject {
      * @example "2022-09-14T16:35:31Z"
      */
     terminated_at?: string | null;
+    /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
+    recurring_transaction_rules?: {
+        /**
+         * A unique identifier for the recurring transaction rule in the Lago application. Can be used to update a recurring transaction rule.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string;
+        /**
+         * The rule type. Possible values are `interval` or `threshold`.
+         * @example "interval"
+         */
+        rule_type: "interval" | "threshold";
+        /**
+         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`.
+         * @example "monthly"
+         */
+        interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+        /**
+         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "20.0"
+         */
+        threshold_credits?: string;
+        /**
+         * The number of paid credits. Required only if there is no granted credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "20.0"
+         */
+        paid_credits: string;
+        /**
+         * The number of free granted credits. Required only if there is no paid credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "10.0"
+         */
+        granted_credits: string;
+        /**
+         * The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created
+         * @format date-time
+         * @example "2022-04-29T08:59:51Z"
+         */
+        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[];
@@ -3518,6 +3912,43 @@ export interface WalletUpdateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
+        recurring_transaction_rules?: {
+            /**
+             * A unique identifier for the recurring transaction rule in the Lago application. Can be used to update a recurring transaction rule.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_id?: string;
+            /**
+             * The rule type. Possible values are `interval` or `threshold`.
+             * @example "interval"
+             */
+            rule_type?: "interval" | "threshold";
+            /**
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is set to `interval`.
+             * @example "monthly"
+             */
+            interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+            /**
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "20.0"
+             */
+            threshold_credits?: string;
+            /**
+             * The number of paid credits. Required only if there is no granted credits.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "20.0"
+             */
+            paid_credits?: string;
+            /**
+             * The number of free granted credits. Required only if there is no paid credits.
+             * @pattern ^[0-9]+.?[0-9]*$
+             * @example "10.0"
+             */
+            granted_credits?: string;
+        }[];
     };
 }
 export interface WebhookEndpoint {
@@ -3645,7 +4076,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.49.0-beta
+ * @version 0.56.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -3717,6 +4148,77 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
+    analytics: {
+        /**
+         * @description Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
+         *
+         * @tags analytics
+         * @name FindAllGrossRevenues
+         * @summary List gross revenue
+         * @request GET:/analytics/gross_revenue
+         * @secure
+         */
+        findAllGrossRevenues: (query?: {
+            /** Currency of revenue analytics. Format must be ISO 4217. */
+            currency?: Currency;
+            /**
+             * The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<GrossRevenues, ApiErrorUnauthorized>>;
+        /**
+         * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
+         *
+         * @tags analytics
+         * @name FindAllInvoiceCollections
+         * @summary List of finalized invoices
+         * @request GET:/analytics/invoice_collection
+         * @secure
+         */
+        findAllInvoiceCollections: (query?: {
+            /** The currency of revenue analytics. Format must be ISO 4217. */
+            currency?: Currency;
+        }, params?: RequestParams) => Promise<HttpResponse<InvoiceCollections, ApiErrorUnauthorized>>;
+        /**
+         * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
+         *
+         * @tags analytics
+         * @name FindAllInvoicedUsages
+         * @summary List usage revenue
+         * @request GET:/analytics/invoiced_usage
+         * @secure
+         */
+        findAllInvoicedUsages: (query?: {
+            /** The currency of invoiced usage analytics. Format must be ISO 4217. */
+            currency?: Currency;
+        }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
+        /**
+         * @description This endpoint is used to list MRR.
+         *
+         * @tags analytics
+         * @name FindAllMrrs
+         * @summary List MRR
+         * @request GET:/analytics/mrr
+         * @secure
+         */
+        findAllMrrs: (query?: {
+            /**
+             * Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:
+             *
+             * - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.
+             * - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).
+             * - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next  remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
+             * - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
+             */
+            currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
+        }, params?: RequestParams) => Promise<HttpResponse<Mrrs, ApiErrorUnauthorized>>;
+    };
     appliedCoupons: {
         /**
          * @description This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
@@ -4127,6 +4629,39 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             periods_count?: number;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerPastUsage, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint regenerates the Payment Provider Checkout URL of a Customer.
+         *
+         * @tags customers
+         * @name GenerateCustomerCheckoutUrl
+         * @summary Generate a Customer Payment Provider Checkout URL
+         * @request POST:/customers/{external_customer_id}/checkout_url
+         * @secure
+         */
+        generateCustomerCheckoutUrl: (externalCustomerId: string, params?: RequestParams) => Promise<HttpResponse<{
+            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: {
         /**
@@ -4140,13 +4675,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 is used to send a batch of usage records.
          *
          * @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>>;
@@ -4402,6 +4936,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         retryPayment: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for voiding an invoice. You can void an invoice only when it's in a `finalized` status, and the payment status is not `succeeded`.
+         *
+         * @tags invoices
+         * @name VoidInvoice
+         * @summary Void an invoice
+         * @request POST:/invoices/{lago_id}/void
+         * @secure
+         */
+        voidInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     organizations: {
         /**