lago-javascript-client 1.7.0 → 1.10.0

package/esm/openapi/client.d.ts

@@ -297,6 +297,19 @@ export interface AppliedCouponsPaginated {
     applied_coupons: AppliedCouponObjectExtended[];
     meta: PaginationMeta;
 }
+export interface AppliedUsageThresholdObject {
+    /**
+     * The amount of usage in cents that has been accumulated over the lifetime of the subscription.
+     * @example 2000
+     */
+    lifetime_usage_amount_cents: number;
+    /**
+     * The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     */
+    created_at: string;
+    usage_threshold: UsageThresholdObject;
+}
 export interface BaseAppliedTax {
     /**
      * Unique identifier of the applied tax, created by Lago.
@@ -559,6 +572,15 @@ export interface ChargeObject {
      * @example true
      */
     invoiceable?: boolean;
+    /**
+     * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+     * This field determines whether and when the charge fee should be included in
+     * the invoice. If `null`, no invoice will be issued for this charge fee.
+     * If `invoice`, an invoice will be generated at the end of the period,
+     * consolidating all charge fees with a succeeded payment status.
+     * @example "invoice"
+     */
+    regroup_paid_fees?: "invoice" | null;
     /**
      * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
      *
@@ -1081,17 +1103,17 @@ export interface CreditObject {
          */
         lago_item_id: string;
         /**
-         * The type of credit applied. Possible values are `coupon` or `credit_note`.
+         * The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice).
          * @example "coupon"
          */
-        type: "coupon" | "credit_note";
+        type: "coupon" | "credit_note" | "invoice";
         /**
-         * The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number.
+         * The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number.
          * @example "startup_deal"
          */
         code: string;
         /**
-         * The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note.
+         * The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number.
          * @example "Startup Deal"
          */
         name: string;
@@ -1400,7 +1422,7 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `[card]`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
      * @example ["card","sepa_debit"]
      */
     provider_payment_methods?: string[] | null;
@@ -1927,7 +1949,26 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    events: {
+    events: any[];
+}
+export interface EventEstimateFeesInput {
+    event: {
+        /**
+         * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
+         * @example "storage"
+         */
+        code: string;
+        /**
+         * The unique identifier of the subscription within your application.
+         * @example "sub_1234567890"
+         */
+        external_subscription_id: string;
+        /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
+        properties?: object;
+    };
+}
+export interface EventInput {
+    event: {
         /**
          * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
          * @example "transaction_1234567890"
@@ -1955,27 +1996,8 @@ export interface EventBatchInput {
          * @example {"gb":10}
          */
         properties?: Record<string, string | number>;
-    }[];
-}
-export interface EventEstimateFeesInput {
-    event: {
-        /**
-         * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
-         * @example "storage"
-         */
-        code: string;
-        /**
-         * The unique identifier of the subscription within your application.
-         * @example "sub_1234567890"
-         */
-        external_subscription_id: string;
-        /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
-        properties?: object;
     };
 }
-export interface EventInput {
-    event: any;
-}
 export interface EventObject {
     /**
      * Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system
@@ -2663,18 +2685,19 @@ export interface InvoiceObject {
      */
     net_payment_term?: number;
     /**
-     * The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`.
+     * The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.
      * @example "subscription"
      */
-    invoice_type: "subscription" | "add_on" | "credit" | "one_off";
+    invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided";
+    status: "draft" | "finalized" | "voided" | "failed";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -2705,7 +2728,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`.
      * - Version 2: is equal to the `fees_amount_cents`.
-     * - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
+     * - Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
      * @example 100
      */
     sub_total_excluding_taxes_amount_cents: number;
@@ -2719,7 +2742,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the `total_amount_cents`.
      * - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`.
-     * - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
+     * - Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
      * @example 120
      */
     sub_total_including_taxes_amount_cents: number;
@@ -2728,6 +2751,11 @@ export interface InvoiceObject {
      * @example 0
      */
     prepaid_credit_amount_cents: number;
+    /**
+     * The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices.
+     * @example 0
+     */
+    progressive_billing_credit_amount_cents: number;
     /**
      * The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.
      * @example 100
@@ -2745,11 +2773,30 @@ export interface InvoiceObject {
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
+    applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
 }
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
     subscriptions?: SubscriptionObject[];
+    error_details?: {
+        /**
+         * Unique identifier assigned to the error_detail within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the error's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string | null;
+        /**
+         * Code that specifies part of the application / connection, where the error originally happened
+         * @example "tax_error"
+         */
+        error_code: string;
+        /**
+         * Key value list of more elaborated error detail, where by the key of error_code an external service error details are stored
+         * @example {"tax_error":"taxDateTooFarInFuture"}
+         */
+        details: object;
+    }[];
 };
 export interface InvoiceOneOffCreateInput {
     invoice: {
@@ -3150,7 +3197,7 @@ export interface PlanCreateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @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},"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"}]}},{"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":{}},{"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"}]}},{"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"}}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"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"}]}},{"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":{}},{"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3174,6 +3221,15 @@ export interface PlanCreateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | 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"
@@ -3203,6 +3259,8 @@ export interface PlanCreateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 /** Based plan overrides. */
@@ -3274,6 +3332,8 @@ export interface PlanOverridesObject {
          */
         tax_codes?: string[];
     }[];
+    /** List of usage thresholds applied to the subscription. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlanUpdateInput {
     plan: {
@@ -3333,7 +3393,7 @@ export interface PlanUpdateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @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},"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"}]}},{"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":{}},{"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"}]}},{"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"}}]
+         * @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},"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{}},{"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3363,6 +3423,15 @@ export interface PlanUpdateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | 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"
@@ -3392,6 +3461,8 @@ export interface PlanUpdateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 export interface PlanObject {
@@ -3467,11 +3538,13 @@ export interface PlanObject {
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * 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,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"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"}]},"filters":[]},{"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":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"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"}]},"filters":[]},{"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"},"filters":[]}]
+     * @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,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"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"}]},"filters":[]},{"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":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"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"}]},"filters":[]},{"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,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
     taxes?: TaxObject[];
+    /** List of usage thresholds applied to the plan. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlansPaginated {
     plans: PlanObject[];
@@ -3766,6 +3839,64 @@ export interface TaxUpdateInput {
 }
 /** @example "America/Los_Angeles" */
 export type Timezone = "UTC" | "Africa/Algiers" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Monrovia" | "Africa/Nairobi" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/Chihuahua" | "America/Denver" | "America/Godthab" | "America/Guatemala" | "America/Guyana" | "America/Halifax" | "America/Indiana/Indianapolis" | "America/Juneau" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Mazatlan" | "America/Mexico_City" | "America/Monterrey" | "America/Montevideo" | "America/New_York" | "America/Phoenix" | "America/Puerto_Rico" | "America/Regina" | "America/Santiago" | "America/Sao_Paulo" | "America/St_Johns" | "America/Tijuana" | "Asia/Almaty" | "Asia/Baghdad" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Magadan" | "Asia/Muscat" | "Asia/Novosibirsk" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Atlantic/South_Georgia" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Darwin" | "Australia/Hobart" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Madrid" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "GMT+12" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Majuro" | "Pacific/Midway" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Port_Moresby" | "Pacific/Tongatapu";
+export interface UsageThresholdInput {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    id?: string | null;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
+     * @example true
+     */
+    recurring: boolean;
+}
+export interface UsageThresholdObject {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
+     * @example true
+     */
+    recurring: boolean;
+    /**
+     * The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    updated_at: string;
+}
 export interface Wallet {
     wallet: WalletObject;
 }
@@ -3807,6 +3938,21 @@ export interface WalletCreateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The corresponding value for the key. */
+            value?: string;
+        }[];
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -3854,6 +4000,21 @@ export interface WalletCreateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -3940,6 +4101,11 @@ export interface WalletObject {
      * @example "2022-09-14T16:35:31Z"
      */
     terminated_at?: string | null;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
     /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
     recurring_transaction_rules?: {
         /**
@@ -3999,6 +4165,21 @@ export interface WalletObject {
          * @example "2022-04-29T08:59:51Z"
          */
         created_at: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     }[];
     /**
      * The wallet ongoing balance expressed in cents.
@@ -4053,6 +4234,21 @@ export interface WalletTransactionCreateInput {
          * @example "5.0"
          */
         voided_credits?: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+         * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+         */
+        metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     };
 }
 export interface WalletTransactionObject {
@@ -4073,6 +4269,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`. `threshold`
+     * @example "manual"
+     */
+    source?: "manual" | "interval" | "threshold";
     /**
      * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
      * @example "purchased"
@@ -4095,6 +4296,21 @@ export interface WalletTransactionObject {
      * @example "100.0"
      */
     credit_amount: string;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
+    /**
+     * This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+     * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+     */
+    metadata?: {
+        /** The unique identifier for the attribute. */
+        key?: string;
+        /** The value associated with the key. */
+        value?: string;
+    }[];
     /**
      * The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -4127,6 +4343,11 @@ export interface WalletUpdateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -4180,6 +4401,21 @@ export interface WalletUpdateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -4308,7 +4544,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.10.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5217,6 +5453,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.10.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1088,6 +1088,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/retry`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -297,6 +297,19 @@ export interface AppliedCouponsPaginated {
     applied_coupons: AppliedCouponObjectExtended[];
     meta: PaginationMeta;
 }
+export interface AppliedUsageThresholdObject {
+    /**
+     * The amount of usage in cents that has been accumulated over the lifetime of the subscription.
+     * @example 2000
+     */
+    lifetime_usage_amount_cents: number;
+    /**
+     * The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     */
+    created_at: string;
+    usage_threshold: UsageThresholdObject;
+}
 export interface BaseAppliedTax {
     /**
      * Unique identifier of the applied tax, created by Lago.
@@ -559,6 +572,15 @@ export interface ChargeObject {
      * @example true
      */
     invoiceable?: boolean;
+    /**
+     * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+     * This field determines whether and when the charge fee should be included in
+     * the invoice. If `null`, no invoice will be issued for this charge fee.
+     * If `invoice`, an invoice will be generated at the end of the period,
+     * consolidating all charge fees with a succeeded payment status.
+     * @example "invoice"
+     */
+    regroup_paid_fees?: "invoice" | null;
     /**
      * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
      *
@@ -1081,17 +1103,17 @@ export interface CreditObject {
          */
         lago_item_id: string;
         /**
-         * The type of credit applied. Possible values are `coupon` or `credit_note`.
+         * The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice).
          * @example "coupon"
          */
-        type: "coupon" | "credit_note";
+        type: "coupon" | "credit_note" | "invoice";
         /**
-         * The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number.
+         * The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number.
          * @example "startup_deal"
          */
         code: string;
         /**
-         * The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note.
+         * The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number.
          * @example "Startup Deal"
          */
         name: string;
@@ -1400,7 +1422,7 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `[card]`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
      * @example ["card","sepa_debit"]
      */
     provider_payment_methods?: string[] | null;
@@ -1927,7 +1949,26 @@ export interface Event {
     event: EventObject;
 }
 export interface EventBatchInput {
-    events: {
+    events: any[];
+}
+export interface EventEstimateFeesInput {
+    event: {
+        /**
+         * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
+         * @example "storage"
+         */
+        code: string;
+        /**
+         * The unique identifier of the subscription within your application.
+         * @example "sub_1234567890"
+         */
+        external_subscription_id: string;
+        /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
+        properties?: object;
+    };
+}
+export interface EventInput {
+    event: {
         /**
          * This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.
          * @example "transaction_1234567890"
@@ -1955,27 +1996,8 @@ export interface EventBatchInput {
          * @example {"gb":10}
          */
         properties?: Record<string, string | number>;
-    }[];
-}
-export interface EventEstimateFeesInput {
-    event: {
-        /**
-         * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
-         * @example "storage"
-         */
-        code: string;
-        /**
-         * The unique identifier of the subscription within your application.
-         * @example "sub_1234567890"
-         */
-        external_subscription_id: string;
-        /** This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
-        properties?: object;
     };
 }
-export interface EventInput {
-    event: any;
-}
 export interface EventObject {
     /**
      * Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system
@@ -2663,18 +2685,19 @@ export interface InvoiceObject {
      */
     net_payment_term?: number;
     /**
-     * The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`.
+     * The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.
      * @example "subscription"
      */
-    invoice_type: "subscription" | "add_on" | "credit" | "one_off";
+    invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided";
+    status: "draft" | "finalized" | "voided" | "failed";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -2705,7 +2728,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`.
      * - Version 2: is equal to the `fees_amount_cents`.
-     * - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
+     * - Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
      * @example 100
      */
     sub_total_excluding_taxes_amount_cents: number;
@@ -2719,7 +2742,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the `total_amount_cents`.
      * - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`.
-     * - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
+     * - Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
      * @example 120
      */
     sub_total_including_taxes_amount_cents: number;
@@ -2728,6 +2751,11 @@ export interface InvoiceObject {
      * @example 0
      */
     prepaid_credit_amount_cents: number;
+    /**
+     * The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices.
+     * @example 0
+     */
+    progressive_billing_credit_amount_cents: number;
     /**
      * The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.
      * @example 100
@@ -2745,11 +2773,30 @@ export interface InvoiceObject {
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
+    applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
 }
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
     subscriptions?: SubscriptionObject[];
+    error_details?: {
+        /**
+         * Unique identifier assigned to the error_detail within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the error's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string | null;
+        /**
+         * Code that specifies part of the application / connection, where the error originally happened
+         * @example "tax_error"
+         */
+        error_code: string;
+        /**
+         * Key value list of more elaborated error detail, where by the key of error_code an external service error details are stored
+         * @example {"tax_error":"taxDateTooFarInFuture"}
+         */
+        details: object;
+    }[];
 };
 export interface InvoiceOneOffCreateInput {
     invoice: {
@@ -3150,7 +3197,7 @@ export interface PlanCreateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @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},"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"}]}},{"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":{}},{"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"}]}},{"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"}}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"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"}]}},{"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":{}},{"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3174,6 +3221,15 @@ export interface PlanCreateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | 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"
@@ -3203,6 +3259,8 @@ export interface PlanCreateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 /** Based plan overrides. */
@@ -3274,6 +3332,8 @@ export interface PlanOverridesObject {
          */
         tax_codes?: string[];
     }[];
+    /** List of usage thresholds applied to the subscription. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlanUpdateInput {
     plan: {
@@ -3333,7 +3393,7 @@ export interface PlanUpdateInput {
         minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
-         * @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},"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"}]}},{"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":{}},{"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"}]}},{"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"}}]
+         * @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},"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":0,"properties":{}},{"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"}]}},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"}}]
          */
         charges?: {
             /**
@@ -3363,6 +3423,15 @@ export interface PlanUpdateInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+             * This field determines whether and when the charge fee should be included in
+             * the invoice. If `null`, no invoice will be issued for this charge fee.
+             * If `invoice`, an invoice will be generated at the end of the period,
+             * consolidating all charge fees with a succeeded payment status.
+             * @example "invoice"
+             */
+            regroup_paid_fees?: "invoice" | 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"
@@ -3392,6 +3461,8 @@ export interface PlanUpdateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 export interface PlanObject {
@@ -3467,11 +3538,13 @@ export interface PlanObject {
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * 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,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"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"}]},"filters":[]},{"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":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"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"}]},"filters":[]},{"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"},"filters":[]}]
+     * @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,"regroup_paid_fees":null,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"filters":[]},{"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"}]},"filters":[]},{"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":{},"filters":[{"invoice_display_name":"Europe","properties":{"amount":"10"},"values":{"region":["Europe"]}},{"invoice_display_name":"USA","properties":{"amount":"5"},"values":{"region":["USA"]}},{"invoice_display_name":"Africa","properties":{"amount":"8"},"values":{"region":["Africa"]}}]},{"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"}]},"filters":[]},{"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,"regroup_paid_fees":"invoice","prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"filters":[]}]
      */
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
     taxes?: TaxObject[];
