lago-javascript-client 1.28.1 → 1.31.0

package/script/openapi/client.d.ts

@@ -341,7 +341,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_entity/:code` endpoint instead.
+     * 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
      * @example true
      */
@@ -353,8 +353,60 @@ export interface TaxObject {
      */
     created_at: string;
 }
+export interface InvoiceCustomSectionObject {
+    /**
+     * Unique identifier for the invoice custom section in the Lago application, generated by Lago to ensure record uniqueness within the system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Name of the invoice custom section.
+     * @example "EU Bank Details"
+     */
+    name: string;
+    /**
+     * Unique code identifying the invoice custom section for the API request.
+     * @example "eu_bank_details"
+     */
+    code: string;
+    /**
+     * Internal description of the invoice custom section.
+     * @example "This section contains the bank details for EU customers."
+     */
+    description?: string;
+    /**
+     * The value shown on the invoice PDF.
+     * @example "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143"
+     */
+    details?: string;
+    /**
+     * The name of the invoice custom section displayed on the invoice.
+     * @example "Bank Details:"
+     */
+    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
+     * @example true
+     */
+    applied_to_organization?: boolean;
+    /**
+     * Unique identifier for the organization associated with the invoice custom section.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    organization_id?: string;
+    /**
+     * Creation date of the tax.
+     * @format date-time
+     * @example "2023-07-06T14:35:58Z"
+     */
+    created_at?: string;
+}
 export type BillingEntityObjectExtended = BillingEntityObject & {
     taxes?: TaxObject[];
+    selected_invoice_custom_sections?: InvoiceCustomSectionObject[];
 };
 export interface ApiErrorNotFound {
     /**
@@ -488,52 +540,85 @@ export interface BillingEntityUpdateInput {
      * @example "data:image/png;base64,..."
      */
     logo?: string | null;
+    /**
+     * The codes of the invoice custom section that should be associated with this billing entity
+     * @example ["custom_section_1","custom_section_2"]
+     */
+    invoice_custom_section_codes?: string[];
 }
-export interface AddOnObject {
+export interface ActivityLogObject {
     /**
-     * Unique identifier of the add-on, created by Lago.
+     * Unique identifier assigned to the activity log within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the activity log record within the Lago system
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_id: string;
+    activity_id: string;
     /**
-     * The name of the add-on.
-     * @example "Setup Fee"
+     * The email of the user who performed the activity
+     * @format email
+     * @example "dinesh@piedpiper.test"
      */
-    name: string;
+    user_email?: string | null;
     /**
-     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
-     * @example "Setup Fee (SF1)"
+     * This field stores the actitivy action that was performed to the activity_object.
+     * @example "billing_metric.created"
      */
-    invoice_display_name?: string;
+    activity_type: string;
     /**
-     * Unique code used to identify the add-on.
-     * @example "setup_fee"
+     * This field represents the source of the activity log, the interaction source that triggered the action.
+     * @example "api"
      */
-    code: string;
+    activity_source: "api" | "front" | "system";
     /**
-     * The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.
-     * @example 50000
+     * This field represents the final state of the object that the action was applied.
+     * @format object
+     * @example {"lago_id":"dad68bc7-c01a-4ad8-a87b-13e78693a5bc","plan_id":"b9155544-e261-4e92-b54e-f65d7609294c"}
      */
-    amount_cents: number;
+    activity_object?: object | null;
     /**
-     * The currency of the add-on.
-     * @example "USD"
+     * @format object
+     * @example {"plan_id":[null,"b9155544-e261-4e92-b54e-f65d7609294c"]}
      */
-    amount_currency: Currency;
+    activity_object_changes?: object | null;
     /**
-     * The description of the add-on.
-     * @example "Implementation fee for new customers."
+     * The customer external unique identifier (provided by your own application)
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    description?: string | null;
+    external_customer_id?: string | null;
     /**
-     * The date and time when the add-on was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the add-on was initially created.
+     * Unique identifier assigned to the subscription in your application.
+     * @example "external_id"
+     */
+    external_subscription_id?: string | null;
+    /**
+     * The resource id of the object that the action was applied.
+     * @format uuid
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    resource_id: string;
+    /**
+     * The resource type of the resource_id record.
+     * @example "BillableMetric"
+     */
+    resource_type: string;
+    /**
+     * Unique identifier for the organization associated with the activity log.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    organization_id: string;
+    /**
+     * The logged date of the activity, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
+     * @format date-time
+     * @example "2025-03-31T12:31:44Z"
+     */
+    logged_at: string;
+    /**
+     * The creation date of the activity record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
      * @format date-time
      * @example "2022-04-29T08:59:51Z"
      */
     created_at: string;
-    /** All taxes applied to the add-on. */
-    taxes?: TaxObject[];
 }
 export interface PaginationMeta {
     /**
@@ -562,6 +647,59 @@ export interface PaginationMeta {
      */
     total_count: number;
 }
+export interface ActivityLogsPaginated {
+    activity_logs: ActivityLogObject[];
+    meta: PaginationMeta;
+}
+export interface ActivityLog {
+    activity_log: ActivityLogObject;
+}
+export interface AddOnObject {
+    /**
+     * Unique identifier of the add-on, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The name of the add-on.
+     * @example "Setup Fee"
+     */
+    name: string;
+    /**
+     * Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
+     * @example "Setup Fee (SF1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * Unique code used to identify the add-on.
+     * @example "setup_fee"
+     */
+    code: string;
+    /**
+     * The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.
+     * @example 50000
+     */
+    amount_cents: number;
+    /**
+     * The currency of the add-on.
+     * @example "USD"
+     */
+    amount_currency: Currency;
+    /**
+     * The description of the add-on.
+     * @example "Implementation fee for new customers."
+     */
+    description?: string | null;
+    /**
+     * The date and time when the add-on was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the add-on was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /** All taxes applied to the add-on. */
+    taxes?: TaxObject[];
+}
 export interface AddOnsPaginated {
     add_ons: AddOnObject[];
     meta: PaginationMeta;
@@ -612,6 +750,73 @@ export interface AddOn {
 export interface AddOnUpdateInput {
     add_on: AddOnBaseInput;
 }
+export interface ApiLogObject {
+    /**
+     * Lago API version used in the request.
+     * @example "v1"
+     */
+    api_version: string;
+    /**
+     * The client used to make the request to the API.
+     * @example "Lago Ruby v1.26.0"
+     */
+    client: string;
+    /**
+     * This field represents the HTTP method of the request.
+     * @example "post"
+     */
+    http_method: "post" | "put" | "delete";
+    /**
+     * This field represents the HTTP status of the requests.
+     * @example 200
+     */
+    http_status: number;
+    /**
+     * The logged date of the api log, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
+     * @format date-time
+     * @example "2025-03-31T12:31:44Z"
+     */
+    logged_at: string;
+    /**
+     * @format object
+     * @example "{ "billable_metric": { "name": "Storage", "code": "storage" } }"
+     */
+    request_body: string;
+    /**
+     * This field represents the API origin of the requested URL
+     * @example "https://app.lago.dev/"
+     */
+    request_origin: string;
+    /**
+     * This field represents the API path of the requested URL
+     * @example "/billable_metrics"
+     */
+    request_path: string;
+    /**
+     * The creation date of the api log record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * Unique identifier for the api log.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    request_id: string;
+    /**
+     * @format object
+     * @example "{ "lago_id": "b9155544-e261-4e92-b54e-f65d7609294c", ... }"
+     */
+    request_response?: string;
+}
+export interface ApiLogsPaginated {
+    api_logs: ApiLogObject[];
+    meta: PaginationMeta;
+}
+export interface ApiLog {
+    api_log: ApiLogObject;
+}
 export interface GrossRevenueObject {
     /**
      * Identifies the month to analyze revenue.
@@ -1987,8 +2192,9 @@ export interface CreditNoteObject {
      */
     self_billed?: boolean;
 }
-export interface CreditNotes {
+export interface CreditNotesPaginated {
     credit_notes: CreditNoteObject[];
+    meta: PaginationMeta;
 }
 export interface CreditNoteCreateInput {
     credit_note: {
@@ -2511,56 +2717,6 @@ export interface IntegrationCustomer {
 export type CustomerObject = CustomerBaseObject & {
     integration_customers?: IntegrationCustomer[];
 };
-export interface InvoiceCustomSectionObject {
-    /**
-     * Unique identifier for the invoice custom section in the Lago application, generated by Lago to ensure record uniqueness within the system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_id: string;
-    /**
-     * Name of the invoice custom section.
-     * @example "EU Bank Details"
-     */
-    name: string;
-    /**
-     * Unique code identifying the invoice custom section for the API request.
-     * @example "eu_bank_details"
-     */
-    code: string;
-    /**
-     * Internal description of the invoice custom section.
-     * @example "This section contains the bank details for EU customers."
-     */
-    description?: string;
-    /**
-     * The value shown on the invoice PDF.
-     * @example "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143"
-     */
-    details?: string;
-    /**
-     * The name of the invoice custom section displayed on the invoice.
-     * @example "Bank Details:"
-     */
-    display_name?: string;
-    /**
-     * Set to true if the invoice custom section is a default for the organization.
-     * @example true
-     */
-    applied_to_organization?: boolean;
-    /**
-     * Unique identifier for the organization associated with the invoice custom section.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    organization_id?: string;
-    /**
-     * Creation date of the tax.
-     * @format date-time
-     * @example "2023-07-06T14:35:58Z"
-     */
-    created_at?: string;
-}
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -3424,7 +3580,7 @@ export interface AppliedUsageThresholdObject {
 export type InvoiceObject = InvoiceBaseObject & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
-    billing_period?: BillingPeriodObject[];
+    billing_periods?: BillingPeriodObject[];
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
     applied_usage_thresholds?: any[] | null;
@@ -3829,6 +3985,26 @@ export interface InvoicePreviewInput {
      */
     billing_entity_code?: string;
 }
+/** Parameters available when voiding an invoice that optionally generate credit notes. */
+export interface InvoiceVoidInput {
+    /**
+     * Set to `true` to force voiding the invoice and generate a credit note.
+     * @example true
+     */
+    generate_credit_note?: boolean;
+    /**
+     * Portion of the invoice amount (in cents) to be refunded to the customer in the generated credit note.
+     * @min 0
+     * @example 2000
+     */
+    refund_amount?: number;
+    /**
+     * Portion of the invoice amount (in cents) to be credited to the customer's balance in the generated credit note.
+     * @min 0
+     * @example 1150
+     */
+    credit_amount?: number;
+}
 /** The custom billing settings for your organization. */
 export interface OrganizationBillingConfiguration {
     /**
@@ -4345,6 +4521,18 @@ export interface MinimumCommitmentObject {
     taxes?: TaxObject[];
 }
 export interface ChargeProperties {
+    /**
+     * 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"]
+     */
+    grouped_by?: string[];
+    /**
+     * The list of event properties that are used to group the events on the invoice.
+     * @example ["agent_name"]
+     */
+    pricing_group_keys?: string[];
     /** Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. */
     graduated_ranges?: {
         /**
@@ -4451,11 +4639,6 @@ export interface ChargeProperties {
      * @example "1.75"
      */
     per_transaction_min_amount?: string | null;
-    /**
-     * The list of event properties that are used to group the events on the invoice for a `standard` charge model.
-     * @example ["agent_name"]
-     */
-    grouped_by?: string[];
     /** Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. */
     volume_ranges?: {
         /**
@@ -4471,13 +4654,13 @@ export interface ChargeProperties {
          */
         to_value: number | null;
         /**
-         * The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value.
+         * The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10"
          */
         flat_amount: string;
         /**
-         * The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value.
+         * The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "0.5"
          */
@@ -5206,6 +5389,137 @@ export interface LifetimeUsageInput {
         external_historical_usage_amount_cents: number;
     };
 }
+export interface AlertThresholdBaseObject {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @example "warn"
+     */
+    code?: string | null;
+    /**
+     * This field when set to `true` indicates that the alert will be retrigger when this threshold is reached after the last non-recurring threshold. Only one recurring threshold per alert allowed.
+     * @default false
+     * @example false
+     */
+    recurring?: boolean;
+}
+export type AlertThresholdObject = AlertThresholdBaseObject & {
+    /**
+     * A value that should trigger this alert, formatted as a BigDecimal.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "99.0"
+     */
+    value: string;
+};
+export interface AlertObject {
+    /**
+     * Unique identifier of the alert, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier of the organization, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_organization_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "sub_1234567890"
+     */
+    subscription_external_id: string;
+    /**
+     * The customer external unique identifier (provided by your own application).
+     * @example "cus_0987654321"
+     */
+    customer_external_id: string;
+    /** The billable metric associated with the alert. Only for alerts based on a billable metric. */
+    billable_metric: BillableMetricObject;
+    /**
+     * The type of alert.
+     * @example "billable_metric_current_usage_amount"
+     */
+    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    /**
+     * Unique code used to identify the alert.
+     * @example "storage_threshold_alert"
+     */
+    code: string;
+    /**
+     * The name of the alert.
+     * @example "Storage Usage Alert"
+     */
+    name: string | null;
+    /**
+     * When the system checked if this alert should be triggered, this value was retrieved and checked against the thresholds.
+     * @example 1000
+     */
+    previous_value: number;
+    /**
+     * The date and time in UTC (ISO 8601) when the system checked if this alert should be triggered. Null until it's processed for the first time.
+     * @format date-time
+     * @example "2025-05-19T10:04:21Z"
+     */
+    last_processed_at: string | null;
+    /** Array of thresholds associated with the alert. */
+    thresholds: AlertThresholdObject[];
+    /**
+     * The date and time in UTC (ISO 8601) when the alert was created.
+     * @format date-time
+     * @example "2025-03-20T10:00:00Z"
+     */
+    created_at: string;
+}
+export interface Alerts {
+    alerts: AlertObject[];
+    meta?: PaginationMeta;
+}
+export type AlertThresholdInput = AlertThresholdBaseObject & {
+    /**
+     * A value that should trigger this alert. This can be an integer or a string formatted as a BigDecimal.
+     * @example 99
+     */
+    value: number | string;
+};
+export interface AlertBaseInput {
+    /**
+     * Unique code used to identify the alert.
+     * @example "storage_threshold_alert"
+     */
+    code?: string;
+    /**
+     * The code of the billable metric associated with the alert. Only for alerts based on a billable metric.
+     * @example "storage_usage"
+     */
+    billable_metric_code?: string | null;
+    /**
+     * The name of the alert.
+     * @example "Storage Usage Alert"
+     */
+    name?: string | null;
+    /** Array of thresholds associated with the alert. */
+    thresholds?: AlertThresholdInput[];
+}
+export interface AlertCreateInput {
+    alert: AlertBaseInput & {
+        /**
+         * The type of alert.
+         * @example "billable_metric_current_usage_amount"
+         */
+        alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+        /**
+         * Unique code used to identify the alert.
+         * @example "storage_threshold_alert"
+         */
+        code: string;
+    };
+}
+export interface Alert {
+    alert: AlertObject;
+}
+export interface AlertUpdateInput {
+    alert: AlertBaseInput;
+}
 export interface TaxesPaginated {
     taxes: TaxObject[];
     meta: PaginationMeta;
@@ -5233,7 +5547,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_entity/:code` endpoint instead.
+     * 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
      * @example true
      */
