lago-javascript-client 1.49.0 → 1.52.0

package/esm/openapi/client.d.ts

@@ -361,7 +361,7 @@ export interface TaxObject {
      */
     rate: number;
     /**
-     * This field is deprecated and will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+     * **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
      * @deprecated
      * @example true
      */
@@ -406,7 +406,7 @@ export interface InvoiceCustomSectionObject {
      */
     display_name?: string;
     /**
-     * This field is deprecated and will be removed in a future version. When set to true, it applies the invoice custom section to the organization's default billing entity. To apply or remove an invoice custom section from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+     * **Deprecated.** This field will be removed in a future version. When set to true, it applies the invoice custom section to the organization's default billing entity. To apply or remove an invoice custom section from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
      * @deprecated
      * @example true
      */
@@ -2645,6 +2645,54 @@ export interface CustomerBaseObject {
     shipping_address?: Address;
     metadata?: CustomerMetadata[];
 }
+/** Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. */
+export interface IntegrationCustomer {
+    /**
+     * A unique identifier for the integration customer object in the Lago application.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The integration type used for accounting and tax syncs.
+     * Accepted values: `netsuite, anrok`.
+     * @example "netsuite"
+     */
+    type: "netsuite" | "anrok" | "xero" | "hubspot" | "salesforce";
+    /**
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
+     */
+    integration_code: string;
+    /**
+     * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
+     * @example "cus_12345"
+     */
+    external_customer_id: string;
+    /**
+     * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
+     * @example true
+     */
+    sync_with_provider?: boolean | null;
+    /**
+     * This optional field is needed only when working with `netsuite` connection.
+     * @example "2"
+     */
+    subsidiary_id?: string;
+    /**
+     * This optional field is present only when working with `hubspot` connection.
+     * @example "contacts"
+     */
+    targeted_object?: string | null;
+    /**
+     * This optional field is present only when working with `hubspot` connection.
+     * @example "dinesh@piedpiper.test"
+     */
+    email?: string | null;
+}
+export type CustomerObject = CustomerBaseObject & {
+    integration_customers?: IntegrationCustomer[];
+};
 /**
  * Custom metadata stored as key-value pairs.
  * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
@@ -2699,6 +2747,11 @@ export interface CreditNoteObject {
      * @example "LAG-1234"
      */
     invoice_number: string;
+    /**
+     * The purchase order number of the invoice the credit note belongs to.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
     /**
      * The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.
      * @format date
@@ -2809,7 +2862,7 @@ export interface CreditNoteObject {
      * @example false
      */
     self_billed?: boolean;
-    customer?: CustomerBaseObject;
+    customer?: CustomerObject;
     /**
      * Custom metadata stored as key-value pairs.
      * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
@@ -2882,7 +2935,7 @@ export interface CreditNoteCreateInput {
     };
 }
 export type CreditNoteExtendedObject = CreditNoteObject & {
-    customer?: CustomerBaseObject;
+    customer?: CustomerObject;
 };
 export interface CreditNoteExtended {
     credit_note: CreditNoteExtendedObject;
@@ -3069,54 +3122,6 @@ export interface CreditNoteMetadataResponse {
      */
     metadata: MetadataObject;
 }
-/** Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. */
-export interface IntegrationCustomer {
-    /**
-     * A unique identifier for the integration customer object in the Lago application.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_id: string;
-    /**
-     * The integration type used for accounting and tax syncs.
-     * Accepted values: `netsuite, anrok`.
-     * @example "netsuite"
-     */
-    type: "netsuite" | "anrok" | "xero" | "hubspot" | "salesforce";
-    /**
-     * Unique code used to identify an integration connection.
-     * @example "netsuite-eu-1"
-     */
-    integration_code: string;
-    /**
-     * The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
-     * @example "cus_12345"
-     */
-    external_customer_id: string;
-    /**
-     * Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
-     * @example true
-     */
-    sync_with_provider?: boolean | null;
-    /**
-     * This optional field is needed only when working with `netsuite` connection.
-     * @example "2"
-     */
-    subsidiary_id?: string;
-    /**
-     * This optional field is present only when working with `hubspot` connection.
-     * @example "contacts"
-     */
-    targeted_object?: string | null;
-    /**
-     * This optional field is present only when working with `hubspot` connection.
-     * @example "dinesh@piedpiper.test"
-     */
-    email?: string | null;
-}
-export type CustomerObject = CustomerBaseObject & {
-    integration_customers?: IntegrationCustomer[];
-};
 export interface ErrorDetailObject {
     /**
      * 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.
@@ -3204,7 +3209,8 @@ export interface CustomerCreateInput {
          */
         logo_url?: string | null;
         /**
-         * The full name of the customer
+         * The full name of the customer (255 characters max).
+         * @maxLength 255
          * @example "Gavin Belson"
          */
         name?: string | null;
@@ -3372,6 +3378,11 @@ export interface InvoiceBaseObject {
      * @example "LAG-1234-001-002"
      */
     number: string;
+    /**
+     * The purchase order number associated with the invoice. It is inherited from the subscription, wallet or wallet transaction the invoice was generated for.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
     /**
      * The date when the invoice was issued. It is provided in the ISO 8601 date format.
      * @format date
@@ -3412,9 +3423,10 @@ export interface InvoiceBaseObject {
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
      * - `pending`: the invoice remains pending until the taxes are fetched from the external provider.
      * - `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.
+     * - `deleted`: the draft invoice has been permanently deleted. This status is only returned by the delete endpoint and its webhook; a deleted invoice is no longer retrievable afterwards.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided" | "failed" | "pending";
+    status: "draft" | "finalized" | "voided" | "failed" | "pending" | "deleted";
     /**
      * 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.
@@ -3504,6 +3516,12 @@ export interface InvoiceBaseObject {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+    /**
+     * Contains the URL to the invoice page in the Lago dashboard. It is `null` for invoices that are not visible in the dashboard (for example while still generating). Use it to link users directly to the invoice overview page.
+     * @format uri
+     * @example "https://app.getlago.com/acme/customer/1a901a90-1a90-1a90-1a90-1a901a901a90/invoice/2b012b01-2b01-2b01-2b01-2b012b012b01/overview"
+     */
+    web_url?: string | null;
     /**
      * The date of the invoice creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the invoice object was created
      * @format date-time
@@ -3530,7 +3548,8 @@ export interface InvoiceMetadataObject {
      */
     key?: string;
     /**
-     * Represents the value of the metadata's key-value pair.
+     * Represents the value of the metadata's key-value pair (140 characters max).
+     * @maxLength 140
      * @example "INV-0123456-98765"
      */
     value?: string;
@@ -3817,7 +3836,7 @@ export interface AppliedInvoiceCustomSectionObject {
      */
     created_at: string;
     /**
-     * Unique identifier of the invoice custom section that was applied.
+     * **Deprecated.** Unique identifier of the invoice custom section that was applied.
      * @deprecated
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
@@ -3839,6 +3858,54 @@ export interface PaymentMethodReference {
      */
     payment_method_id?: string;
 }
+export interface SubscriptionActivationRuleObject {
+    /**
+     * Unique identifier assigned to the activation rule within the Lago application. This ID is exclusively created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The type of the activation rule. Only `payment` is currently supported. A `payment` rule gates the subscription activation on a successful payment of the first invoice.
+     * @example "payment"
+     */
+    type: "payment";
+    /**
+     * The number of hours the subscription stays in the `incomplete` state waiting for the payment to succeed before it is automatically canceled.
+     * @example 48
+     */
+    timeout_hours: number;
+    /**
+     * The evaluation status of the activation rule:
+     * - `inactive`: the rule has not been evaluated yet.
+     * - `pending`: the rule is applicable and is waiting to be satisfied (e.g. waiting for the payment).
+     * - `satisfied`: the rule has been satisfied and no longer blocks activation.
+     * - `declined`: the rule was applicable but was declined.
+     * - `failed`: the rule could not be satisfied (e.g. the payment failed).
+     * - `expired`: the rule was not satisfied before its timeout elapsed.
+     * - `not_applicable`: the rule did not apply to this subscription.
+     * @example "pending"
+     */
+    status: "inactive" | "pending" | "satisfied" | "declined" | "failed" | "expired" | "not_applicable";
+    /**
+     * The date and time when the rule expires, after which an unsatisfied rule causes the subscription to be canceled. Represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null until the rule starts being evaluated.
+     * @format date-time
+     * @example "2022-08-10T00:00:00Z"
+     */
+    expires_at?: string | null;
+    /**
+     * The creation date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    created_at: string;
+    /**
+     * The last update date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    updated_at: string;
+}
 export interface SubscriptionObject {
     /**
      * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
@@ -3895,12 +3962,13 @@ export interface SubscriptionObject {
     /**
      * The status of the subscription, which can have the following values:
      * - `active`: the subscription is currently active and applied to the customer.
-     * - `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.
+     * - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer, when a subscription with a pending status is terminated, or when a payment-gated subscription fails to be paid (or its activation rule expires) before activation. When caused by payment gating, the `cancellation_reason` field is set.
+     * - `incomplete`: the subscription was created with a payment activation rule and is waiting for the gating payment to succeed before it becomes `active`. It is automatically `canceled` if the payment fails or the activation rule expires.
      * - `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" | "canceled" | "pending" | "terminated";
+    status: "active" | "canceled" | "incomplete" | "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
@@ -4007,11 +4075,41 @@ export interface SubscriptionObject {
      * @example true
      */
     consolidate_invoice?: boolean;
+    /**
+     * The reason a payment-gated subscription was canceled while still `incomplete`. Null unless the subscription was canceled before activation.
+     *
+     * - `payment_failed`: the gating payment failed.
+     * - `timeout`: the activation rule expired before the payment succeeded.
+     * - `manual`: the incomplete subscription was canceled on demand, via a terminate request with `status=incomplete`.
+     * @example "payment_failed"
+     */
+    cancellation_reason?: "payment_failed" | "timeout" | "manual";
+    /**
+     * The date and time when a payment-gated subscription was activated (i.e. moved from `incomplete` to `active` once the gating payment succeeded), represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null while the subscription is still `incomplete`.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    activated_at?: string | null;
+    /** The activation rules attached to the subscription. A payment activation rule gates activation on a successful first payment, keeping the subscription in the `incomplete` state until the payment succeeds or the rule expires. */
+    activation_rules?: SubscriptionActivationRuleObject[];
+    /**
+     * The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
 }
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
     meta: PaginationMeta;
 }
+/**
+ * Fee type to which a wallet can be restricted. It can be any of the following values:
+ *   - `charge`
+ *   - `subscription`
+ *   - `commitment`
+ *   - `fixed_charge`
+ */
+export type WalletFeeTypeEnum = "charge" | "subscription" | "commitment" | "fixed_charge";
 /** Object that represents rule for wallet recurring transactions. */
 export interface WalletRecurringTransactionRule {
     /**
@@ -4116,6 +4214,11 @@ export interface WalletRecurringTransactionRule {
     applied_invoice_custom_sections?: AppliedInvoiceCustomSectionObject[];
     /** The payment method assigned to this recurring transaction rule for processing top-up payments. */
     payment_method?: PaymentMethodReference;
+    /**
+     * The purchase order number associated with this recurring transaction rule. It will be added to invoices generated for the resulting wallet top-ups. If not set, falls back to the wallet's `purchase_order_number`.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
 }
 export interface WalletObject {
     /**
@@ -4231,7 +4334,7 @@ export interface WalletObject {
          * An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.
          * @example ["charge"]
          */
-        fee_types?: ("charge" | "subscription" | "commitment")[];
+        fee_types?: WalletFeeTypeEnum[];
         /**
          * An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.
          * @example ["bm1"]
@@ -4276,6 +4379,11 @@ export interface WalletObject {
     applied_invoice_custom_sections?: AppliedInvoiceCustomSectionObject[];
     /** The payment method assigned to this wallet for processing top-up payments. */
     payment_method?: PaymentMethodReference;
+    /**
+     * The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
     /**
      * Custom metadata stored as key-value pairs.
      * Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.
@@ -4372,6 +4480,11 @@ export interface WalletCreateInput {
          * @example "Tokens for models 'high-fidelity-boost'"
          */
         transaction_name?: string | null;
+        /**
+         * The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
         /** Set wallet limitations to fee types. */
         applies_to?: {
             /**
@@ -4448,6 +4561,11 @@ export interface WalletUpdateInput {
          * @example "default"
          */
         billing_entity_code?: string;
+        /**
+         * The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
         /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
         invoice_custom_section?: InvoiceCustomSectionInput;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
@@ -4534,6 +4652,11 @@ export interface WalletUpdateInput {
              * @example "Tokens for models 'high-fidelity-boost'"
              */
             transaction_name?: string | null;
+            /**
+             * The purchase order number associated with this recurring transaction rule. It will be added to invoices generated for the resulting wallet top-ups. If not set, falls back to the wallet's `purchase_order_number`.
+             * @example "PO-123"
+             */
+            purchase_order_number?: string | null;
             /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
             invoice_custom_section?: InvoiceCustomSectionInput;
             /** Optional payment method to use for processing recurring top-up payments. */
@@ -5261,8 +5384,7 @@ export interface PaymentMethod {
 }
 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
-     * @format uuid
+     * 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. It is an opaque identifier and is not guaranteed to be a UUID; on organizations using the ClickHouse events store it is a composite string.
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id?: string | null;
@@ -5648,6 +5770,11 @@ export interface InvoiceOneOffCreateInput {
          * @example "EUR"
          */
         currency?: Currency;
+        /**
+         * The purchase order number to associate with the invoice.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
         fees: {
             /**
              * The code of the add-on used as invoice item.
@@ -5780,7 +5907,8 @@ export interface InvoiceUpdateInput {
              */
             key?: string;
             /**
-             * The value in the key-value pair of the metadata.
+             * The value in the key-value pair of the metadata (140 characters max).
+             * @maxLength 140
              * @example "INV-0123456-98765"
              */
             value?: string;
@@ -6354,8 +6482,8 @@ export interface MinimumCommitmentObject {
 export type ChargeModelEnum = "dynamic" | "graduated" | "graduated_percentage" | "package" | "percentage" | "standard" | "volume";
 export interface ChargeProperties {
     /**
+     * **Deprecated.** Replaced by `pricing_group_keys`.
      * The list of event properties that are used to group the events on the invoice for a `standard` charge model.
-     * **DEPRECATED** Replaced by `pricing_group_keys`.
      * @deprecated
      * @example ["agent_name"]
      */
@@ -7842,11 +7970,26 @@ export interface PlanOverridesObject {
         /** List of taxes applied to the fixed charge. */
         tax_codes?: TaxCodes;
     }[];
-    /** List of usage thresholds applied to the subscription. */
+    /**
+     * **Deprecated.** Managing usage thresholds through `plan_overrides` is deprecated and its behavior is inconsistent: an empty array does not reliably clear thresholds (it is ignored the first time a subscription is overridden), and it never affects thresholds inherited from a parent plan. Use the top-level `usage_thresholds` array on the subscription instead, or `progressive_billing_disabled` to switch progressive billing off.
+     * @deprecated
+     */
     usage_thresholds?: UsageThresholdInput[];
     /** Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. */
     metadata?: MetadataInput;
 }
+export interface SubscriptionActivationRuleInput {
+    /**
+     * The type of the activation rule. Only `payment` is currently supported. A `payment` rule gates the subscription activation on a successful payment of the first invoice.
+     * @example "payment"
+     */
+    type: "payment";
+    /**
+     * The number of hours the subscription stays in the `incomplete` state waiting for the payment to succeed before it is automatically canceled. Must be a positive integer or zero.
+     * @example 48
+     */
+    timeout_hours?: number;
+}
 export interface SubscriptionCreateInput {
     /**
      * 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.
@@ -7927,6 +8070,27 @@ export interface SubscriptionCreateInput {
          * @example true
          */
         consolidate_invoice?: boolean;
+        /**
+         * The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
+        /**
+         * Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).
+         *
+         * Set to `true` to switch progressive billing off for this subscription specifically, without changing the plan's thresholds.
+         * @default false
+         * @example true
+         */
+        progressive_billing_disabled?: boolean;
+        /**
+         * Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.
+         *
+         * This field cannot be combined with `plan_overrides.usage_thresholds` in the same request.
+         */
+        usage_thresholds?: UsageThresholdInput[];
+        /** Optional list of activation rules that gate the subscription activation. When a `payment` rule is provided and the plan is paid in advance (and the subscription is not in a trial), the subscription is created in the `incomplete` state and is only activated once the gating payment succeeds. If the payment fails or the rule's `timeout_hours` elapses, the subscription is canceled. */
+        activation_rules?: SubscriptionActivationRuleInput[];
     };
 }
 export interface ApplicableUsageThreshold {
@@ -7997,6 +8161,27 @@ export interface SubscriptionUpdateInput {
          * @example "default"
          */
         billing_entity_code?: string;
+        /**
+         * The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
+        /**
+         * Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).
+         *
+         * Set to `true` to switch progressive billing off for this subscription specifically. This is the recommended way to stop progressive billing on a subscription that inherits thresholds from its plan, since clearing `usage_thresholds` only removes subscription-level thresholds and does not remove those defined on (or inherited from) the plan.
+         * @default false
+         * @example true
+         */
+        progressive_billing_disabled?: boolean;
+        /**
+         * Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.
+         *
+         * Sending an empty array removes all subscription-level thresholds. This field cannot be combined with `plan_overrides.usage_thresholds` in the same request. To fully disable progressive billing on a subscription that inherits thresholds from its plan, use `progressive_billing_disabled` instead.
+         */
+        usage_thresholds?: UsageThresholdInput[];
+        /** Optional list of activation rules that gate the subscription activation. Activation rules can only be set or modified while the subscription is `pending` (future-dated and not yet activated); the request is rejected for `incomplete`, `active`, or `terminated` subscriptions. */
+        activation_rules?: SubscriptionActivationRuleInput[];
     };
 }
 export interface Subscription {
@@ -8279,7 +8464,7 @@ export interface TaxBaseInput {
      */
     description?: string | null;
     /**
-     * This field is deprecated and will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+     * **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
      * @deprecated
      * @example true
      */
@@ -8337,6 +8522,11 @@ export interface WalletTransactionCreateInput {
          * @example false
          */
         ignore_paid_top_up_limits?: boolean;
+        /**
+         * The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's `purchase_order_number`.
+         * @example "PO-123"
+         */
+        purchase_order_number?: string | null;
         /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
         invoice_custom_section?: InvoiceCustomSectionInput;
         /** Optional payment method to use for processing the wallet transaction payment. */
@@ -8469,6 +8659,11 @@ export interface WalletTransactionObject {
     applied_invoice_custom_sections?: AppliedInvoiceCustomSectionObject[];
     /** The payment method assigned to this wallet transaction for processing the payment. */
     payment_method: PaymentMethodReference;
+    /**
+     * The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's `purchase_order_number`.
+     * @example "PO-123"
+     */
+    purchase_order_number?: string | null;
 }
 export interface WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
@@ -8570,6 +8765,16 @@ export type WalletTransactionFundingsPaginated = WalletTransactionFundings & {
 export type WalletTransactionsPaginated = WalletTransactions & {
     meta: PaginationMeta;
 };
+export interface WebhookPublicKeyObject {
+    /**
+     * Base64-encoded public key used to verify webhook signatures.
+     * @example "MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE="
+     */
+    public_key: string;
+}
+export interface WebhookPublicKey {
+    webhook: WebhookPublicKeyObject;
+}
 export interface WebhookEndpointObject {
     /**
      * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
@@ -8584,8 +8789,8 @@ export interface WebhookEndpointObject {
      */
     lago_organization_id: string;
     /**
-     * The name of the wallet.
-     * @example "Prepaid"
+     * The URL of the webhook endpoint.
+     * @example "https://foo.bar"
      */
     webhook_url: string;
     /**
@@ -8593,6 +8798,16 @@ export interface WebhookEndpointObject {
      * @example "hmac"
      */
     signature_algo?: "jwt" | "hmac";
+    /**
+     * The name of the webhook.
+     * @example "EC2-production"
+     */
+    name?: string | null;
+    /**
+     * A list of event types that will trigger the webhook. Passing null means that all event types will be sent.
+     * @example ["invoice.voided","customer.created"]
+     */
+    event_types?: any[] | null;
     /**
      * The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -8616,6 +8831,16 @@ export interface WebhookEndpointCreateInput {
          * @example "hmac"
          */
         signature_algo?: "jwt" | "hmac";
+        /**
+         * The name of the webhook.
+         * @example "EC2-production"
+         */
+        name?: string | null;
+        /**
+         * A list of event types that will trigger the webhook. Passing null means that all event types will be sent.
+         * @example ["invoice.voided","customer.created"]
+         */
+        event_types?: any[] | null;
     };
 }
 export interface WebhookEndpoint {
@@ -8633,6 +8858,16 @@ export interface WebhookEndpointUpdateInput {
          * @example "hmac"
          */
         signature_algo?: "jwt" | "hmac";
+        /**
+         * The name of the webhook.
+         * @example "EC2-production"
+         */
+        name?: string | null;
+        /**
+         * A list of event types that will trigger the webhook. Passing null means that all event types will be sent.
+         * @example ["invoice.voided","customer.created"]
+         */
+        event_types?: any[] | null;
     };
 }
 export interface TriggeredAlertObject {
@@ -8825,6 +9060,18 @@ export interface CreditNotePaymentProviderRefundError {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
+export interface OverdueBalancePerCurrencyObject {
+    /**
+     * The amount of the overdue balance for this currency, expressed in cents.
+     * @example 120
+     */
+    amount_cents: number;
+    /**
+     * The currency of the overdue balance.
+     * @example "EUR"
+     */
+    currency: Currency;
+}
 export interface DunningCampaignFinishedObject {
     /**
      * The customer external unique identifier (provided by your own application).
@@ -8846,6 +9093,8 @@ export interface DunningCampaignFinishedObject {
      * @example "EUR"
      */
     overdue_balance_currency: Currency;
+    /** Overdue balance broken down per currency. */
+    overdue_balances?: OverdueBalancePerCurrencyObject[];
 }
 export interface EventErrorsObject {
     /**
@@ -8877,7 +9126,10 @@ export interface EventsErrorsObject {
      * @example ["transaction_1234567890"]
      */
     invalid_filter_values: string[];
-    /** @deprecated */
+    /**
+     * **Deprecated.** List of event transaction_id with a missing group key.
+     * @deprecated
+     */
     missing_group_key: string[];
 }
 export interface FeeTaxProviderErrorObject {
@@ -9135,7 +9387,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.49.0
+ * @version 1.52.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -9898,6 +10150,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "INV-001-002"
              */
             invoice_number?: string;
+            /**
+             * Filter by the invoice purchase order number. The match is exact but case-insensitive.
+             * @example "PO-123"
+             */
+            purchase_order_number?: string;
             /**
              * Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
              * @example 9000
@@ -10206,6 +10463,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "INV-001-002"
              */
             invoice_number?: string;
+            /**
+             * Filter by the invoice purchase order number. The match is exact but case-insensitive.
+             * @example "PO-123"
+             */
+            purchase_order_number?: string;
             /**
              * Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
              * @example 9000
@@ -10295,6 +10557,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "someValue"
              */
             "metadata[key]"?: string;
+            /**
+             * Filter by the invoice purchase order number. The match is exact but case-insensitive.
+             * @example "PO-123"
+             */
+            purchase_order_number?: string;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to list all payments of a customer
@@ -10617,20 +10884,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             group?: Record<string, string>;
             /**
-             * Filter usage to a specific charge by its Lago ID (UUID).
+             * **Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).
              * @deprecated
              * @format uuid
              * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
              */
             filter_by_charge_id?: string;
             /**
-             * Filter usage to a specific charge by its code.
+             * **Deprecated.** Filter usage to a specific charge by its code.
              * @deprecated
              * @example "storage"
              */
             filter_by_charge_code?: string;
             /**
-             * Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
+             * **Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
              * @deprecated
              * @example {"cloud":"aws"}
              */
@@ -11101,6 +11368,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "someValue"
              */
             "metadata[key]"?: string;
+            /**
+             * Filter by the invoice purchase order number. The match is exact but case-insensitive.
+             * @example "PO-123"
+             */
+            purchase_order_number?: string;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used for updating an existing invoice.
@@ -11122,6 +11394,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         findInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for permanently deleting a `draft` invoice. Deleting a draft invoice removes it entirely: it never becomes accounts receivable, consumes no invoice number, and disappears from every list, export, and analytics surface. Only invoices in the `draft` status can be deleted; for a `finalized` invoice, void it instead.
+         *
+         * @tags invoices
+         * @name DeleteInvoice
+         * @summary Delete a draft invoice
+         * @request DELETE:/invoices/{lago_id}
+         * @secure
+         */
+        deleteInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
          * @description This endpoint is used for downloading a specific invoice PDF document.
          *
@@ -11297,6 +11579,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * Unique identifier assigned to the customer in your application.
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -11755,6 +12042,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * The customer external unique identifier (provided by your own application)
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -11823,8 +12115,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         destroySubscription: (externalId: string, query?: {
             /**
-             * If the field is not defined, Lago will terminate only `active` subscriptions. However, if you wish to cancel a `pending` subscription, please ensure that you include `status=pending` in your request.
-             * @example "pending"
+             * Selects which subscription to terminate for the given `external_id`, based on its status. If the field is not defined, Lago targets only `active` subscriptions.
+             *
+             * - `pending`: cancel a subscription scheduled for a future activation (include `status=pending`).
+             * - `incomplete`: cancel a payment-gated subscription that is still awaiting its activation payment (include `status=incomplete`). The subscription is canceled with `cancellation_reason: manual`, its invoice is closed and nothing is billed, and any pending payment is canceled on a best-effort basis with the payment provider (some provider statuses cannot be canceled). Applied coupons, credit notes and wallet credits are recredited. Termination behaviours (`on_termination_credit_note`, `on_termination_invoice`) are ignored, as an incomplete subscription has never been billed.
+             * @default "active"
+             * @example "incomplete"
              */
             status?: string;
             /**
@@ -12351,6 +12647,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * The customer external unique identifier (provided by your own application).
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -12551,9 +12852,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FetchPublicKey
          * @summary Retrieve webhook public key
          * @request GET:/webhooks/public_key
+         * @deprecated
          * @secure
          */
         fetchPublicKey: (params?: RequestParams) => Promise<HttpResponse<string, ApiErrorUnauthorized>>;
+        /**
+         * @description This endpoint is used to retrieve the public key used to verify the webhooks signature, wrapped in a JSON object. Prefer this endpoint over the deprecated GET /webhooks/public_key.
+         *
+         * @tags webhooks
+         * @name FetchJsonPublicKey
+         * @summary Retrieve webhook public key (JSON)
+         * @request GET:/webhooks/json_public_key
+         * @secure
+         */
+        fetchJsonPublicKey: (params?: RequestParams) => Promise<HttpResponse<WebhookPublicKey, ApiErrorUnauthorized>>;
     };
     webhookEndpoints: {
         /**