+    /** List of usage thresholds applied to the plan. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlansPaginated {
     plans: PlanObject[];
@@ -3766,6 +3839,64 @@ export interface TaxUpdateInput {
 }
 /** @example "America/Los_Angeles" */
 export type Timezone = "UTC" | "Africa/Algiers" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Monrovia" | "Africa/Nairobi" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/Chihuahua" | "America/Denver" | "America/Godthab" | "America/Guatemala" | "America/Guyana" | "America/Halifax" | "America/Indiana/Indianapolis" | "America/Juneau" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Mazatlan" | "America/Mexico_City" | "America/Monterrey" | "America/Montevideo" | "America/New_York" | "America/Phoenix" | "America/Puerto_Rico" | "America/Regina" | "America/Santiago" | "America/Sao_Paulo" | "America/St_Johns" | "America/Tijuana" | "Asia/Almaty" | "Asia/Baghdad" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Magadan" | "Asia/Muscat" | "Asia/Novosibirsk" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Atlantic/South_Georgia" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Darwin" | "Australia/Hobart" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Madrid" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "GMT+12" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Majuro" | "Pacific/Midway" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Port_Moresby" | "Pacific/Tongatapu";
+export interface UsageThresholdInput {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    id?: string | null;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
+     * @example true
+     */
+    recurring: boolean;
+}
+export interface UsageThresholdObject {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
+     * @example true
+     */
+    recurring: boolean;
+    /**
+     * The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    updated_at: string;
+}
 export interface Wallet {
     wallet: WalletObject;
 }
@@ -3807,6 +3938,21 @@ export interface WalletCreateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The corresponding value for the key. */
+            value?: string;
+        }[];
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -3854,6 +4000,21 @@ export interface WalletCreateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -3940,6 +4101,11 @@ export interface WalletObject {
      * @example "2022-09-14T16:35:31Z"
      */
     terminated_at?: string | null;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
     /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
     recurring_transaction_rules?: {
         /**
@@ -3999,6 +4165,21 @@ export interface WalletObject {
          * @example "2022-04-29T08:59:51Z"
          */
         created_at: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+         * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+         */
+        transaction_metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     }[];
     /**
      * The wallet ongoing balance expressed in cents.
@@ -4053,6 +4234,21 @@ export interface WalletTransactionCreateInput {
          * @example "5.0"
          */
         voided_credits?: string;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
+        /**
+         * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+         * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+         */
+        metadata?: {
+            /** The unique identifier for the attribute. */
+            key?: string;
+            /** The value associated with the key. */
+            value?: string;
+        }[];
     };
 }
 export interface WalletTransactionObject {
@@ -4073,6 +4269,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`. `threshold`
+     * @example "manual"
+     */
+    source?: "manual" | "interval" | "threshold";
     /**
      * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
      * @example "purchased"
@@ -4095,6 +4296,21 @@ export interface WalletTransactionObject {
      * @example "100.0"
      */
     credit_amount: string;
+    /**
+     * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+     * @example false
+     */
+    invoice_requires_successful_payment?: boolean;
+    /**
+     * This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
+     * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
+     */
+    metadata?: {
+        /** The unique identifier for the attribute. */
+        key?: string;
+        /** The value associated with the key. */
+        value?: string;
+    }[];
     /**
      * The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -4127,6 +4343,11 @@ export interface WalletUpdateInput {
          * @example "2022-07-07T23:59:59Z"
          */
         expiration_at?: string | null;
+        /**
+         * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+         * @example false
+         */
+        invoice_requires_successful_payment?: boolean;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -4180,6 +4401,21 @@ export interface WalletUpdateInput {
              * @example "200.0"
              */
             target_ongoing_balance?: string;
+            /**
+             * A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
+             * @example false
+             */
+            invoice_requires_successful_payment?: boolean;
+            /**
+             * This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
+             * @example [{"key":"example_key","value":"example_value"},{"key":"another_key","value":"another_value"}]
+             */
+            transaction_metadata?: {
+                /** The unique identifier for the attribute. */
+                key?: string;
+                /** The value associated with the key. */
+                value?: string;
+            }[];
         }[];
     };
 }
@@ -4308,7 +4544,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.10.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5217,6 +5453,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.7.0
+ * @version 1.10.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1092,6 +1092,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/retry`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *