lago-javascript-client 1.17.0 → 1.20.0

package/script/openapi/client.d.ts

@@ -373,7 +373,7 @@ export interface BaseAppliedTax {
     created_at?: string;
 }
 export interface BillableMetric {
-    billable_metric: BillableMetricObjectExtended;
+    billable_metric: BillableMetricObject;
 }
 export interface BillableMetricObject {
     /**
@@ -443,42 +443,7 @@ export interface BillableMetricObject {
      */
     weighted_interval?: "seconds" | null;
     filters?: BillableMetricFilterObject[];
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    active_subscriptions_count: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @deprecated
-     * @example 10
-     */
-    draft_invoices_count: number;
-    /**
-     * Number of plans using this billable metric.
-     * @deprecated
-     * @example 4
-     */
-    plans_count: number;
 }
-export type BillableMetricObjectExtended = BillableMetricObject & {
-    /**
-     * Number of active subscriptions using this billable metric.
-     * @example 4
-     */
-    active_subscriptions_count?: number;
-    /**
-     * Number of draft invoices for which this billable metric is listed as an invoice item.
-     * @example 10
-     */
-    draft_invoices_count?: number;
-    /**
-     * Number of plans using this billable metric.
-     * @example 4
-     */
-    plans_count?: number;
-};
 export interface BillableMetricBaseInput {
     /**
      * Name of the billable metric.
@@ -1050,7 +1015,7 @@ export interface CouponObject {
      * @format date-time
      * @example "2022-08-08T23:59:59Z"
      */
-    terminated_at?: string;
+    terminated_at?: string | null;
 }
 export interface CouponsPaginated {
     coupons: CouponObject[];
@@ -1407,6 +1372,11 @@ export interface CreditNoteObject {
     /** Array of credit note's items. */
     items?: CreditNoteItemObject[];
     applied_taxes?: CreditNoteAppliedTaxObject[];
+    /**
+     * Indicates if the credit note belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.
+     * @example false
+     */
+    self_billed?: boolean;
 }
 export interface CreditNotes {
     credit_notes: CreditNoteObject[];
@@ -1472,6 +1442,44 @@ export interface CreditNoteUpdateInput {
         refund_status: "pending" | "succeeded" | "failed";
     };
 }
+export type CreditNoteExtendedObject = CreditNoteObject & {
+    customer?: any;
+};
+export interface CreditNotePaymentProviderRefundError {
+    /**
+     * Unique identifier assigned to the credit note within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit note record within the Lago system.
+     * @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>;
+}
 /** @example "USD" */
 export type Currency = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
 export interface Customer {
@@ -1589,6 +1597,25 @@ export interface IntegrationCustomer {
      */
     subsidiary_id?: string;
 }
+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;
+    /**
+     * The type of integration provider
+     * @example "netsuite"
+     */
+    provider: string;
+    /**
+     * Unique code used to identify an integration connection.
+     * @example "netsuite-eu-1"
+     */
+    provider_code: string;
+    provider_error: string | Record<string, any>;
+}
 /** Array of filter object, representing multiple dimensions for a charge item. */
 export type CustomerChargeFiltersUsageObject = {
     /**
@@ -1776,6 +1803,13 @@ export interface CustomerCreateInput {
          * @example "Belson"
          */
         lastname?: string | null;
+        /**
+         * The type of the account. It can have one of the following values:
+         * - `customer`: the account is a customer, default value.
+         * - `partner`: the account is a partner.
+         * @example "customer"
+         */
+        account_type?: "customer" | "partner" | null;
         /**
          * The type of the customer. It can have one of the following values:
          * - `company`: the customer is a company.
@@ -1889,8 +1923,42 @@ export interface CustomerCreateInput {
              */
             display_in_invoice: boolean;
         }[];
+        /**
+         * Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default
+         * @example false
+         */
+        skip_invoice_custom_sections?: boolean;
+        /**
+         * List of unique codes identifying the invoice custom sections.
+         * @example ["eu_bank_details"]
+         */
+        invoice_custom_section_codes?: string[];
     };
 }
+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.
+     * @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;
+    /**
+     * The type of accounting provider code
+     * @example "anrock"
+     */
+    accounting_provider: "anrock" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
+    /**
+     * Code of the accounting provider
+     * @example "Netsuite Prod"
+     */
+    accounting_provider_code: string;
+    provider_error: string | Record<string, any>;
+}
 /** Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
 export interface CustomerMetadata {
     /**
@@ -2006,6 +2074,13 @@ export type CustomerObject = {
      * @example "Belson"
      */
     lastname?: string | null;