@@ -5425,6 +5739,14 @@ export interface WalletObject {
      * @example false
      */
     invoice_requires_successful_payment?: boolean;
+    /** Set wallet limitations to fee types. */
+    applies_to?: {
+        /**
+         * 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?: any[] | null;
+    };
     /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
     recurring_transaction_rules?: WalletRecurringTransactionRule[];
     /**
@@ -5510,6 +5832,14 @@ export interface WalletCreateInput {
             /** The corresponding value for the key. */
             value?: string;
         }[];
+        /** Set wallet limitations to fee types. */
+        applies_to?: {
+            /**
+             * 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?: any[] | null;
+        };
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
@@ -5677,6 +6007,14 @@ export interface WalletUpdateInput {
                 value?: string;
             }[];
         }[];
+        /** Set wallet limitations to fee types. */
+        applies_to?: {
+            /**
+             * 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?: any[] | null;
+        };
     };
 }
 export interface WalletTransactionCreateInput {
@@ -5902,6 +6240,75 @@ export interface WebhookEndpointUpdateInput {
         signature_algo?: "jwt" | "hmac";
     };
 }
+export interface TriggeredAlertObject {
+    /**
+     * Unique identifier of the alert, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier of the organization, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_organization_id: string;
+    /**
+     * Unique identifier of the alert, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_alert_id: string;
+    /**
+     * Unique identifier of the subscription, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_subscription_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "sub_1234567890"
+     */
+    subscription_external_id: string;
+    /**
+     * The code of the billable metric associated with the alert. Only for alerts based on a billable metric.
+     * @example "storage_usage"
+     */
+    billable_metric_code: string | null;
+    /**
+     * The type of alert triggered.
+     * @example "billable_metric_current_usage_amount"
+     */
+    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    /**
+     * Unique code used to identify the alert triggered.
+     * @example "storage_threshold_alert"
+     */
+    alert_code: string;
+    /**
+     * The name of the alert triggered.
+     * @example "Storage Usage Alert"
+     */
+    alert_name: string | null;
+    /**
+     * When the system checked if this alert should be triggered, this value was retrieved and checked if any threshold were crossed between this value and previous value.
+     * @example 1200
+     */
+    current_value: number;
+    /**
+     * During the previous run, this value was retrieved.
+     * @example 900
+     */
+    previous_value: number;
+    /**
+     * The date and time in UTC (ISO 8601) when the system triggered the alert.
+     * @format date-time
+     * @example "2025-05-19T10:04:21Z"
+     */
+    triggered_at: string | null;
+    /** Array of thresholds crossed. All the recurring threshold values are present. */
+    crossed_thresholds: AlertThresholdObject[];
+}
 export interface CustomerIntegratrionErrorObject {
     /**
      * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
@@ -6238,6 +6645,9 @@ export interface WalletTransactionPaymentFailureObject {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
+export interface CreditNotes {
+    credit_notes: CreditNoteObject[];
+}
 export type CustomerPaymentProvidernErrorObject = CustomerPaymentProviderErrorObject;
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
@@ -6299,7 +6709,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.28.1
+ * @version 1.31.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -6354,6 +6764,86 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateBillingEntity: (code: string, data: BillingEntityUpdateInput, params?: RequestParams) => Promise<HttpResponse<BillingEntityObjectExtended, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
     };
+    activityLogs: {
+        /**
+         * @description This endpoint retrieves all existing activity logs that represent actions performed on application resources.
+         *
+         * @tags activity_logs
+         * @name FindAllActivityLogs
+         * @summary List all activity logs
+         * @request GET:/activity_logs
+         * @secure
+         */
+        findAllActivityLogs: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Filter activity logs from a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            from_date?: string;
+            /**
+             * Filter activity logs up to a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            to_date?: string;
+            /**
+             * Filter results by activity types
+             * @example ["billing_metric.created","billing_metric.updated"]
+             */
+            "activity_types[]"?: string[];
+            /**
+             * Filter results by activity sources
+             * @example ["api","front"]
+             */
+            "activity_sources[]"?: ("api" | "front" | "system")[];
+            /**
+             * Filter results by user emails
+             * @example ["dinesh@piedpiper.test"]
+             */
+            "user_emails[]"?: string[];
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+            /**
+             * External subscription ID
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_subscription_id?: string;
+            /**
+             * Filter results by resources unique identifiers
+             * @example ["5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba","1a901a90-1a90-1a90-1a90-1a901a901a90"]
+             */
+            "resource_ids[]"?: string[];
+            /**
+             * Filter results by resource class types
+             * @example ["BillableMetric","Invoice"]
+             */
+            "resource_types[]"?: string[];
+        }, params?: RequestParams) => Promise<HttpResponse<ActivityLogsPaginated, ApiErrorUnauthorized>>;
+        /**
+         * @description This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.
+         *
+         * @tags activity_logs
+         * @name FindActivityLog
+         * @summary Retrieve an activity log
+         * @request GET:/activity_logs/{activity_id}
+         * @secure
+         */
+        findActivityLog: (activityId: string, params?: RequestParams) => Promise<HttpResponse<ActivityLog, ApiErrorUnauthorized | ApiErrorNotFound>>;
+    };
     addOns: {
         /**
          * @description This endpoint is used to create an add-on that can be then attached to a one-off invoice.
@@ -6417,6 +6907,71 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
+    apiLogs: {
+        /**
+         * @description This endpoint retrieves all existing api logs that represent requests performed to Lago's API.
+         *
+         * @tags api_logs
+         * @name FindAllApiLogs
+         * @summary List all api logs
+         * @request GET:/api_logs
+         * @secure
+         */
+        findAllApiLogs: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Filter api logs from a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            from_date?: string;
+            /**
+             * Filter api logs up to a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            to_date?: string;
+            /**
+             * Filter results by HTTP methods
+             * @example ["post","put"]
+             */
+            "http_methods[]"?: ("post" | "put" | "delete")[];
+            /**
+             * Filter results by HTTP status or by generic request status
+             * @example ["failed","succeeded",404]
+             */
+            "http_statuses[]"?: ("succeeded" | "failed" | number)[];
+            /**
+             * Filter results by API version
+             * @example ["v1"]
+             */
+            "api_version[]"?: string[];
+            /**
+             * Filter results by the path of the request
+             * @example "/billable_metrics/"
+             */
+            request_paths?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<ApiLogsPaginated, ApiErrorUnauthorized>>;
+        /**
+         * @description This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.
+         *
+         * @tags api_logs
+         * @name FindApiLog
+         * @summary Retrieve an api log
+         * @request GET:/api_logs/{request_id}
+         * @secure
+         */
+        findApiLog: (requestId: string, params?: RequestParams) => Promise<HttpResponse<ApiLog, ApiErrorUnauthorized | ApiErrorNotFound>>;
+    };
     analytics: {
         /**
          * @description Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
@@ -6567,6 +7122,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * The code of the coupon applied to the customer. Use it to filter applied coupons by their code.
+             * @example ["BLACK_FRIDAY_2024","CHRISTMAS_2024"]
+             */
+            "coupon_code[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<AppliedCouponsPaginated, ApiErrorUnauthorized>>;
     };
     billableMetrics: {
@@ -6793,8 +7353,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * Filter credit notes by billing entity codes.
              * @example ["billing_entity_code_1","billing_entity_code_2"]
              */
-            billing_entity_codes?: string[];
-        }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiErrorUnauthorized>>;
+            "billing_entity_codes[]"?: string[];
+        }, params?: RequestParams) => Promise<HttpResponse<CreditNotesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint updates an existing credit note.
          *
