lago-javascript-client 1.27.1 → 1.30.0

package/esm/openapi/client.d.ts

@@ -169,6 +169,150 @@ export interface ApiErrorUnprocessableEntity {
     code: string;
     error_details: object;
 }
+/** Billing entity create input */
+export interface BillingEntityCreateInput {
+    billing_entity: {
+        /**
+         * The unique code of the billing entity
+         * @example "acme_corp"
+         */
+        code: string;
+        /**
+         * The name of the billing entity
+         * @example "Acme Corp"
+         */
+        name: string;
+        /**
+         * The default currency of the billing entity
+         * @example "USD"
+         */
+        default_currency?: Currency;
+        /**
+         * The type of document numbering for this billing entity:
+         * - `per_customer`: document numbers are unique per customer
+         * - `per_billing_entity`: document numbers are unique per billing entity
+         */
+        document_numbering?: "per_customer" | "per_billing_entity";
+        /**
+         * The prefix used in document numbers for this billing entity
+         * @example "ABC-123"
+         */
+        document_number_prefix?: string | null;
+        /**
+         * Whether to finalize invoices with zero amount for this billing entity
+         * @example true
+         */
+        finalize_zero_amount_invoice?: boolean;
+        billing_configuration?: {
+            /**
+             * The footer text to be displayed on invoices for this billing entity
+             * @example "Thank you for your business"
+             */
+            invoice_footer?: string;
+            /**
+             * The language of the documents generated for this billing entity
+             * @example "en"
+             */
+            document_locale?: string;
+            /**
+             * The grace period (in days) for invoice finalization
+             * @example 0
+             */
+            invoice_grace_period?: number;
+        };
+        /**
+         * The net payment term (in days) for this billing entity
+         * @example 0
+         */
+        net_payment_term?: number;
+        /**
+         * The first line of the billing address
+         * @example "5230 Penfield Ave"
+         */
+        address_line1?: string | null;
+        /**
+         * The second line of the billing address
+         * @example "Suite 100"
+         */
+        address_line2?: string | null;
+        /**
+         * The city of the billing address
+         * @example "Woodland Hills"
+         */
+        city?: string | null;
+        /**
+         * The state of the billing address
+         * @example "CA"
+         */
+        state?: string | null;
+        /** The country code of the billing address */
+        country?: Country | null;
+        /**
+         * The zipcode of the billing address
+         * @example "91364"
+         */
+        zipcode?: string | null;
+        /**
+         * The email address of the billing entity
+         * @format email
+         * @example "billing@acme.com"
+         */
+        email?: string | null;
+        /**
+         * The legal name of the billing entity
+         * @example "Acme Corporation"
+         */
+        legal_name?: string | null;
+        /**
+         * The legal registration number of the billing entity
+         * @example "US123456789"
+         */
+        legal_number?: string | null;
+        /**
+         * The tax identification number of the billing entity
+         * @example "EU123456789"
+         */
+        tax_identification_number?: string | null;
+        /**
+         * The timezone of the billing entity
+         * @example "UTC"
+         */
+        timezone?: Timezone;
+        /** The email notification settings for this billing entity */
+        email_settings?: ("invoice.finalized" | "credit_note.created")[];
+        /**
+         * Whether EU tax management is enabled for this billing entity
+         * @example false
+         */
+        eu_tax_management?: boolean;
+        /**
+         * The base64 encoded logo image for the billing entity
+         * @format uri
+         * @example "data:image/png;base64,..."
+         */
+        logo?: string | null;
+    };
+}
+export interface ApiErrorBadRequest {
+    /**
+     * @format int32
+     * @example 400
+     */
+    status: number;
+    /** @example "Bad request" */
+    error: string;
+}
+export interface ApiErrorForbidden {
+    /**
+     * @format int32
+     * @example 403
+     */
+    status: number;
+    /** @example "Forbidden" */
+    error: string;
+    /** @example "feature_unavailable" */
+    code: string;
+}
 export interface TaxObject {
     /**
      * Unique identifier of the tax, created by Lago.
@@ -197,7 +341,8 @@ export interface TaxObject {
      */
     rate: number;
     /**
-     * Set to `true` if the tax is used as one of the organization's default
+     * 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
      */
     applied_to_organization: boolean;
@@ -208,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 {
     /**
@@ -222,51 +419,206 @@ export interface ApiErrorNotFound {
     /** @example "object_not_found" */
     code: string;
 }
-export interface AddOnObject {
+/** Billing entity update input */
+export interface BillingEntityUpdateInput {
     /**
-     * Unique identifier of the add-on, created by Lago.
+     * The name of the billing entity
+     * @example "Acme Corp"
+     */
+    name?: string;
+    /**
+     * The default currency of the billing entity
+     * @example "USD"
+     */
+    default_currency?: Currency;
+    /**
+     * The type of document numbering for this billing entity:
+     * - `per_customer`: document numbers are unique per customer
+     * - `per_billing_entity`: document numbers are unique per billing entity
+     */
+    document_numbering?: "per_customer" | "per_billing_entity";
+    /**
+     * The prefix used in document numbers for this billing entity
+     * @example "ABC-123"
+     */
+    document_number_prefix?: string | null;
+    /**
+     * Whether to finalize invoices with zero amount for this billing entity
+     * @example true
+     */
+    finalize_zero_amount_invoice?: boolean;
+    billing_configuration?: {
+        /**
+         * The footer text to be displayed on invoices for this billing entity
+         * @example "Thank you for your business"
+         */
+        invoice_footer?: string;
+        /**
+         * The language of the documents generated for this billing entity
+         * @example "en"
+         */
+        document_locale?: string;
+        /**
+         * The grace period (in days) for invoice finalization
+         * @example 0
+         */
+        invoice_grace_period?: number;
+    };
+    /**
+     * The net payment term (in days) for this billing entity
+     * @example 0
+     */
+    net_payment_term?: number;
+    /**
+     * The first line of the billing address
+     * @example "5230 Penfield Ave"
+     */
+    address_line1?: string | null;
+    /**
+     * The second line of the billing address
+     * @example "Suite 100"
+     */
+    address_line2?: string | null;
+    /**
+     * The city of the billing address
+     * @example "Woodland Hills"
+     */
+    city?: string | null;
+    /**
+     * The state of the billing address
+     * @example "CA"
+     */
+    state?: string | null;
+    /** The country code of the billing address */
+    country?: Country | null;
+    /**
+     * The zipcode of the billing address
+     * @example "91364"
+     */
+    zipcode?: string | null;
+    /**
+     * The email address of the billing entity
+     * @format email
+     * @example "billing@acme.com"
+     */
+    email?: string | null;
+    /**
+     * The legal name of the billing entity
+     * @example "Acme Corporation"
+     */
+    legal_name?: string | null;
+    /**
+     * The legal registration number of the billing entity
+     * @example "US123456789"
+     */
+    legal_number?: string | null;
+    /**
+     * The tax identification number of the billing entity
+     * @example "EU123456789"
+     */
+    tax_identification_number?: string | null;
+    /**
+     * The timezone of the billing entity
+     * @example "UTC"
+     */
+    timezone?: Timezone;
+    /**
+     * The tax codes that should be associated with this billing entity
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+    /** The email notification settings for this billing entity */
+    email_settings?: ("invoice.finalized" | "credit_note.created")[];
+    /**
+     * Whether EU tax management is enabled for this billing entity
+     * @example false
+     */
+    eu_tax_management?: boolean;
+    /**
+     * The base64 encoded logo image for the billing entity
+     * @format uri
+     * @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 ActivityLogObject {
+    /**
+     * 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 "{ "id": "dad68bc7-c01a-4ad8-a87b-13e78693a5bc", "plan_id": "b9155544-e261-4e92-b54e-f65d7609294c", ... }"
      */
-    amount_cents: number;
+    activity_object?: string | 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?: string | 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 {
     /**
@@ -295,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;
@@ -342,15 +747,6 @@ export interface AddOnCreateInput {
 export interface AddOn {
     add_on: AddOnObject;
 }
-export interface ApiErrorBadRequest {
-    /**
-     * @format int32
-     * @example 400
-     */
-    status: number;
-    /** @example "Bad request" */
-    error: string;
-}
 export interface AddOnUpdateInput {
     add_on: AddOnBaseInput;
 }
@@ -1729,8 +2125,9 @@ export interface CreditNoteObject {
      */
     self_billed?: boolean;
 }
-export interface CreditNotes {
+export interface CreditNotesPaginated {
     credit_notes: CreditNoteObject[];
+    meta: PaginationMeta;
 }
 export interface CreditNoteCreateInput {
     credit_note: {
@@ -2228,81 +2625,31 @@ export interface IntegrationCustomer {
      * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite" | "anrok";
-    /**
-     * 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;
-    /**
-     * This optional field is needed only when working with `netsuite` connection.
-     * @example "2"
-     */
-    subsidiary_id?: string;
-}
-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;
+    type?: "netsuite" | "anrok";
     /**
-     * The name of the invoice custom section displayed on the invoice.
-     * @example "Bank Details:"
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
      */
-    display_name?: string;
+    integration_code?: string;
     /**
-     * Set to true if the invoice custom section is a default for the organization.
-     * @example true
+     * 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"
      */
-    applied_to_organization?: boolean;
+    external_customer_id?: string;
     /**
-     * Unique identifier for the organization associated with the invoice custom section.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     * 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
      */
-    organization_id?: string;
+    sync_with_provider?: boolean;
     /**
-     * Creation date of the tax.
-     * @format date-time
-     * @example "2023-07-06T14:35:58Z"
+     * This optional field is needed only when working with `netsuite` connection.
+     * @example "2"
      */
-    created_at?: string;
+    subsidiary_id?: string;
 }
+export type CustomerObject = CustomerBaseObject & {
+    integration_customers?: IntegrationCustomer[];
+};
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -3166,7 +3513,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;
@@ -3814,6 +4161,12 @@ export interface Organization {
     organization: OrganizationObject;
 }
 export interface PaymentObject {
+    /**
+     * Unique identifier of the payment, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
     /**
      * The unique identifier of the paid resource, created by Lago.
      * @format uuid
@@ -3835,7 +4188,7 @@ export interface PaymentObject {
      * The customer external unique identifier (provided by your own application)
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    external_id: string;
+    external_id?: string;
     /**
      * Unique identifier of the customer within the payment provider
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -3857,6 +4210,16 @@ export interface PaymentObject {
      */
     provider_payment_id: string;
     next_action: Record<string, any>;
+    /**
+     * The amount of the payment in cents
+     * @example 1000
+     */
+    amount_cents?: number;
+    /**
+     * The currency of the payment
+     * @example "EUR"
+     */
+    amount_currency?: string;
 }
 export interface PaymentReceiptObject {
     /**
@@ -4071,6 +4434,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?: {
         /**
@@ -4177,11 +4552,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?: {
         /**
@@ -4197,13 +4567,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"
          */
@@ -4932,6 +5302,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;
@@ -4959,7 +5460,8 @@ export interface TaxBaseInput {
      */
     description?: string | null;
     /**
-     * Set to `true` if the tax is used as one of the organization's default
+     * 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
      */
     applied_to_organization?: boolean;
@@ -5627,6 +6129,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.
@@ -5717,92 +6288,7 @@ export interface CreditNotePaymentProviderRefundError {
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_credit_note_id: string;
-    /**
-     * 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.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_customer_id: string;
-    /**
-     * The customer external unique identifier (provided by your own application)
-     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-     */
-    external_customer_id: string;
-    /**
-     * Unique identifier of the customer within the payment provider
-     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-     */
-    provider_customer_id?: string;
-    /**
-     * The type of payment provider code
-     * @example "stripe"
-     */
-    payment_provider: "adyen" | "cashfree" | "gocardless" | "stripe";
-    /**
-     * Code of the payment provider
-     * @example "Stripe Prod"
-     */
-    payment_provider_code?: string;
-    provider_error?: string | Record<string, any>;
-}
-export interface EventErrorsObject {
-    /**
-     * HTTP status code. It will always be 422
-     * @example 422
-     */
-    status: number;
-    /**
-     * HTTP error description. It will always be "Unprocessable Entity"
-     * @example "Unprocessable Entity"
-     */
-    error: string;
-    message: string | Record<string, any>;
-    event: EventObject;
-}
-export interface EventsErrorsObject {
-    /**
-     * List of event transaction_id with an invalid code
-     * @example ["transaction_1234567890"]
-     */
-    invalid_code: string[];
-    /**
-     * List of event transaction_id with a missing aggregation property
-     * @example ["transaction_1234567890"]
-     */
-    missing_aggregation_property: string[];
-    /**
-     * List of event transaction_id with invalid filter values
-     * @example ["transaction_1234567890"]
-     */
-    invalid_filter_values: string[];
-}
-export interface FeeTaxProviderErrorObject {
-    /**
-     * Code of the tax provider
-     * @example "Stripe Prod"
-     */
-    tax_provider_code: string;
-    /**
-     * Unique identifier assigned to the charge that the fee belongs to
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_charge_id: string | null;
-    /**
-     * Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge`.
-     * @example "transaction_1234567890"
-     */
-    event_transaction_id: string | null;
-    provider_error: string | Record<string, any>;
-}
-export interface InvoicePaymentFailureObject {
-    /**
-     * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_invoice_id: string;
+    lago_credit_note_id: string;
     /**
      * 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.
      * @format uuid
@@ -5831,110 +6317,63 @@ export interface InvoicePaymentFailureObject {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
-export interface IntegrationProviderErrorObject {
-    /**
-     * Unique identifier assigned to the integration within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the integration's record within the Lago system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_integration_id: string;
+export interface EventErrorsObject {
     /**
-     * The type of integration provider
-     * @example "netsuite"
+     * HTTP status code. It will always be 422
+     * @example 422
      */
-    provider: string;
+    status: number;
     /**
-     * Unique code used to identify an integration connection.
-     * @example "netsuite-eu-1"
+     * HTTP error description. It will always be "Unprocessable Entity"
+     * @example "Unprocessable Entity"
      */
-    provider_code: string;
-    provider_error: string | Record<string, any>;
+    error: string;
+    message: string | Record<string, any>;
+    event: EventObject;
 }
-export interface PaymentProviderErrorObject {
-    /**
-     * Unique identifier assigned to the payment provider within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the payment provider's record within the Lago system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_payment_provider_id: string;
-    /**
-     * The name of payment provider
-     * @example "Stripe Prod"
-     */
-    payment_provider_name: string;
+export interface EventsErrorsObject {
     /**
-     * Code of the payment provider
-     * @example "stripe"
+     * List of event transaction_id with an invalid code
+     * @example ["transaction_1234567890"]
      */
-    payment_provider_code: string;
+    invalid_code: string[];
     /**
-     * The source of the error
-     * @example "stripe"
+     * List of event transaction_id with a missing aggregation property
+     * @example ["transaction_1234567890"]
      */
-    source: "stripe";
+    missing_aggregation_property: string[];
     /**
-     * The action that was being performed when the error occurred
-     * @example "payment_provider.register_webhook"
+     * List of event transaction_id with invalid filter values
+     * @example ["transaction_1234567890"]
      */
-    action?: "payment_provider.register_webhook";
-    provider_error: string | Record<string, any>;
+    invalid_filter_values: string[];
 }
-export interface PaymentRequestPaymentFailureObject {
-    /**
-     * Unique identifier assigned to the payment request within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the payment request record within the Lago system.
-     * @format uuid
-     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
-     */
-    lago_payment_request_id: string;
+export interface FeeTaxProviderErrorObject {
     /**
-     * List of unique identifiers assigned to the invoices within the Lago application. These IDs are exclusively created by Lago and serve as unique identifiers for the invoices records within the Lago system.
-     * @example ["1a901a90-1a90-1a90-1a90-1a901a901a90"]
+     * Code of the tax provider
+     * @example "Stripe Prod"
      */
-    lago_invoice_ids: string[];
+    tax_provider_code: string;
     /**
-     * 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.
+     * Unique identifier assigned to the charge that the fee belongs to
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_customer_id: string;
-    /**
-     * The customer external unique identifier (provided by your own application)
-     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-     */
-    external_customer_id: string;
-    /**
-     * Unique identifier of the customer within the payment provider
-     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
-     */
-    provider_customer_id?: string;
-    /**
-     * The type of payment provider code
-     * @example "stripe"
-     */
-    payment_provider: "adyen" | "cashfree" | "gocardless" | "stripe";
+    lago_charge_id: string | null;
     /**
-     * Code of the payment provider
-     * @example "Stripe Prod"
+     * Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge`.
+     * @example "transaction_1234567890"
      */
-    payment_provider_code?: string;
-    provider_error?: string | Record<string, any>;
+    event_transaction_id: string | null;
+    provider_error: string | Record<string, any>;
 }
-export type SubscriptionWithCustomerObject = SubscriptionObject & {
-    plan?: PlanObject;
-    customer?: CustomerObject;
-};
-export type SubscriptionWithThresholdObject = SubscriptionObject & {
-    plan?: PlanObject;
-    customer?: CustomerObject;
-    usage_threshold?: UsageThresholdObject;
-};
-export interface WalletTransactionPaymentFailureObject {
+export interface InvoicePaymentFailureObject {
     /**
-     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction's record within the Lago system.
+     * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_wallet_transaction_id: string;
+    lago_invoice_id: string;
     /**
      * 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.
      * @format uuid
@@ -5963,262 +6402,140 @@ export interface WalletTransactionPaymentFailureObject {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
-export interface ApiErrorForbidden {
+export interface IntegrationProviderErrorObject {
     /**
-     * @format int32
-     * @example 403
+     * Unique identifier assigned to the integration within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the integration's record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    status: number;
-    /** @example "Forbidden" */
-    error: string;
-    /** @example "feature_unavailable" */
-    code: string;
-}
-/** Billing entity create input */
-export interface BillingEntityCreateInput {
-    billing_entity: {
-        /**
-         * The unique code of the billing entity
-         * @example "acme_corp"
-         */
-        code: string;
-        /**
-         * The name of the billing entity
-         * @example "Acme Corp"
-         */
-        name: string;
-        /**
-         * The default currency of the billing entity
-         * @example "USD"
-         */
-        default_currency?: Currency;
-        /**
-         * The type of document numbering for this billing entity:
-         * - `per_customer`: document numbers are unique per customer
-         * - `per_billing_entity`: document numbers are unique per billing entity
-         */
-        document_numbering?: "per_customer" | "per_billing_entity";
-        /**
-         * The prefix used in document numbers for this billing entity
-         * @example "ABC-123"
-         */
-        document_number_prefix?: string | null;
-        /**
-         * Whether to finalize invoices with zero amount for this billing entity
-         * @example true
-         */
-        finalize_zero_amount_invoice?: boolean;
-        billing_configuration?: {
-            /**
-             * The footer text to be displayed on invoices for this billing entity
-             * @example "Thank you for your business"
-             */
-            invoice_footer?: string;
-            /**
-             * The language of the documents generated for this billing entity
-             * @example "en"
-             */
-            document_locale?: string;
-            /**
-             * The grace period (in days) for invoice finalization
-             * @example 0
-             */
-            invoice_grace_period?: number;
-        };
-        /**
-         * The net payment term (in days) for this billing entity
-         * @example 0
-         */
-        net_payment_term?: number;
-        /**
-         * The first line of the billing address
-         * @example "5230 Penfield Ave"
-         */
-        address_line1?: string | null;
-        /**
-         * The second line of the billing address
-         * @example "Suite 100"
-         */
-        address_line2?: string | null;
-        /**
-         * The city of the billing address
-         * @example "Woodland Hills"
-         */
-        city?: string | null;
-        /**
-         * The state of the billing address
-         * @example "CA"
-         */
-        state?: string | null;
-        /** The country code of the billing address */
-        country?: Country | null;
-        /**
-         * The zipcode of the billing address
-         * @example "91364"
-         */
-        zipcode?: string | null;
-        /**
-         * The email address of the billing entity
-         * @format email
-         * @example "billing@acme.com"
-         */
-        email?: string | null;
-        /**
-         * The legal name of the billing entity
-         * @example "Acme Corporation"
-         */
-        legal_name?: string | null;
-        /**
-         * The legal registration number of the billing entity
-         * @example "US123456789"
-         */
-        legal_number?: string | null;
-        /**
-         * The tax identification number of the billing entity
-         * @example "EU123456789"
-         */
-        tax_identification_number?: string | null;
-        /**
-         * The timezone of the billing entity
-         * @example "UTC"
-         */
-        timezone?: Timezone;
-        /** The email notification settings for this billing entity */
-        email_settings?: ("invoice.finalized" | "credit_note.created")[];
-        /**
-         * Whether EU tax management is enabled for this billing entity
-         * @example false
-         */
-        eu_tax_management?: boolean;
-        /**
-         * The base64 encoded logo image for the billing entity
-         * @format uri
-         * @example "data:image/png;base64,..."
-         */
-        logo?: string | null;
-    };
-}
-/** Billing entity update input */
-export interface BillingEntityUpdateInput {
+    lago_integration_id: string;
+    /**
+     * The type of integration provider
+     * @example "netsuite"
+     */
+    provider: string;
     /**
-     * The unique code of the billing entity
-     * @example "acme_corp"
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
      */
-    code: string;
+    provider_code: string;
+    provider_error: string | Record<string, any>;
+}
+export interface PaymentProviderErrorObject {
     /**
-     * The name of the billing entity
-     * @example "Acme Corp"
+     * Unique identifier assigned to the payment provider within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the payment provider's record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    name?: string;
+    lago_payment_provider_id: string;
     /**
-     * The default currency of the billing entity
-     * @example "USD"
+     * The name of payment provider
+     * @example "Stripe Prod"
      */
-    default_currency?: Currency;
+    payment_provider_name: string;
     /**
-     * The type of document numbering for this billing entity:
-     * - `per_customer`: document numbers are unique per customer
-     * - `per_billing_entity`: document numbers are unique per billing entity
+     * Code of the payment provider
+     * @example "stripe"
      */
-    document_numbering?: "per_customer" | "per_billing_entity";
+    payment_provider_code: string;
     /**
-     * The prefix used in document numbers for this billing entity
-     * @example "ABC-123"
+     * The source of the error
+     * @example "stripe"
      */
-    document_number_prefix?: string | null;
+    source: "stripe";
     /**
-     * Whether to finalize invoices with zero amount for this billing entity
-     * @example true
+     * The action that was being performed when the error occurred
+     * @example "payment_provider.register_webhook"
      */
-    finalize_zero_amount_invoice?: boolean;
-    billing_configuration?: {
-        /**
-         * The footer text to be displayed on invoices for this billing entity
-         * @example "Thank you for your business"
-         */
-        invoice_footer?: string;
-        /**
-         * The language of the documents generated for this billing entity
-         * @example "en"
-         */
-        document_locale?: string;
-        /**
-         * The grace period (in days) for invoice finalization
-         * @example 0
-         */
-        invoice_grace_period?: number;
-    };
+    action?: "payment_provider.register_webhook";
+    provider_error: string | Record<string, any>;
+}
+export interface PaymentRequestPaymentFailureObject {
     /**
-     * The net payment term (in days) for this billing entity
-     * @example 0
+     * Unique identifier assigned to the payment request within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the payment request record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    net_payment_term?: number;
+    lago_payment_request_id: string;
     /**
-     * The first line of the billing address
-     * @example "5230 Penfield Ave"
+     * List of unique identifiers assigned to the invoices within the Lago application. These IDs are exclusively created by Lago and serve as unique identifiers for the invoices records within the Lago system.
+     * @example ["1a901a90-1a90-1a90-1a90-1a901a901a90"]
      */
-    address_line1?: string | null;
+    lago_invoice_ids: string[];
     /**
-     * The second line of the billing address
-     * @example "Suite 100"
+     * 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.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    address_line2?: string | null;
+    lago_customer_id: string;
     /**
-     * The city of the billing address
-     * @example "Woodland Hills"
+     * The customer external unique identifier (provided by your own application)
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    city?: string | null;
+    external_customer_id: string;
     /**
-     * The state of the billing address
-     * @example "CA"
+     * Unique identifier of the customer within the payment provider
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    state?: string | null;
-    /** The country code of the billing address */
-    country?: Country | null;
+    provider_customer_id?: string;
     /**
-     * The zipcode of the billing address
-     * @example "91364"
+     * The type of payment provider code
+     * @example "stripe"
      */
-    zipcode?: string | null;
+    payment_provider: "adyen" | "cashfree" | "gocardless" | "stripe";
     /**
-     * The email address of the billing entity
-     * @format email
-     * @example "billing@acme.com"
+     * Code of the payment provider
+     * @example "Stripe Prod"
      */
-    email?: string | null;
+    payment_provider_code?: string;
+    provider_error?: string | Record<string, any>;
+}
+export type SubscriptionWithCustomerObject = SubscriptionObject & {
+    plan?: PlanObject;
+    customer?: CustomerObject;
+};
+export type SubscriptionWithThresholdObject = SubscriptionObject & {
+    plan?: PlanObject;
+    customer?: CustomerObject;
+    usage_threshold?: UsageThresholdObject;
+};
+export interface WalletTransactionPaymentFailureObject {
     /**
-     * The legal name of the billing entity
-     * @example "Acme Corporation"
+     * Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction's record within the Lago system.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    legal_name?: string | null;
+    lago_wallet_transaction_id: string;
     /**
-     * The legal registration number of the billing entity
-     * @example "US123456789"
+     * 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.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    legal_number?: string | null;
+    lago_customer_id: string;
     /**
-     * The tax identification number of the billing entity
-     * @example "EU123456789"
+     * The customer external unique identifier (provided by your own application)
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    tax_identification_number?: string | null;
+    external_customer_id: string;
     /**
-     * The timezone of the billing entity
-     * @example "UTC"
+     * Unique identifier of the customer within the payment provider
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
-    timezone?: Timezone;
-    /** The email notification settings for this billing entity */
-    email_settings?: ("invoice.finalized" | "credit_note.created")[];
+    provider_customer_id?: string;
     /**
-     * Whether EU tax management is enabled for this billing entity
-     * @example false
+     * The type of payment provider code
+     * @example "stripe"
      */
-    eu_tax_management?: boolean;
+    payment_provider: "adyen" | "cashfree" | "gocardless" | "stripe";
     /**
-     * The base64 encoded logo image for the billing entity
-     * @format uri
-     * @example "data:image/png;base64,..."
+     * Code of the payment provider
+     * @example "Stripe Prod"
      */
-    logo?: string | null;
+    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>;
@@ -6281,7 +6598,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.26.0
+ * @version 1.28.1
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -6303,6 +6620,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         listBillingEntities: (params?: RequestParams) => Promise<HttpResponse<{
             billing_entities: BillingEntityObject[];
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to create a new billing entity
+         *
+         * @tags billing_entities
+         * @name CreateBillingEntity
+         * @summary Create a billing entity
+         * @request POST:/billing_entities
+         * @secure
+         */
+        createBillingEntity: (data: BillingEntityCreateInput, params?: RequestParams) => Promise<HttpResponse<BillingEntityObject, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorForbidden>>;
         /**
          * @description This endpoint returns a specific billing entity by its code
          *
@@ -6315,6 +6642,96 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         getBillingEntity: (code: string, params?: RequestParams) => Promise<HttpResponse<{
             billing_entity: BillingEntityObjectExtended;
         }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used to update an existing billing entity
+         *
+         * @tags billing_entities
+         * @name UpdateBillingEntity
+         * @summary Update a billing entity
+         * @request PUT:/billing_entities/{code}
+         * @secure
+         */
+        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: {
         /**
@@ -6357,7 +6774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/add_ons/{code}
          * @secure
          */
-        updateAddOn: (code: string, data: AddOnUpdateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateAddOn: (code: string, data: AddOnUpdateInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve a specific add-on.
          *
@@ -6498,7 +6915,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/applied_coupons
          * @secure
          */
-        applyCoupon: (data: AppliedCouponInput, params?: RequestParams) => Promise<HttpResponse<AppliedCoupon, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        applyCoupon: (data: AppliedCouponInput, params?: RequestParams) => Promise<HttpResponse<AppliedCoupon, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.
          *
@@ -6529,6 +6946,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: {
@@ -6582,7 +7004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/billable_metrics/{code}
          * @secure
          */
-        updateBillableMetric: (code: string, data: BillableMetricUpdateInput, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateBillableMetric: (code: string, data: BillableMetricUpdateInput, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint deletes an existing billable metric representing a pricing component of your application.
          *
@@ -6645,7 +7067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/coupons/{code}
          * @secure
          */
-        updateCoupon: (code: string, data: CouponUpdateInput, params?: RequestParams) => Promise<HttpResponse<Coupon, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateCoupon: (code: string, data: CouponUpdateInput, params?: RequestParams) => Promise<HttpResponse<Coupon, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve a specific coupon.
          *
@@ -6756,7 +7178,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example ["billing_entity_code_1","billing_entity_code_2"]
              */
             billing_entity_codes?: string[];
-        }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiErrorUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<CreditNotesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint updates an existing credit note.
          *
@@ -6766,7 +7188,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/credit_notes/{lago_id}
          * @secure
          */
-        updateCreditNote: (lagoId: string, data: CreditNoteUpdateInput, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateCreditNote: (lagoId: string, data: CreditNoteUpdateInput, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves an existing credit note.
          *
@@ -7040,7 +7462,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/events/estimate_fees
          * @secure
          */
-        eventEstimateFees: (data: EventEstimateFeesInput, params?: RequestParams) => Promise<HttpResponse<Fees, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        eventEstimateFees: (data: EventEstimateFeesInput, params?: RequestParams) => Promise<HttpResponse<Fees, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
          *
@@ -7173,7 +7595,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/fees/{lago_id}
          * @secure
          */
-        updateFee: (lagoId: string, data: FeeUpdateInput, params?: RequestParams) => Promise<HttpResponse<Fee, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest | ApiErrorNotAllowed>>;
+        updateFee: (lagoId: string, data: FeeUpdateInput, params?: RequestParams) => Promise<HttpResponse<Fee, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound | ApiErrorNotAllowed>>;
         /**
          * @description This endpoint is used for deleting a specific fee that has not yet been invoiced
          *
@@ -7294,7 +7716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/invoices/{lago_id}
          * @secure
          */
-        updateInvoice: (lagoId: string, data: InvoiceUpdateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateInvoice: (lagoId: string, data: InvoiceUpdateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used for retrieving a specific invoice that has been issued.
          *
@@ -7525,7 +7947,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.
@@ -7548,7 +7970,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/plans
          * @secure
          */
-        createPlan: (data: PlanCreateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        createPlan: (data: PlanCreateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves all existing plans.
          *
@@ -7579,7 +8001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/plans/{code}
          * @secure
          */
-        updatePlan: (code: string, data: PlanUpdateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updatePlan: (code: string, data: PlanUpdateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific plan.
          *
@@ -7611,7 +8033,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/subscriptions
          * @secure
          */
-        createSubscription: (data: SubscriptionCreateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        createSubscription: (data: SubscriptionCreateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves all active subscriptions.
          *
@@ -7657,7 +8079,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.
          *
@@ -7667,7 +8097,7 @@ 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 | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateSubscription: (externalId: string, data: SubscriptionUpdateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to terminate a subscription.
          *
@@ -7689,7 +8119,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
          */
@@ -7703,7 +8133,57 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/subscriptions/{external_id}/lifetime_usage
          * @secure
          */
-        updateSubscriptionLifetimeUsage: (externalId: string, data: LifetimeUsageInput, params?: RequestParams) => Promise<HttpResponse<LifetimeUsage, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        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: {
         /**
@@ -7746,7 +8226,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/taxes/{code}
          * @secure
          */
-        updateTax: (code: string, data: TaxUpdateInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateTax: (code: string, data: TaxUpdateInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. The tax is identified by its unique code.
          *
@@ -7814,7 +8294,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/wallets/{lago_id}
          * @secure
          */
-        updateWallet: (lagoId: string, data: WalletUpdateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateWallet: (lagoId: string, data: WalletUpdateInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve an existing wallet with prepaid credits.
          *
@@ -7957,7 +8437,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/webhook_endpoints/{lago_id}
          * @secure
          */
-        updateWebhookEndpoint: (lagoId: string, data: WebhookEndpointUpdateInput, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound | ApiErrorBadRequest>>;
+        updateWebhookEndpoint: (lagoId: string, data: WebhookEndpointUpdateInput, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint is used to retrieve an existing webhook endpoint.
          *