lago-javascript-client 1.33.0 → 1.33.3

package/script/openapi/client.d.ts

@@ -1407,13 +1407,13 @@ export interface FeaturePrivilegeObject {
      * Display name for the privilege.
      * @example "Maximum"
      */
-    name?: string | null;
+    name: string | null;
     /**
      * Data type of the privilege value. Default: string
      * @example "integer"
      */
-    value_type?: "integer" | "boolean" | "string" | "select";
-    config?: {
+    value_type: "integer" | "boolean" | "string" | "select";
+    config: {
         /**
          * Array of string, required only when value_type is `select`.
          * @example ["google","okta"]
@@ -1431,17 +1431,17 @@ export interface FeatureObject {
      * Name of the feature. Max 255 characters.
      * @example "Number of seats"
      */
-    name?: string | null;
+    name: string | null;
     /**
      * Description of the feature. Max 600 characters.
      * @example "Number of users of the account"
      */
-    description?: string | null;
+    description: string | null;
     /**
      * Privileges associated with this feature. Can be empty.
-     * @example [{"code":"max","name":"Maximum","value_type":"integer"},{"code":"max_admins","name":"Max Admins","value_type":"integer"},{"code":"root","name":"Allow root user","value_type":"boolean"},{"code":"provider","name":"SSO Provider","value_type":"select","config":{"select_options":["google","okta"]}}]
+     * @example [{"code":"max","name":"Maximum","value_type":"integer","config":{}},{"code":"max_admins","name":"Max Admins","value_type":"integer","config":{}},{"code":"root","name":"Allow root user","value_type":"boolean","config":{}},{"code":"provider","name":"SSO Provider","value_type":"select","config":{"select_options":["google","okta"]}}]
      */
-    privileges?: FeaturePrivilegeObject[];
+    privileges: FeaturePrivilegeObject[];
     /**
      * Creation date of the feature.
      * @format date-time
@@ -1453,12 +1453,7 @@ export interface FeaturesPaginated {
     features: FeatureObject[];
     meta: PaginationMeta;
 }
-export interface FeatureCreateInput {
-    /**
-     * Unique code used to identify the feature.
-     * @example "seats"
-     */
-    code: string;
+export interface FeatureBaseInput {
     /**
      * Name of the feature.
      * @example "Number of seats"
@@ -1498,48 +1493,20 @@ export interface FeatureCreateInput {
         };
     }[];
 }
+export interface FeatureCreateInput {
+    feature: FeatureBaseInput & {
+        /**
+         * Unique code used to identify the feature.
+         * @example "seats"
+         */
+        code: string;
+    };
+}
 export interface Feature {
     feature: FeatureObject;
 }
 export interface FeatureUpdateInput {
-    /**
-     * Name of the feature.
-     * @example "Number of seats"
-     */
-    name?: string | null;
-    /**
-     * Description of the feature.
-     * @example "Number of users of the account"
-     */
-    description?: string | null;
-    /**
-     * Existing privilege names can be updated or new privilege created.
-     * @example [{"code":"max","name":"Maximum"},{"code":"new_extra","name":"Extra","value_type":"string"},{"code":"providers","value_type":"select","config":{"select_options":["ms"]}}]
-     */
-    privileges?: {
-        /**
-         * Code of the privilege to update or create.
-         * @example "max"
-         */
-        code?: string;
-        /**
-         * Display name for the privilege.
-         * @example "Maximum"
-         */
-        name?: string;
-        /**
-         * Data type of the privilege value. Value_type cannot be modified for existing privilege but can be set for new privileges.
-         * @example "integer"
-         */
-        value_type?: "integer" | "boolean" | "string" | "select";
-        config?: {
-            /**
-             * Array of new string to add to existing options. Options cannot be deleted. Only used only when value_type is `select`.
-             * @example ["ms"]
-             */
-            select_options?: string[];
-        };
-    }[];
+    feature: FeatureBaseInput;
 }
 export interface CouponObject {
     /**
@@ -2227,17 +2194,35 @@ export interface FeeObject {
          */
         code: string;
         /**
-         * The name of the fee item. It can be the name of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
+         * The name of the fee item. The value depends on the type of the fee item:
+         *
+         * - If the fee item is a `charge`, it is the billable metric name.
+         * - If the fee item is a `add-on`, it is the add-on name.
+         * - If the fee item is a `credit`, it is the wallet transaction name if set, or `"credit"` if not.
+         * - If the fee item is a `fixed_charge`, it is the fixed charge add-on name.
+         * - For all the other fee items, it is the subscription plan name.
          * @example "Startup"
          */
         name: string;
         /**
-         * The description of the fee item. It can be the description of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
+         * The description of the fee item. The value depends on the type of the fee item:
+         *
+         * - If the fee item is a `charge`, it is the billable metric description.
+         * - If the fee item is a `add-on`, it is the add-on description.
+         * - If the fee item is a `credit`, it is always `"credit"`.
+         * - If the fee item is a `fixed_charge`, it is the fixed charge add-on description.
+         * - For all the other fee items, it is the subscription plan description.
          * @example "Startup"
          */
         description?: 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.
+         * Specifies the name that will be displayed on an invoice. If no value is set for this field, we'll fallback to a value that depends on the type of the fee items:
+         *
+         * - If the fee item is a `charge`, we'll fallback to the `invoice_display_name` of the `charge` or the billable metric name if no `invoice_display_name` is set.
+         * - If the fee item is a `add-on`, we'll fallback to the `invoice_name` of the `add-on` or the `name` of the `add-on`.
+         * - If the fee item is a `credit`, we'll fallback to the wallet transaction name if set, or `credit` if not.
+         * - If the fee item is a `fixed_charge`, we'll fallback to the `invoice_display_name` of the `fixed_charge` or the `invoice_name` of the `fixed_charge_add_on` if no `invoice_display_name` is set.
+         * - For all the other fee items, we'll fallback to the `invoice_display_name` of the subscription plan.
          * @example "Setup Fee (SF1)"
          */
         invoice_display_name?: string;
@@ -2476,18 +2461,18 @@ export interface CreditNoteCreateInput {
          */
         description?: string;
         /**
-         * The total amount to be credited on the customer balance.
-         * @example 10
+         * The total amount to be credited to the customer balance for discounts on future invoices. For a total or partial refund or credit, the amount in cents must include both the item amount and the applicable tax. The refunded and credited amounts should always balance. The total, including taxes, cannot exceed the invoice’s total fees.”
+         * @example 100
          */
         credit_amount_cents?: number | null;
         /**
-         * The total amount to be refunded to the customer.
-         * @example 5
+         * The total amount to be refunded immediately to the payment method used by the customer. For a total or partial refund or credit, the amount in cents must include both the item amount and the applicable tax. The refunded and credited amounts should always balance. The total, including taxes, cannot exceed the invoice’s total fees.”
+         * @example 500
          */
         refund_amount_cents?: number | null;
         /**
          * The list of credit note's items.
-         * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
+         * @example [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":100},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":500}]
          */
         items: {
             /**
@@ -2497,8 +2482,8 @@ export interface CreditNoteCreateInput {
              */
             fee_id: string;
             /**
-             * The amount of the credit note item, expressed in cents.
-             * @example 10
+             * This is the amount of the credit note item excluding taxes, expressed in cents.
+             * @example 100
              */
             amount_cents: number;
         }[];
@@ -4266,7 +4251,7 @@ export interface SubscriptionObject {
      * The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.
      * @example "Repository A"
      */
-    name?: string | null;
+    name: string | null;
     /**
      * The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans.
      * @example "premium"
@@ -4274,13 +4259,13 @@ export interface SubscriptionObject {
     plan_code: string;
     /**
      * The status of the subscription, which can have the following values:
-     * - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
      * - `active`: the subscription is currently active and applied to the customer.
-     * - `terminated`: the subscription is no longer active.
      * - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.
+     * - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
+     * - `terminated`: the subscription is no longer active.
      * @example "active"
      */
-    status: "active" | "pending" | "terminated" | "canceled";
+    status: "active" | "canceled" | "pending" | "terminated";
     /**
      * The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.
      * @format date-time
@@ -4292,19 +4277,19 @@ export interface SubscriptionObject {
      * @format date-time
      * @example "2022-09-14T16:35:31Z"
      */
-    canceled_at?: string | null;
+    canceled_at: string | null;
     /**
      * The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
      * @example "2022-08-08T00:00:00Z"
      */
-    started_at?: string | null;
+    started_at: string | null;
     /**
      * The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).
      * @format date-time
      * @example "2022-10-08T00:00:00Z"
      */
-    ending_at?: string | null;
+    ending_at: string | null;
     /**
      * The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -4316,41 +4301,41 @@ export interface SubscriptionObject {
      * @format date-time
      * @example "2022-09-14T16:35:31Z"
      */
-    terminated_at?: string | null;
+    terminated_at: string | null;
     /**
      * The code identifying the previous plan associated with this subscription.
      * @example null
      */
-    previous_plan_code?: string | null;
+    previous_plan_code: string | null;
     /**
      * The code identifying the next plan in the case of a downgrade.
      * @example null
      */
-    next_plan_code?: string | null;
+    next_plan_code: string | null;
     /**
      * The date when the plan will be downgraded, represented in ISO 8601 date format.
      * @format date
      * @example "2022-04-30"
      */
-    downgrade_plan_date?: string | null;
+    downgrade_plan_date: string | null;
     /**
      * The date when the free trial is ended, represented in ISO 8601 date format.
      * @format date-time
      * @example "2022-08-08T00:00:00Z"
      */
-    trial_ended_at?: string | null;
+    trial_ended_at: string | null;
     /**
      * The date and time when the current billing period started, represented in ISO 8601 date format.
      * @format date-time
      * @example "2022-08-08T00:00:00Z"
      */
-    current_billing_period_started_at?: string | null;
+    current_billing_period_started_at: string | null;
     /**
      * The date and time when the current billing period ends, represented in ISO 8601 date format.
      * @format date-time
      * @example "2022-09-08T00:00:00Z"
      */
-    current_billing_period_ending_at?: string | null;
+    current_billing_period_ending_at: string | null;
     /**
      * When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default.
      * This field allows you to control the behavior of the credit note generation:
@@ -5134,6 +5119,17 @@ export interface MinimumCommitmentObject {
     /** All taxes applied to the minimum commitment. */
     taxes?: TaxObject[];
 }
+/**
+ * Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:
+ *   - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)
+ *   - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)
+ *   - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)
+ *   - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)
+ *   - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)
+ *   - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)
+ *   - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)
+ */
+export type ChargeModelEnum = "dynamic" | "graduated" | "graduated_percentage" | "package" | "percentage" | "standard" | "volume";
 export interface ChargeProperties {
     /**
      * The list of event properties that are used to group the events on the invoice for a `standard` charge model.
@@ -5325,8 +5321,17 @@ export interface ChargeObject {
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
-    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`. */
-    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
+    /**
+     * Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:
+     *   - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)
+     *   - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)
+     *   - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)
+     *   - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)
+     *   - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)
+     *   - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)
+     *   - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)
+     */
+    charge_model: ChargeModelEnum;
     /**
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
@@ -5405,7 +5410,7 @@ export interface PlanEntitlementObject {
     description: string | null;
     /**
      * Privileges associated with this feature. Each privilege must have a value assigned.
-     * @example [{"code":"max","name":"Maximum","value_type":"integer","value":10},{"code":"max_admins","name":"Max Admins","value_type":"integer","value":5},{"code":"root","name":"Allow root user","value_type":"boolean","value":true},{"code":"provider","name":"SSO Provider","value_type":"select","value":"google","config":{"select_options":["google","okta"]}}]
+     * @example [{"code":"max","name":"Maximum","value_type":"integer","config":{},"value":10},{"code":"max_admins","name":"Max Admins","value_type":"integer","config":{},"value":5},{"code":"root","name":"Allow root user","value_type":"boolean","config":{},"value":true},{"code":"provider","name":"SSO Provider","value_type":"select","value":"google","config":{"select_options":["google","okta"]}}]
      */
     privileges: PlanEntitlementPrivilegeObject[];
 }
@@ -5523,12 +5528,6 @@ export interface ChargeFilterInput {
     values: Record<string, string[]>;
 }
 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"
@@ -5541,9 +5540,10 @@ export interface UsageThresholdInput {
     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.
+     * @default false
      * @example true
      */
-    recurring: boolean;
+    recurring?: boolean;
 }
 export interface PlanCreateInput {
     plan: {
@@ -5613,10 +5613,16 @@ export interface PlanCreateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
-             * @example "standard"
+             * Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:
+             *   - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)
+             *   - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)
+             *   - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)
+             *   - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)
+             *   - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)
+             *   - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)
+             *   - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
+            charge_model?: ChargeModelEnum;
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -5758,10 +5764,16 @@ export interface PlanUpdateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
-             * @example "standard"
+             * Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:
+             *   - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)
+             *   - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)
+             *   - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)
+             *   - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)
+             *   - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)
+             *   - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)
+             *   - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
+            charge_model?: ChargeModelEnum;
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -5829,11 +5841,13 @@ export interface PlanUpdateInput {
 export interface PlanEntitlements {
     entitlements: PlanEntitlementObject[];
 }
-/**
- * Feature entitlements with their privilege values. Each key is a feature code, and the value is an object containing privilege codes with their associated values.
- * @example {"seats":{"max":20,"max_admins":10,"root":false},"sso":{"provider":"okta"}}
- */
-export type EntitlementUpdateInput = Record<string, Record<string, number | boolean | string>>;
+export interface EntitlementUpdateInput {
+    /**
+     * Feature entitlements with their privilege values. Each key is a feature code, and the value is an object containing privilege codes with their associated values.
+     * @example {"seats":{"max":20,"max_admins":10,"root":false},"sso":{"provider":"okta"}}
+     */
+    entitlements: Record<string, Record<string, number | boolean | string>>;
+}
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
     meta: PaginationMeta;
@@ -5872,7 +5886,8 @@ export interface PlanOverridesObject {
      * @example 5
      */
     trial_period?: number;
-    minimum_commitment?: MinimumCommitmentObject;
+    /** Minimum commitment for this plan. */
+    minimum_commitment?: MinimumCommitmentInput;
     /** Additional usage-based charges for this plan. */
     charges?: {
         /**
@@ -5887,6 +5902,17 @@ export interface PlanOverridesObject {
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
         billable_metric_id?: string;
+        /**
+         * Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:
+         *   - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)
+         *   - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)
+         *   - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)
+         *   - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)
+         *   - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)
+         *   - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)
+         *   - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)
+         */
+        charge_model?: ChargeModelEnum;
         /**
          * 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"
@@ -5915,10 +5941,36 @@ export interface PlanOverridesObject {
         };
     }[];
     /** List of usage thresholds applied to the subscription. */
-    usage_thresholds?: UsageThresholdObject[];
+    usage_thresholds?: UsageThresholdInput[];
 }
 export interface SubscriptionCreateInput {
     subscription: {
+        /**
+         * Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
+         *
+         * Important notes:
+         *   - The final amount due for the subscription is not known at the time of creation; it is determined only after the invoice is finalized.
+         *   - The payment intent generated for pre-authorization cannot be reused, as the final invoice amount may exceed the authorized amount.
+         *   - The payment intent is canceled immediately after creation, but this cancellation occurs asynchronously.
+         *   - For these reasons, it is recommended to use a small amount (such as $1) for pre-authorization. While this does not guarantee sufficient funds for the final payment, it helps reduce the likelihood of payment errors.
+         */
+        authorization?: {
+            /**
+             * The amount of the authorization in cents.
+             * @example 1000
+             */
+            amount_cents: number;
+            /**
+             * The currency of the authorization.
+             * @example "USD"
+             */
+            amount_currency: string;
+        };
+        /**
+         * The code of the billing entity to be used for the subscription. If not provided, the default billing entity will be used.
+         * @example "default"
+         */
+        billing_entity_code?: string;
         /**
          * The customer external unique identifier (provided by your own application)
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -6050,7 +6102,7 @@ export interface LifetimeUsageObject {
      * @format date-time
      * @example "2024-01-01T00:00:00Z"
      */
-    from_datetime: string;
+    from_datetime: string | null;
     /**
      * The recording end date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.
      * @format date-time
@@ -6238,9 +6290,11 @@ export interface SubscriptionEntitlementObject {
     description: string | null;
     /**
      * Privileges associated with this feature. Each privilege shows the plan value and any subscription override.
-     * @example [{"code":"max","name":"Maximum","value_type":"integer","value":15,"plan_value":10,"override_value":15},{"code":"max_admins","name":"Max Admins","value_type":"integer","value":5,"plan_value":5,"override_value":null},{"code":"root","name":"Allow root user","value_type":"boolean","value":true,"plan_value":true,"override_value":null},{"code":"provider","name":"SSO Provider","value_type":"select","value":"okta","plan_value":"google","override_value":"okta","config":{"select_options":["google","okta"]}}]
+     * @example [{"code":"max","name":"Maximum","value_type":"integer","config":{},"value":15,"plan_value":10,"override_value":15},{"code":"max_admins","name":"Max Admins","value_type":"integer","config":{},"value":5,"plan_value":5,"override_value":null},{"code":"root","name":"Allow root user","value_type":"boolean","config":{},"value":true,"plan_value":true,"override_value":null},{"code":"provider","name":"SSO Provider","value_type":"select","value":"okta","plan_value":"google","override_value":"okta","config":{"select_options":["google","okta"]}}]
      */
     privileges: SubscriptionEntitlementPrivilegeObject[];
+    /** @example {"max":15,"provider":"okta"} */
+    overrides: Record<string, any>;
 }
 export interface SubscriptionEntitlements {
     entitlements: SubscriptionEntitlementObject[];
@@ -6696,6 +6750,13 @@ export interface WalletTransactionCreateInput {
          * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
          */
         wallet_id: string;
+        /**
+         * The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.
+         *
+         * Note that this name will apply to all transactions (`paid_credits`, `granted_credits` and `voided_credits`) created by this action.
+         * @example "Tokens for models 'high-fidelity-boost'"
+         */
+        name?: string | null;
         /**
          * The number of paid credits.
          * @pattern ^[0-9]+.?[0-9]*$
@@ -6804,6 +6865,11 @@ export interface WalletTransactionObject {
      * @example "2022-04-29T08:59:51Z"
      */
     created_at: string;
+    /**
+     * The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.
+     * @example "Tokens for models 'high-fidelity-boost'"
+     */
+    name: string | null;
 }
 export interface WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
@@ -7292,13 +7358,16 @@ export interface PaymentRequestPaymentFailureObject {
     provider_error?: string | Record<string, any>;
 }
 export type SubscriptionWithCustomerObject = SubscriptionObject & {
-    plan?: PlanObject;
-    customer?: CustomerObject;
+    plan: PlanObject;
+    customer: CustomerObject;
 };
 export type SubscriptionWithThresholdObject = SubscriptionObject & {
-    plan?: PlanObject;
-    customer?: CustomerObject;
-    usage_threshold?: UsageThresholdObject;
+    plan: PlanObject;
+    customer: CustomerObject;
+    usage_threshold: UsageThresholdObject;
+};
+export type WalletTransactionObjectExtended = WalletTransactionObject & {
+    wallet?: WalletObject;
 };
 export interface WalletTransactionPaymentFailureObject {
     /**
@@ -7336,7 +7405,6 @@ export interface WalletTransactionPaymentFailureObject {
     provider_error?: string | Record<string, any>;
 }
 export type CustomerPaymentProvidernErrorObject = CustomerPaymentProviderErrorObject;
-export type PrivilegeObject = FeaturePrivilegeObject;
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
 export interface FullRequestParams extends Omit<RequestInit, "body"> {
@@ -7397,7 +7465,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.31.0
+ * @version 1.33.3
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -8708,10 +8776,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "2022-08-09"
              */
             issuing_date_to?: string;
-            /** Filter invoices by status. Possible values are `draft` or `finalized`. */
-            status?: "draft" | "finalized";
-            /** Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. */
-            payment_status?: "pending" | "failed" | "succeeded";
+            /** Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. */
+            "statuses[]"?: ("draft" | "finalized" | "failed" | "pending" | "voided")[];
+            /** Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`. */
+            "payment_statuses[]"?: ("pending" | "failed" | "succeeded")[];
             /**
              * Filter invoices by payment_overdue. Possible values are `true` or `false`.
              * @example true
@@ -9081,7 +9149,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         destroyPlan: (code: string, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint creates a new entitlement by adding a feature to a plan. The feature must exist and all privileges must be valid for the feature.
+         * @description This endpoint creates new entitlements by adding features to a plan. Note that all existing entitlements will be deleted and replaced by the ones provided. To add a new entitlement without removing the existing ones, use PATCH. The feature must exist and all privileges must be valid for the feature.
          *
          * @tags entitlements
          * @name CreateEntitlement
@@ -9089,7 +9157,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/plans/{code}/entitlements
          * @secure
          */
-        createEntitlement: (code: string, data: EntitlementUpdateInput, params?: RequestParams) => Promise<HttpResponse<PlanEntitlement, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        createEntitlement: (code: string, data: EntitlementUpdateInput, params?: RequestParams) => Promise<HttpResponse<PlanEntitlements, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves all entitlements for a specific plan.
          *
@@ -9101,7 +9169,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         findAllEntitlements: (code: string, params?: RequestParams) => Promise<HttpResponse<PlanEntitlements, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint updates an existing entitlement by modifying privilege values. Notice that the update is partial. All new privileges or features are added. If there is already a value, it's overridden. All feature and privileges not part of the payload are ignored. To remove privileges or feature, use the delete endpoints. All privileges must be valid for the feature.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateEntitlement
@@ -9109,7 +9177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PATCH:/plans/{code}/entitlements
          * @secure
          */
-        updateEntitlement: (code: string, data: EntitlementUpdateInput, params?: RequestParams) => Promise<HttpResponse<PlanEntitlement, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateEntitlement: (code: string, data: EntitlementUpdateInput, params?: RequestParams) => Promise<HttpResponse<PlanEntitlements, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific entitlement for a plan.
          *
@@ -9186,8 +9254,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
              * @example ["active","pending"]
              */
-            "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
-        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
+            "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
+        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves a specific subscription.
          *
@@ -9202,6 +9270,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * By default, this endpoint only return `active` subscriptions. If you want to retrieve a subscription with a different `status`, you can specify it here.
              *
              * _Note: As there may exists multiple `canceled` or `terminated` subscribtions for the same `external_id`, it is recommended to use the "List all subscriptions" endpoint to retrieve those subscriptions._
+             * @default "active"
              * @example "active"
              */
             status?: "active" | "terminated" | "pending" | "canceled";
@@ -9215,7 +9284,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/subscriptions/{external_id}
          * @secure
          */
-        updateSubscription: (externalId: string, data: SubscriptionUpdateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateSubscription: (externalId: string, data: SubscriptionUpdateInput, query?: {
+            /**
+             * By default, this endpoint only return `active` subscriptions. If you want to update a subscription with a different `status`, you can specify it here.
+             * @default "active"
+             * @example "active"
+             */
+            status?: "active" | "pending";
+        }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to terminate a subscription.
          *
@@ -9252,7 +9328,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "generate"
              */
             on_termination_invoice?: "generate" | "skip";
-        }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
+        }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the lifetime usage of a subscription.
          *
@@ -9334,7 +9410,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         findAllSubscriptionEntitlements: (externalId: string, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlements, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description This endpoint allows partial updates to subscription entitlements. New entitlements are added, provided values are overridden, but entitlements not included in the payload are ignored.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateSubscriptionEntitlements