lago-javascript-client 0.48.0-beta → 0.51.0-beta

package/esm/openapi/client.d.ts

@@ -4,6 +4,11 @@ export interface AddOnBaseInput {
      * @example "Setup Fee"
      */
     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 "Setup Fee (SF1)"
+     */
+    invoice_display_name?: string;
     /**
      * Unique code used to identify the add-on.
      * @example "setup_fee"
@@ -42,6 +47,11 @@ export interface AddOnObject {
      * @example "Setup Fee"
      */
     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 "Setup Fee (SF1)"
+     */
+    invoice_display_name?: string;
     /**
      * Unique code used to identify the add-on.
      * @example "setup_fee"
@@ -380,10 +390,10 @@ export interface BillableMetricObject {
      */
     field_name?: string | null;
     /**
-     * Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
+     * Aggregation method used to compute usage for this billable metric.
      * @example "sum_agg"
      */
-    aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg";
+    aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg" | "latest_agg";
     /**
      * Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.
      * @example "seconds"
@@ -438,10 +448,10 @@ export interface BillableMetricBaseInput {
      */
     field_name?: string | null;
     /**
-     * Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
+     * Aggregation method used to compute usage for this billable metric.
      * @example "sum_agg"
      */
-    aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg";
+    aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg" | "latest_agg";
     /**
      * Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.
      * @example "seconds"
@@ -502,6 +512,11 @@ export interface ChargeObject {
      * @example "requests"
      */
     billable_metric_code: 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 date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
      * @format date-time
@@ -884,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.
@@ -1071,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
@@ -1208,6 +1348,11 @@ export interface CustomerChargeUsageObject {
      * @example "1.0"
      */
     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 by the customer for a specific charge item.
      * @example 123
@@ -1277,6 +1422,11 @@ export interface CustomerChargeUsageObject {
          * @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
@@ -1553,6 +1703,10 @@ export type CustomerObjectExtended = CustomerObject & {
     /** List of customer taxes */
     taxes?: TaxObject[];
 };
+export interface CustomerPastUsage {
+    usage_periods: CustomerUsage[];
+    meta: PaginationMeta;
+}
 export interface CustomersPaginated {
     customers: CustomerObjectExtended[];
     meta: PaginationMeta;
@@ -1579,6 +1733,12 @@ export interface CustomerUsageObject {
      * @example "2022-08-01T23:59:59Z"
      */
     issuing_date: string;
+    /**
+     * A unique identifier associated with the invoice related to this particular usage record.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_invoice_id?: string | null;
     /** The currency of the customer’s current usage. */
     currency?: Currency;
     /**
@@ -1714,12 +1874,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"
@@ -1745,12 +1905,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
@@ -1822,6 +1982,11 @@ export interface FeeObject {
      * @example "external_id"
      */
     external_subscription_id?: string | null;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
+     * @example "Setup Fee (SF1)"
+     */
+    invoice_display_name?: string;
     /**
      * The cost of this specific fee, excluding any applicable taxes.
      * @example 100
@@ -1844,6 +2009,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
@@ -1929,6 +2099,16 @@ export interface FeeObject {
          * @example "Startup"
          */
         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 "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
@@ -1984,6 +2164,11 @@ export interface GroupPropertiesObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     group_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 group will be used as the default display name.
+     * @example "AWS"
+     */
+    invoice_display_name?: string;
     /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
     values: ChargeProperties;
 }
@@ -2168,6 +2353,11 @@ export interface InvoiceOneOffCreateInput {
              * @example "setup_fee"
              */
             add_on_code: 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 Fee (SF1)"
+             */
+            invoice_display_name?: string;
             /**
              * The amount of the fee per unit, expressed in cents. By default, the amount of the add-on is used.
              * @example 12000
@@ -2440,6 +2630,11 @@ export interface PlanCreateInput {
          * @example "Startup"
          */
         name?: 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 code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
          * @example "startup"
@@ -2484,7 +2679,7 @@ export interface PlanCreateInput {
         tax_codes?: string[];
         /**
          * Additional usage-based charges for this plan.
-         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
          */
         charges?: {
             /**
@@ -2508,6 +2703,11 @@ export interface PlanCreateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * 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;
             /**
              * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
              *
@@ -2542,6 +2742,77 @@ 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;
+        /**
+         * 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: {
         /**
@@ -2549,6 +2820,11 @@ export interface PlanUpdateInput {
          * @example "Startup"
          */
         name?: 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 code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
          * @example "startup"
@@ -2593,7 +2869,7 @@ export interface PlanUpdateInput {
         tax_codes?: string[];
         /**
          * Additional usage-based charges for this plan.
-         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
          */
         charges?: {
             /**
@@ -2623,6 +2899,11 @@ export interface PlanUpdateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * 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;
             /**
              * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
              *
@@ -2669,6 +2950,11 @@ export interface PlanObject {
      * @example "Startup"
      */
     name: 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 date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created.
      * @format date-time
@@ -2724,7 +3010,7 @@ export interface PlanObject {
     draft_invoices_count: number;
     /**
      * Additional usage-based charges for this plan.
-     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
@@ -2735,7 +3021,7 @@ export interface PlansPaginated {
     meta: PaginationMeta;
 }
 export interface Subscription {
-    subscription: SubscriptionObject;
+    subscription: SubscriptionObjectExtended;
 }
 export interface SubscriptionCreateInput {
     subscription: {
@@ -2776,6 +3062,8 @@ export interface SubscriptionCreateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
+        /** Based plan overrides. */
+        plan_overrides?: PlanOverridesObject;
     };
 }
 export interface SubscriptionUpdateInput {
@@ -2797,6 +3085,8 @@ export interface SubscriptionUpdateInput {
          * @example "2022-08-08T00:00:00Z"
          */
         subscription_at?: string;
+        /** Based plan overrides. */
+        plan_overrides?: PlanOverridesObject;
     };
 }
 export interface SubscriptionObject {
@@ -2899,6 +3189,9 @@ export interface SubscriptionObject {
      */
     downgrade_plan_date?: string | null;
 }
+export type SubscriptionObjectExtended = SubscriptionObject & {
+    plan?: PlanObject;
+};
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
     meta: PaginationMeta;
@@ -3352,7 +3645,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.48.0-beta
+ * @version 0.49.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -3681,6 +3974,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.
          *
@@ -3788,6 +4091,42 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             external_subscription_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
+         *
+         * @tags customers
+         * @name FindAllCustomerPastUsage
+         * @summary Retrieve customer past usage
+         * @request GET:/customers/{external_customer_id}/past_usage
+         * @secure
+         */
+        findAllCustomerPastUsage: (externalCustomerId: string, query: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * The unique identifier of the subscription within your application.
+             * @example "sub_1234567890"
+             */
+            external_subscription_id: string;
+            /**
+             * Billable metric code filter to apply to the charge usage
+             * @example "cpu"
+             */
+            billable_metric_code?: string;
+            /**
+             * Number of past billing period to returns in the result
+             * @example 5
+             */
+            periods_count?: number;
+        }, params?: RequestParams) => Promise<HttpResponse<CustomerPastUsage, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
     };
     events: {
         /**
@@ -3799,7 +4138,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.
          *
@@ -3807,6 +4146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
+         * @deprecated
          * @secure
          */
         createBatchEvents: (data: EventBatchInput, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
@@ -4185,6 +4525,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             status?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint retrieves a specific subscription.
+         *
+         * @tags subscriptions
+         * @name FindSubscription
+         * @summary Retrieve a subscription
+         * @request GET:/subscriptions/{external_id}
+         * @secure
+         */
+        findSubscription: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to update a subscription.
          *