@@ -6881,12 +7441,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * Filter customers by account type.
              * @example ["customer","partner"]
              */
-            account_type?: ("customer" | "partner")[];
+            "account_type[]"?: ("customer" | "partner")[];
             /**
              * Filter customers by billing entity codes.
              * @example ["billing_entity_code_1","billing_entity_code_2"]
              */
-            billing_entity_codes?: string[];
+            "billing_entity_codes[]"?: string[];
         }, params?: RequestParams) => Promise<HttpResponse<CustomersPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves an existing customer.
@@ -7316,7 +7876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.
              * @example ["acme_corp","foo_bar"]
              */
-            billing_entity_codes?: string[];
+            "billing_entity_codes[]"?: string[];
             /**
              * Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`.
              * @example "someValue"
@@ -7424,7 +7984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         retryPayment: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<void, ApiErrorUnauthorized | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
-         * @description This endpoint is used for voiding an invoice. You can void an invoice only when it's in a `finalized` status, and the payment status is not `succeeded`.
+         * @description This endpoint is used for voiding an invoice. • When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`. • When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this validation is bypassed: the invoice is forcibly voided and a credit note is generated. If the specified refund/credit amounts do not cover the full invoice total, the remainder is issued on a second credit note that is created and immediately voided.
          *
          * @tags invoices
          * @name VoidInvoice
@@ -7432,7 +7992,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/invoices/{lago_id}/void
          * @secure
          */
