lago-javascript-client 0.49.0-beta → 0.53.0-beta

package/script/openapi/client.d.ts

@@ -899,6 +899,131 @@ export interface CouponsPaginated {
 export interface CouponUpdateInput {
     coupon: CouponBaseInput;
 }
+export interface CreditNoteEstimateInput {
+    credit_note: {
+        /**
+         * The invoice unique identifier, created by Lago.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        invoice_id: string;
+        /**
+         * The list of credit note’s items.
+         * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
+         */
+        items: {
+            /**
+             * The fee unique identifier, created by Lago.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            fee_id: string;
+            /**
+             * The amount of the credit note item, expressed in cents.
+             * @example 10
+             */
+            amount_cents: number;
+        }[];
+    };
+}
+export interface CreditNoteEstimated {
+    estimated_credit_note: {
+        /**
+         * Unique identifier assigned to the invoice that the credit note belongs to
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_invoice_id: string;
+        /**
+         * The invoice unique number, related to the credit note.
+         * @example "LAG-1234"
+         */
+        invoice_number: string;
+        /** The currency of the credit note. */
+        currency: Currency;
+        /**
+         * The tax amount of the credit note, expressed in cents.
+         * @example 20
+         */
+        taxes_amount_cents: number;
+        /**
+         * The tax rate associated with this specific credit note.
+         * @example 20
+         */
+        taxes_rate: number;
+        /**
+         * The subtotal of the credit note excluding any applicable taxes, expressed in cents.
+         * @example 100
+         */
+        sub_total_excluding_taxes_amount_cents: number;
+        /**
+         * The credited amount of the credit note, expressed in cents.
+         * @example 100
+         */
+        max_creditable_amount_cents: number;
+        /**
+         * The refunded amount of the credit note, expressed in cents.
+         * @example 0
+         */
+        max_refundable_amount_cents: number;
+        /**
+         * The pro-rated amount of the coupons applied to the source invoice.
+         * @example 20
+         */
+        coupons_adjustment_amount_cents: number;
+        /** Array of credit note’s items. */
+        items: {
+            /**
+             * The credit note’s item amount, expressed in cents.
+             * @example 100
+             */
+            amount_cents: number;
+            /**
+             * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_fee_id: string | null;
+        }[];
+        applied_taxes?: {
+            /**
+             * Unique identifier of the tax, created by Lago.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            lago_tax_id?: string;
+            /**
+             * Name of the tax.
+             * @example "TVA"
+             */
+            tax_name?: string;
+            /**
+             * Unique code used to identify the tax associated with the API request.
+             * @example "french_standard_vat"
+             */
+            tax_code?: string;
+            /**
+             * The percentage rate of the tax
+             * @example 20
+             */
+            tax_rate?: number;
+            /**
+             * Internal description of the taxe
+             * @example "French standard VAT"
+             */
+            tax_description?: string;
+            /** @example 100 */
+            base_amount_cents?: number;
+            /**
+             * Amount of the tax
+             * @example 2000
+             */
+            amount_cents?: number;
+            /** Currency of the tax */
+            amount_currency?: Currency;
+        }[];
+    };
+}
 export interface CreditObject {
     /**
      * Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit’s item record within the Lago system.
@@ -1086,7 +1211,7 @@ export interface CreditNoteObject {
      * The pro-rated amount of the coupons applied to the source invoice.
      * @example 20
      */
-    coupons_adjustement_amount_cents: number;
+    coupons_adjustment_amount_cents: number;
     /**
      * The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -1248,6 +1373,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: {
@@ -1749,12 +1879,12 @@ export interface EventObject {
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_customer_id: string;
+    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.
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    external_customer_id: string;
+    external_customer_id: string | null;
     /**
      * 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"
@@ -1780,12 +1910,12 @@ export interface EventObject {
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_subscription_id: string;
+    lago_subscription_id: string | null;
     /**
      * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
      * @example "sub_1234567890"
      */
-    external_subscription_id: string;
+    external_subscription_id: string | null;
     /**
      * The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
      * @format date-time
@@ -1836,24 +1966,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;
@@ -1884,6 +2014,11 @@ export interface FeeObject {
      * @example "0.32"
      */
     units: string;
+    /**
+     * The unit amount of the fee per unit, with precision.
+     * @example "312.5"
+     */
+    precise_unit_amount: string;
     /**
      * The cost of this specific fee, including any applicable taxes.
      * @example 120
@@ -1952,6 +2087,176 @@ 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;
+            /**
+             * 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;
+        }[];
+        /**
+         * 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;
+        /**
+         * Amount per unit for the Percentage charge model.
+         * @example "1.0"
+         */
+        per_unit_amount?: 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: {
         /**
@@ -1974,6 +2279,11 @@ export interface FeeObject {
          * @example "Setup Fee (SF1)"
          */
         invoice_display_name?: 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 "Transactions - ACH"
+         */
+        group_invoice_display_name?: string;
         /**
          * Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`.
          * @format uuid
@@ -2004,6 +2314,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.
@@ -2041,6 +2368,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;
 }
@@ -2057,6 +2401,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.
@@ -2329,6 +2722,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"
@@ -2370,6 +2765,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
@@ -2396,6 +2806,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"
@@ -2437,6 +2849,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
@@ -2607,6 +3034,83 @@ export interface PlanCreateInput {
         }[];
     };
 }
+/** Based plan overrides. */
+export interface PlanOverridesObject {
+    /**
+     * The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.
+     * @example 10000
+     */
+    amount_cents?: number;
+    /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+    amount_currency?: Currency;
+    /**
+     * The description on the plan.
+     * @example "Plan for early stage startups."
+     */
+    description?: string;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.
+     * @example "Startup plan"
+     */
+    invoice_display_name?: string;
+    /**
+     * The name of the plan.
+     * @example "Startup"
+     */
+    name?: string;
+    /**
+     * List of unique code used to identify the taxes.
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+    /**
+     * The duration in days during which the base cost of the plan is offered for free.
+     * @example 5
+     */
+    trial_period?: number;
+    /** Additional usage-based charges for this plan. */
+    charges?: {
+        /**
+         * Unique identifier of the charge created by Lago.
+         * @format uuid
+         * @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"
+         */
+        invoice_display_name?: string;
+        /**
+         * The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.
+         * @example 0
+         */
+        min_amount_cents?: number;
+        /** List of all thresholds utilized for calculating the charge. */
+        properties?: ChargeProperties;
+        /** All charge information, sorted by groups. */
+        group_properties?: {
+            /**
+             * Unique identifier of a billable metric group, created by Lago.
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            group_id: string;
+            /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
+            values: ChargeProperties;
+        }[];
+        /**
+         * List of unique code used to identify the taxes.
+         * @example ["french_standard_vat"]
+         */
+        tax_codes?: string[];
+    }[];
+}
 export interface PlanUpdateInput {
     plan: {
         /**
@@ -2815,7 +3319,7 @@ export interface PlansPaginated {
     meta: PaginationMeta;
 }
 export interface Subscription {
-    subscription: SubscriptionObject;
+    subscription: SubscriptionObjectExtended;
 }
 export interface SubscriptionCreateInput {
     subscription: {
@@ -2856,9 +3360,16 @@ export interface SubscriptionCreateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
+        /** Based plan overrides. */
+        plan_overrides?: PlanOverridesObject;
     };
 }
 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.
@@ -2877,6 +3388,8 @@ export interface SubscriptionUpdateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
+        /** Based plan overrides. */
+        plan_overrides?: PlanOverridesObject;
     };
 }
 export interface SubscriptionObject {
@@ -2974,11 +3487,14 @@ 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;
 }
+export type SubscriptionObjectExtended = SubscriptionObject & {
+    plan?: PlanObject;
+};
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
     meta: PaginationMeta;
@@ -3126,6 +3642,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 {
@@ -3211,6 +3746,49 @@ 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;
+    }[];
 }
 export interface WalletsPaginated {
     wallets: WalletObject[];
@@ -3305,6 +3883,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 {
@@ -3432,7 +4047,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.49.0-beta
+ * @version 0.53.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -3504,6 +4119,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.
@@ -3761,6 +4447,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         downloadCreditNote: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to retrieve amounts for a new credit note creation.
+         *
+         * @tags credit_notes
+         * @name EstimateCreditNote
+         * @summary Estimate amounts for a new credit note
+         * @request POST:/credit_notes/estimate
+         * @secure
+         */
+        estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
          * @description This endpoint voids an existing credit note.
          *
@@ -3904,6 +4600,37 @@ 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<{
+            /**
+             * 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;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     events: {
         /**
@@ -3915,7 +4642,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/events
          * @secure
          */
-        createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        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.
          *
@@ -4179,6 +4906,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: {
         /**