+    /**
+     * The type of the account. It can have one of the following values:
+     * - `customer`: the account is a customer.
+     * - `partner`: the account is a partner.
+     * @example "customer"
+     */
+    account_type?: "customer" | "partner";
     /**
      * The type of the customer. It can have one of the following values:
      * - `company`: the customer is a company.
@@ -2064,6 +2139,11 @@ export type CustomerObject = {
      * @example "inherit"
      */
     finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
+    /**
+     * Set to true to exclude all invoice custom sections from PDF generation for this customer only.
+     * @example false
+     */
+    skip_invoice_custom_sections?: boolean;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
@@ -2076,15 +2156,114 @@ export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
     taxes?: TaxObject[];
+    /** The customer’s invoice custom section used for generating invoices. */
+    applicable_invoice_custom_sections?: {
+        /**
+         * 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 interface CustomerPastUsage {
     usage_periods: CustomerUsage[];
     meta: PaginationMeta;
 }
+export interface CustomerPaymentProvidernErrorObject {
+    /**
+     * 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;
+    /**
+     * The type of payment provider
+     * @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 CustomersPaginated {
     customers: CustomerObjectExtended[];
     meta: PaginationMeta;
 }
+export interface CustomerTaxProviderErrorObject {
+    /**
+     * 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;
+    /**
+     * The type of tax provider
+     * @example "anrock"
+     */
+    tax_provider: "anrock" | "hubspot" | "netsuite" | "okta" | "salesforce" | "xero";
+    /**
+     * Code of the tax provider
+     * @example "Stripe Prod"
+     */
+    tax_provider_code: string;
+    provider_error: string | Record<string, any>;
+}
 export interface CustomerUsage {
     customer_usage: CustomerUsageObject;
 }
@@ -2136,6 +2315,15 @@ export interface CustomerUsageObject {
     /** Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage. */
     charges_usage: CustomerChargeUsageObject[];
 }
+export type CustomerViesCheckObject = {
+    vies_check?: {
+        /**
+         * Whether the VIES check was successful
+         * @example true
+         */
+        valid?: boolean;
+    };
+};
 export interface Event {
     event: EventObject;
 }
@@ -2255,6 +2443,37 @@ export interface EventObject {
      */
     created_at: string;
 }
+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 Fee {
     fee: FeeObject;
 }
@@ -2618,6 +2837,11 @@ export interface FeeObject {
             per_unit_total_amount: string;
         }[];
     };
+    /**
+     * Indicates if the fee belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.
+     * @example false
+     */
+    self_billed?: boolean;
     /** Item attached to the fee */
     item: {
         /**
@@ -2670,6 +2894,25 @@ export interface Fees {
 export type FeesPaginated = Fees & {
     meta: PaginationMeta;
 };
+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 FeeUpdateInput {
     fee: {
         /**
@@ -3008,14 +3251,15 @@ export type InvoiceObject = {
      */
     invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
-     * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
+     * The status of the invoice. It indicates the current state of the invoice and can have following values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `pending`: the invoice remains pending until the taxes are fetched from the external provider.
      * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided" | "failed";
+    status: "draft" | "finalized" | "voided" | "failed" | "pending";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -3084,15 +3328,80 @@ export type InvoiceObject = {
     total_amount_cents: number;
     /** @example 3 */
     version_number: number;
+    /**
+     * Indicates if the invoice is self-billed. Self-billing is a process where an organization creates the invoice on behalf of the partner. This field specifies whether the invoice is self-billed or not.
+     * @example false
+     */
+    self_billed?: boolean;
     /**
      * Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice
      * @format uri
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+    /**
+     * The date of the invoice creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the invoice object was created
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date of the invoice update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the invoice object was updated
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at: string;
 } & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
+    billing_period?: {
+        /**
+         * Unique identifier assigned to the subscription, created by Lago.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_subscription_id: string;
+        /**
+         * Unique identifier assigned to the subscription in your application.
+         * @example "external_id"
+         */
+        external_subscription_id: string;
+        /**
+         * Unique identifier assigned to the plan, created by Lago.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_plan_id?: string;
+        /**
+         * The beginning date of the subscription billing period. This field indicates the start date of the billing period associated with the subscription fee.
+         * @format date-time
+         * @example "2022-04-29T08:59:51Z"
+         */
+        subscription_from_datetime: string;
+        /**
+         * The ending date of the subscription billing period. This field indicates the end date of the billing period associated with the subscription fee.
+         * @format date-time
+         * @example "2022-05-29T08:59:51Z"
+         */
+        subscription_to_datetime: string;
+        /**
+         * The beginning date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the start date of the billing period or subscription period associated with the fees.
+         * @format date-time
+         * @example "2022-04-29T08:59:51Z"
+         */
+        charges_from_datetime: string;
+        /**
+         * The ending date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the end date of the billing period or subscription period associated with the fees.
+         * @format date-time
+         * @example "2022-05-29T08:59:51Z"
+         */
+        charges_to_datetime: string;
+        /**
+         * The reason explaining why this subscription appears on the invoice.
+         * @example "subscription_starting"
+         */
+        invoicing_reason: "subscription_starting" | "subscription_periodic" | "subscription_terminating" | "in_advance_charge" | "in_advance_charge_periodic" | "progressive_billing";
+    }[];
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
     applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
@@ -3167,6 +3476,41 @@ export interface InvoiceOneOffCreateInput {
         }[];
     };
 }
