lago-javascript-client 0.48.0-beta → 0.49.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
@@ -1208,6 +1223,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 +1297,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 +1578,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 +1608,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;
     /**
@@ -1822,6 +1857,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
@@ -1929,6 +1969,11 @@ 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;
         /**
          * 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 +2029,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 +2218,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 +2495,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 +2544,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 +2568,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.
              *
@@ -2549,6 +2614,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 +2663,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 +2693,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 +2744,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 +2804,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. */
@@ -3352,7 +3432,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
@@ -3788,6 +3868,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: {
         /**
@@ -3807,6 +3923,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 +4302,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.
          *

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @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
@@ -692,6 +692,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @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, query, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/past_usage`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     events = {
         /**
@@ -718,6 +735,7 @@ export class Api extends HttpClient {
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
+         * @deprecated
          * @secure
          */
         createBatchEvents: (data, params = {}) => this.request({
@@ -1093,6 +1111,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves a specific subscription.
+         *
+         * @tags subscriptions
+         * @name FindSubscription
+         * @summary Retrieve a subscription
+         * @request GET:/subscriptions/{external_id}
+         * @secure
+         */
+        findSubscription: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint allows you to update a subscription.
          *

package/package.json

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

package/script/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
@@ -1208,6 +1223,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 +1297,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 +1578,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 +1608,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;
     /**
@@ -1822,6 +1857,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
@@ -1929,6 +1969,11 @@ 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;
         /**
          * 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 +2029,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 +2218,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 +2495,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 +2544,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 +2568,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.
              *
@@ -2549,6 +2614,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 +2663,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 +2693,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 +2744,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 +2804,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. */
@@ -3352,7 +3432,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
@@ -3788,6 +3868,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: {
         /**
@@ -3807,6 +3923,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 +4302,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.
          *

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @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
@@ -696,6 +696,23 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @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, query, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/past_usage`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     events = {
         /**
@@ -722,6 +739,7 @@ class Api extends HttpClient {
          * @name CreateBatchEvents
          * @summary Batch multiple events
          * @request POST:/events/batch
+         * @deprecated
          * @secure
          */
         createBatchEvents: (data, params = {}) => this.request({
@@ -1097,6 +1115,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves a specific subscription.
+         *
+         * @tags subscriptions
+         * @name FindSubscription
+         * @summary Retrieve a subscription
+         * @request GET:/subscriptions/{external_id}
+         * @secure
+         */
+        findSubscription: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint allows you to update a subscription.
          *