-        voidInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        voidInvoice: (lagoId: string, data?: InvoiceVoidInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     organizations: {
         /**
@@ -7563,7 +8123,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format uuid
              * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
              */
-            lago_invoice_id?: string;
+            invoice_id?: string;
         }, params?: RequestParams) => Promise<HttpResponse<PaymentsPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves a specific payment by its ID.
@@ -7695,7 +8255,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/subscriptions/{external_id}
          * @secure
          */
-        findSubscription: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        findSubscription: (externalId: string, query?: {
+            /**
+             * 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._
+             * @example "active"
+             */
+            status?: "active" | "terminated" | "pending" | "canceled";
+        }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to update a subscription.
          *
@@ -7727,7 +8295,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags subscriptions
          * @name GetSubscriptionLifetimeUsage
-         * @summary Retrive subscription lifetime usage
+         * @summary Retrieve subscription lifetime usage
          * @request GET:/subscriptions/{external_id}/lifetime_usage
          * @secure
          */
@@ -7742,6 +8310,56 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         updateSubscriptionLifetimeUsage: (externalId: string, data: LifetimeUsageInput, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint enables the retrieval of all alerts for a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionAlerts
+         * @summary List subscription alerts
+         * @request GET:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        getSubscriptionAlerts: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Alerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to create a new alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name CreateSubscriptionAlert
+         * @summary Create a subscription alert
+         * @request POST:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        createSubscriptionAlert: (externalId: string, data: AlertCreateInput, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint enables the retrieval of a specific alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionAlert
+         * @summary Retrieve a subscription alert
+         * @request GET:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        getSubscriptionAlert: (externalId: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to update an existing alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionAlert
+         * @summary Update a subscription alert
+         * @request PUT:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        updateSubscriptionAlert: (externalId: string, code: string, data: AlertUpdateInput, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint allows you to delete an existing alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name DeleteSubscriptionAlert
+         * @summary Delete a subscription alert
+         * @request DELETE:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        deleteSubscriptionAlert: (externalId: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
     };
     taxes: {
         /**