+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;
+    /**
+     * 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 InvoicesPaginated {
     invoices: InvoiceObject[];
     meta: PaginationMeta;
@@ -3492,6 +3836,80 @@ export interface PaginationMeta {
      */
     total_count: number;
 }
+export interface PaymentObject {
+    /**
+     * The unique identifier of the paid resource, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_payable_id: string;
+    /**
+     * Unique identifier of the customer, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_customer_id: string;
+    /**
+     * The status of the payment within the payment provider
+     * @example "processing"
+     */
+    status: string;
+    /**
+     * The customer external unique identifier (provided by your own application)
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    external_id: string;
+    /**
+     * Unique identifier of the customer within the payment provider
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    provider_customer_id: string;
+    /**
+     * Code of the payment provider
+     * @example "Stripe Prod"
+     */
+    payment_provider_code?: string;
+    /**
+     * The type of payment provider
+     * @example "stripe"
+     */
+    payment_provider_type: "adyen" | "cashfree" | "gocardless" | "stripe";
+    /**
+     * Unique identifier of the payment within the payment provider
+     * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+     */
+    provider_payment_id: string;
+    next_action: Record<string, any>;
+}
+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;
+    /**
+     * Code of the payment provider
+     * @example "stripe"
+     */
+    payment_provider_code: string;
+    /**
+     * The source of the error
+     * @example "stripe"
+     */
+    source: "stripe";
+    /**
+     * The action that was being performed when the error occurred
+     * @example "payment_provider.register_webhook"
+     */
+    action?: "payment_provider.register_webhook";
+    provider_error: string | Record<string, any>;
+}
 export interface PaymentRequestObject {
     /**
      * Unique identifier of the payment request, created by Lago.
@@ -3533,6 +3951,46 @@ export interface PaymentRequestObject {
     customer: any;
     invoices: any[];
 }
+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;
+    /**
+     * 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"]
+     */
+    lago_invoice_ids: 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 PaymentRequestsPaginated {
     payment_requests: PaymentRequestObject[];
     meta: PaginationMeta;
@@ -3943,16 +4401,6 @@ export interface PlanObject {
      * @example null
      */
     bill_charges_monthly?: boolean | null;
-    /**
-     * The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted.
-     * @example 0
-     */
-    active_subscriptions_count: number;
-    /**
-     * The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted.
-     * @example 0
-     */
-    draft_invoices_count: number;
     minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
@@ -4042,6 +4490,15 @@ export interface SubscriptionUpdateInput {
         plan_overrides?: PlanOverridesObject;
     };
 }
+export type SubscriptionWithCustomerObject = SubscriptionObject & {
+    plan?: PlanObject;
+    customer?: CustomerObject;
+};
+export type SubscriptionWithThresholdObject = SubscriptionObject & {
+    plan?: PlanObject;
+    customer?: CustomerObject;
+    usage_threshold?: UsageThresholdObject;
+};
 export interface SubscriptionObject {
     /**
      * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
@@ -4112,7 +4569,7 @@ export interface SubscriptionObject {
      * @format date-time
      * @example "2022-10-08T00:00:00Z"
      */
-    ending_at?: string;
+    ending_at?: string | null;
     /**
      * The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
      * @format date-time
@@ -4237,26 +4694,6 @@ export interface TaxObject {
      * @example true
      */
     applied_to_organization: boolean;
-    /**
-     * Number of add-ons this tax is applied to.
-     * @example 0
-     */
-    add_ons_count?: number;
-    /**
-     * Number of charges this tax is applied to.
-     * @example 0
-     */
-    charges_count?: number;
-    /**
-     * Number of customers this tax is applied to (directly or via the organization's default).
-     * @example 0
-     */
-    customers_count: number;
-    /**
-     * Number of plans this tax is applied to.
-     * @example 0
-     */
-    plans_count?: number;
     /**
      * Creation date of the tax.
      * @format date-time
@@ -4623,7 +5060,7 @@ export interface WalletObject {
      */
     ongoing_balance_cents: number;
     /**
-     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage and draft invoices including taxes.
      * @example 200
      */
     ongoing_usage_balance_cents: number;
@@ -4634,7 +5071,7 @@ export interface WalletObject {
      */
     credits_ongoing_balance: string;
     /**
-     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage including taxes.
+     * The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage and draft invoices including taxes.
      * @pattern ^[0-9]+.?[0-9]*$
      * @example "2.0"
      */
@@ -4760,6 +5197,41 @@ export interface WalletTransactionObject {
      */
     created_at: string;
 }
+export interface WalletTransactionPaymentFailureObject {
+    /**
+     * 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"
+     */
+    lago_wallet_transaction_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 WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
 }
@@ -4980,7 +5452,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.17.0
+ * @version 1.20.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5376,6 +5848,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Filter credit notes starting from a specific date.
+             * @format date
+             * @example "2022-07-08"
+             */
+            issuing_date_from?: string;
+            /**
+             * Filter credit notes up to a specific date.
+             * @format date
+             * @example "2022-08-09"
+             */
+            issuing_date_to?: string;
+            /**
+             * Search credit notes by id, number, customer name, customer external_id or customer email.
+             * @example "Jane"
+             */
+            search_term?: string;
+            /**
+             * Filter credit notes by currency. Possible values ISO 4217 currency codes.
+             * @example "EUR"
+             */
+            currency?: string;
+            /** Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`. */
+            reason?: "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "duplicated_charge" | "other";
+            /** Filter credit notes by credit status. Possible values are `available`, `consumed`  or `voided`. */
+            credit_status?: "available" | "consumed" | "voided";
+            /** Filter credit notes by refund status. Possible values are `pending`, `succeeded`  or `failed`. */
+            refund_status?: "pending" | "succeeded" | "failed";
+            /**
+             * Filter credit notes by their related invoice number.
+             * @example "INV-001-002"
+             */
+            invoice_number?: string;
+            /**
+             * Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 9000
+             */
+            amount_from?: number;
+            /**
+             * Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 100000
+             */
+            amount_to?: number;
+            /**
+             * Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.
+             * @example true
+             */
+            self_billed?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint updates an existing credit note.
@@ -5459,6 +5979,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter customers by account type.
+             * @example ["customer","partner"]
+             */
+            account_type?: ("customer" | "partner")[];
         }, params?: RequestParams) => Promise<HttpResponse<CustomersPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves an existing customer.
@@ -5575,17 +6100,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                  * 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
                  * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
                  */
-                lago_customer_id?: string | undefined;
+                lago_customer_id: string;
                 /**
                  * The customer external unique identifier (provided by your own application)
                  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
                  */
-                external_customer_id?: string | undefined;
+                external_customer_id: string;
                 /**
                  * The Payment Provider name linked to the Customer.
                  * @example "stripe"
                  */
-                payment_provider?: string | undefined;
+                payment_provider: string;
+                /**
+                 * Code of the payment provider
+                 * @example "Stripe Prod"
+                 */
+                payment_provider_code?: string | undefined;
                 /**
                  * The new generated Payment Provider Checkout URL for the Customer.
                  * @example "https://foo.bar"
@@ -5713,6 +6243,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_subscription_id?: string;
+            /**
+             * Filter results by event transaction ID
+             * @example "et_12345678"
+             */
+            event_transaction_id?: string;
             /** Filter results by fee's currency. */
             currency?: Currency;
             /**
@@ -5846,6 +6381,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 9000
+             */
+            amount_from?: number;
+            /**
+             * Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
+             * @example 100000
+             */
+            amount_to?: number;
             /**
              * Filter invoices starting from a specific date.
              * @format date
@@ -5873,7 +6418,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             search_term?: string;
             /**
-             * Filter invoices by currency in. Possible values ISO 4217 currency codes.
+             * Filter invoices by currency. Possible values ISO 4217 currency codes.
              * @example "EUR"
              */
             currency?: string;
@@ -5884,6 +6429,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             payment_dispute_lost?: boolean;
             /** Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off` or `advance_charges` */
             invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges";
+            /**
+             * Filter invoices by self billed. Possible values are `true` or `false`.
+             * @example true
+             */
+            self_billed?: boolean;
+            /**
+             * 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"
+             */
+            "metadata[key]"?: string;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used for updating an existing invoice.
@@ -6042,7 +6597,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
                  * The customer external unique identifier (provided by your own application)
                  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
                  */
-                customer_external_id?: string;
+                external_customer_id: string;
                 /**
                  * The customer's email address used for sending dunning notifications
                  * @format email