lago-javascript-client 0.39.0-beta → 0.41.0-beta

package/types/openapi/client.d.ts

@@ -360,29 +360,31 @@ export interface BaseAppliedTax {
      */
     lago_tax_id?: string;
     /**
-     * The name of the tax.
-     * @example "example name"
+     * Name of the tax.
+     * @example "TVA"
      */
     tax_name?: string;
     /**
-     * The code of the tax.
-     * @example "example_code"
+     * Unique code used to identify the tax associated with the API request.
+     * @example "french_standard_vat"
      */
     tax_code?: string;
     /**
-     * The rate of the tax.
-     * @format ^[0-9]+.?[0-9]*$
-     * @example "25.0"
+     * The percentage rate of the tax
+     * @example 20
      */
-    tax_rate?: string;
+    tax_rate?: number;
     /**
-     * The description of the tax.
-     * @example "description"
+     * Internal description of the taxe
+     * @example "French standard VAT"
      */
     tax_description?: string;
-    /** @example 20 */
+    /**
+     * Amount of the tax
+     * @example 2000
+     */
     amount_cents?: number;
-    /** The currency of the tax. */
+    /** Currency of the tax */
     amount_currency?: Currency;
     /**
      * The date and time when the applied tax 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 applied tax was initially created.
@@ -416,6 +418,15 @@ export interface BillableMetricObject {
      * @example "GB of storage used in my application"
      */
     description?: string | null;
+    /**
+     * Defines if the billable metric is persisted billing period over billing period.
+     *
+     * - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.
+     * - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.
+     * - If not defined in the request, default value is `false`.
+     * @example false
+     */
+    recurring: boolean;
     /**
      * Creation date of the billable metric.
      * @format date-time
@@ -466,6 +477,15 @@ export interface BillableMetricBaseInput {
      * @example "GB of storage used in my application"
      */
     description?: string | null;
+    /**
+     * Defines if the billable metric is persisted billing period over billing period.
+     *
+     * - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.
+     * - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.
+     * - If not defined in the request, default value is `false`.
+     * @example false
+     */
+    recurring?: boolean;
     /**
      * Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
      * @example "gb"
@@ -549,6 +569,15 @@ export interface ChargeObject {
      * @example true
      */
     invoiceable?: boolean;
+    /**
+     * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
+     *
+     * - If set to `true`, the charge is prorated based on the remaining days in the current billing period.
+     * - If set to `false`, the charge is billed in full.
+     * - If not defined in the request, default value is `false`.
+     * @example false
+     */
+    prorated?: boolean;
     /**
      * The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.
      * @example 1200
@@ -655,6 +684,258 @@ export interface ChargeProperties {
         per_unit_amount: string;
     }[];
 }
+/** @example "US" */
+export declare enum Country {
+    AD = "AD",
+    AE = "AE",
+    AF = "AF",
+    AG = "AG",
+    AI = "AI",
+    AL = "AL",
+    AM = "AM",
+    AO = "AO",
+    AQ = "AQ",
+    AR = "AR",
+    AS = "AS",
+    AT = "AT",
+    AU = "AU",
+    AW = "AW",
+    AX = "AX",
+    AZ = "AZ",
+    BA = "BA",
+    BB = "BB",
+    BD = "BD",
+    BE = "BE",
+    BF = "BF",
+    BG = "BG",
+    BH = "BH",
+    BI = "BI",
+    BJ = "BJ",
+    BL = "BL",
+    BM = "BM",
+    BN = "BN",
+    BO = "BO",
+    BQ = "BQ",
+    BR = "BR",
+    BS = "BS",
+    BT = "BT",
+    BV = "BV",
+    BW = "BW",
+    BY = "BY",
+    BZ = "BZ",
+    CA = "CA",
+    CC = "CC",
+    CD = "CD",
+    CF = "CF",
+    CG = "CG",
+    CH = "CH",
+    CI = "CI",
+    CK = "CK",
+    CL = "CL",
+    CM = "CM",
+    CN = "CN",
+    CO = "CO",
+    CR = "CR",
+    CU = "CU",
+    CV = "CV",
+    CW = "CW",
+    CX = "CX",
+    CY = "CY",
+    CZ = "CZ",
+    DE = "DE",
+    DJ = "DJ",
+    DK = "DK",
+    DM = "DM",
+    DO = "DO",
+    DZ = "DZ",
+    EC = "EC",
+    EE = "EE",
+    EG = "EG",
+    EH = "EH",
+    ER = "ER",
+    ES = "ES",
+    ET = "ET",
+    FI = "FI",
+    FJ = "FJ",
+    FK = "FK",
+    FM = "FM",
+    FO = "FO",
+    FR = "FR",
+    GA = "GA",
+    GB = "GB",
+    GD = "GD",
+    GE = "GE",
+    GF = "GF",
+    GG = "GG",
+    GH = "GH",
+    GI = "GI",
+    GL = "GL",
+    GM = "GM",
+    GN = "GN",
+    GP = "GP",
+    GQ = "GQ",
+    GR = "GR",
+    GS = "GS",
+    GT = "GT",
+    GU = "GU",
+    GW = "GW",
+    GY = "GY",
+    HK = "HK",
+    HM = "HM",
+    HN = "HN",
+    HR = "HR",
+    HT = "HT",
+    HU = "HU",
+    ID = "ID",
+    IE = "IE",
+    IL = "IL",
+    IM = "IM",
+    IN = "IN",
+    IO = "IO",
+    IQ = "IQ",
+    IR = "IR",
+    IS = "IS",
+    IT = "IT",
+    JE = "JE",
+    JM = "JM",
+    JO = "JO",
+    JP = "JP",
+    KE = "KE",
+    KG = "KG",
+    KH = "KH",
+    KI = "KI",
+    KM = "KM",
+    KN = "KN",
+    KP = "KP",
+    KR = "KR",
+    KW = "KW",
+    KY = "KY",
+    KZ = "KZ",
+    LA = "LA",
+    LB = "LB",
+    LC = "LC",
+    LI = "LI",
+    LK = "LK",
+    LR = "LR",
+    LS = "LS",
+    LT = "LT",
+    LU = "LU",
+    LV = "LV",
+    LY = "LY",
+    MA = "MA",
+    MC = "MC",
+    MD = "MD",
+    ME = "ME",
+    MF = "MF",
+    MG = "MG",
+    MH = "MH",
+    MK = "MK",
+    ML = "ML",
+    MM = "MM",
+    MN = "MN",
+    MO = "MO",
+    MP = "MP",
+    MQ = "MQ",
+    MR = "MR",
+    MS = "MS",
+    MT = "MT",
+    MU = "MU",
+    MV = "MV",
+    MW = "MW",
+    MX = "MX",
+    MY = "MY",
+    MZ = "MZ",
+    NA = "NA",
+    NC = "NC",
+    NE = "NE",
+    NF = "NF",
+    NG = "NG",
+    NI = "NI",
+    NL = "NL",
+    NO = "NO",
+    NP = "NP",
+    NR = "NR",
+    NU = "NU",
+    NZ = "NZ",
+    OM = "OM",
+    PA = "PA",
+    PE = "PE",
+    PF = "PF",
+    PG = "PG",
+    PH = "PH",
+    PK = "PK",
+    PL = "PL",
+    PM = "PM",
+    PN = "PN",
+    PR = "PR",
+    PS = "PS",
+    PT = "PT",
+    PW = "PW",
+    PY = "PY",
+    QA = "QA",
+    RE = "RE",
+    RO = "RO",
+    RS = "RS",
+    RU = "RU",
+    RW = "RW",
+    SA = "SA",
+    SB = "SB",
+    SC = "SC",
+    SD = "SD",
+    SE = "SE",
+    SG = "SG",
+    SH = "SH",
+    SI = "SI",
+    SJ = "SJ",
+    SK = "SK",
+    SL = "SL",
+    SM = "SM",
+    SN = "SN",
+    SO = "SO",
+    SR = "SR",
+    SS = "SS",
+    ST = "ST",
+    SV = "SV",
+    SX = "SX",
+    SY = "SY",
+    SZ = "SZ",
+    TC = "TC",
+    TD = "TD",
+    TF = "TF",
+    TG = "TG",
+    TH = "TH",
+    TJ = "TJ",
+    TK = "TK",
+    TL = "TL",
+    TM = "TM",
+    TN = "TN",
+    TO = "TO",
+    TR = "TR",
+    TT = "TT",
+    TV = "TV",
+    TW = "TW",
+    TZ = "TZ",
+    UA = "UA",
+    UG = "UG",
+    UM = "UM",
+    US = "US",
+    UY = "UY",
+    UZ = "UZ",
+    VA = "VA",
+    VC = "VC",
+    VE = "VE",
+    VG = "VG",
+    VI = "VI",
+    VN = "VN",
+    VU = "VU",
+    WF = "WF",
+    WS = "WS",
+    YE = "YE",
+    YT = "YT",
+    ZA = "ZA",
+    ZM = "ZM",
+    ZW = "ZW"
+}
 export interface Coupon {
     coupon: CouponObject;
 }
@@ -1015,10 +1296,9 @@ export interface CreditNoteObject {
     taxes_amount_cents: number;
     /**
      * The tax rate associated with this specific credit note.
-     * @format ^[0-9]+.?[0-9]*$
-     * @example "20.0"
+     * @example 20
      */
-    taxes_rate: string;
+    taxes_rate: number;
     /**
      * The subtotal of the credit note excluding any applicable taxes, expressed in cents.
      * @example 100
@@ -1353,6 +1633,11 @@ export interface CustomerBillingConfiguration {
      * @example "fr"
      */
     document_locale?: string;
+    /**
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, all the payment methods are selected. For now, possible values are `card` and `sepa_debit`.
+     * @example ["card","sepa_debit"]
+     */
+    provider_payment_methods?: string[] | null;
 }
 export interface CustomerChargeUsageObject {
     /**
@@ -1421,7 +1706,7 @@ export interface CustomerChargeUsageObject {
         key?: string | null;
         /**
          * The group value.
-         * @example "eruope"
+         * @example "europe"
          */
         value?: string;
         /**
@@ -1459,11 +1744,8 @@ export interface CustomerCreateInput {
          * @example "Woodland Hills"
          */
         city?: string | null;
-        /**
-         * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
-         * @example "US"
-         */
-        country?: string | null;
+        /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
+        country?: Country;
         /** Currency of the customer. Format must be ISO 4217 */
         currency?: Currency;
         /**
@@ -1616,11 +1898,8 @@ export interface CustomerObject {
      * @example "Woodland Hills"
      */
     city?: string | null;
-    /**
-     * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
-     * @example "US"
-     */
-    country?: string | null;
+    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
+    country?: Country;
     /** Currency of the customer. Format must be ISO 4217 */
     currency?: Currency;
     /**
@@ -1649,6 +1928,11 @@ export interface CustomerObject {
      * @example "Gavin Belson"
      */
     name?: string | null;
+    /**
+     * The phone number of the customer
+     * @example "1-171-883-3711 x245"
+     */
+    phone?: string | null;
     /**
      * The state of the customer's billing address
      * @example "CA"
@@ -1680,11 +1964,11 @@ export interface CustomerObject {
     /** 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;
     metadata?: CustomerMetadata[];
-    /** List of customer taxes */
-    taxes?: TaxObject[];
 }
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
+    /** List of customer taxes */
+    taxes?: TaxObject[];
 };
 export interface CustomersPaginated {
     customers: CustomerObjectExtended[];
@@ -1971,10 +2255,9 @@ export interface FeeObject {
     taxes_amount_cents: number;
     /**
      * The tax rate associated with this specific fee.
-     * @format ^[0-9]+.?[0-9]*$
-     * @example "20.0"
+     * @example 20
      */
-    taxes_rate: string;
+    taxes_rate: number;
     /**
      * The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer.
      * @example "0.32"
@@ -2387,11 +2670,8 @@ export interface OrganizationObject {
      * @example ["https://webhook.brex.com","https://webhook2.brex.com"]
      */
     webhook_urls?: string[] | null;
-    /**
-     * The country of your organization.
-     * @example "US"
-     */
-    country?: string | null;
+    /** The country of your organization. */
+    country?: Country;
     /**
      * The first line of your organization’s billing address.
      * @example "100 Brex Street"
@@ -2452,11 +2732,8 @@ export interface OrganizationUpdateInput {
          * @example "https://webhook.brex.com"
          */
         webhook_url?: string | null;
-        /**
-         * The country of your organization.
-         * @example "US"
-         */
-        country?: string | null;
+        /** The country of your organization. */
+        country?: Country;
         /**
          * The first line of your organization’s billing address.
          * @example "100 Brex Street"
@@ -2544,7 +2821,106 @@ export interface PaginationMeta {
 export interface Plan {
     plan: PlanObject;
 }
-export interface PlanInput {
+export interface PlanCreateInput {
+    plan: {
+        /**
+         * The name of the plan.
+         * @example "Startup"
+         */
+        name?: string;
+        /**
+         * The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+         * @example "startup"
+         */
+        code?: string;
+        /**
+         * The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `monthly`, or `weekly`.
+         * @example "monthly"
+         */
+        interval?: "weekly" | "monthly" | "yearly";
+        /**
+         * The description on the plan.
+         * @example "Plan for early stage startups."
+         */
+        description?: string;
+        /**
+         * The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.
+         * @example 10000
+         */
+        amount_cents?: number;
+        /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+        amount_currency?: Currency;
+        /**
+         * The duration in days during which the base cost of the plan is offered for free.
+         * @example 5
+         */
+        trial_period?: number;
+        /**
+         * This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.
+         * @example true
+         */
+        pay_in_advance?: boolean;
+        /**
+         * This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`.
+         * @example null
+         */
+        bill_charges_monthly?: boolean | null;
+        /**
+         * Additional usage-based charges for this plan.
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         */
+        charges?: {
+            /**
+             * Unique identifier of the billable metric created by Lago.
+             * @format uuid
+             * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+             */
+            billable_metric_id?: string;
+            /**
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `package`, `percentage` or `volume`.
+             * @example "standard"
+             */
+            charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
+            /**
+             * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
+             * @example false
+             */
+            pay_in_advance?: boolean;
+            /**
+             * This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.
+             * @example true
+             */
+            invoiceable?: boolean;
+            /**
+             * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
+             *
+             * - If set to `true`, the charge is prorated based on the remaining days in the current billing period.
+             * - If set to `false`, the charge is billed in full.
+             * - If not defined in the request, default value is `false`.
+             * @example false
+             */
+            prorated?: boolean;
+            /**
+             * The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.
+             * @example 0
+             */
+            min_amount_cents?: number;
+            /** List of all thresholds utilized for calculating the charge. */
+            properties?: ChargeProperties;
+            /** All charge information, sorted by groups. */
+            group_properties?: {
+                /**
+                 * Unique identifier of a billable metric group, created by Lago.
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                group_id: string;
+                /** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
+                values: ChargeProperties;
+            }[];
+        }[];
+    };
+}
+export interface PlanUpdateInput {
     plan: {
         /**
          * The name of the plan.
@@ -2590,7 +2966,7 @@ export interface PlanInput {
         bill_charges_monthly?: boolean | null;
         /**
          * Additional usage-based charges for this plan.
-         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+         * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
          */
         charges?: {
             /**
@@ -2620,6 +2996,15 @@ export interface PlanInput {
              * @example true
              */
             invoiceable?: boolean;
+            /**
+             * Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.
+             *
+             * - If set to `true`, the charge is prorated based on the remaining days in the current billing period.
+             * - If set to `false`, the charge is billed in full.
+             * - If not defined in the request, default value is `false`.
+             * @example false
+             */
+            prorated?: boolean;
             /**
              * The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.
              * @example 0
@@ -2707,7 +3092,7 @@ export interface PlanObject {
     draft_invoices_count: number;
     /**
      * Additional usage-based charges for this plan.
-     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
+     * @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
      */
     charges?: ChargeObject[];
 }
@@ -2869,84 +3254,88 @@ export interface SubscriptionsPaginated {
 export interface Tax {
     tax: TaxObject;
 }
+export interface TaxBaseInput {
+    /**
+     * Name of the tax.
+     * @example "TVA"
+     */
+    name?: string;
+    /**
+     * Unique code used to identify the tax associated with the API request.
+     * @example "french_standard_vat"
+     */
+    code?: string;
+    /**
+     * The percentage rate of the tax
+     * @format ^[0-9]+.?[0-9]*$
+     * @example "20.0"
+     */
+    rate?: string;
+    /**
+     * Internal description of the taxe
+     * @example "French standard VAT"
+     */
+    description?: string | null;
+    /**
+     * Set to `true` if the tax is used as one of the organization's default
+     * @example true
+     */
+    applied_to_organization?: boolean;
+}
+export interface TaxCreateInput {
+    tax: TaxBaseInput;
+}
 export interface TaxesPaginated {
     taxes: TaxObject[];
     meta: PaginationMeta;
 }
-export interface TaxInput {
-    tax: {
-        /**
-         * The name of the tax.
-         * @example "French VAT"
-         */
-        name?: string;
-        /**
-         * Unique code used to identify the tax.
-         * @example "vat_fr"
-         */
-        code?: string;
-        /**
-         * The rate of the tax
-         * @format ^[0-9]+.?[0-9]*$
-         * @example "15.0"
-         */
-        rate?: string;
-        /**
-         * Description of the tax.
-         * @example "description"
-         */
-        description?: string;
-        /**
-         * Set to `true` if the tax is used as one of the organization's default.
-         * @example false
-         */
-        applied_to_organization?: boolean;
-    };
-}
 export interface TaxObject {
     /**
+     * Unique identifier of the tax, created by Lago.
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_id: string;
     /**
-     * The name of the tax.
-     * @example "French VAT"
+     * Name of the tax.
+     * @example "TVA"
      */
     name: string;
     /**
-     * Unique code used to identify the tax.
-     * @example "vat_fr"
+     * Unique code used to identify the tax associated with the API request.
+     * @example "french_standard_vat"
      */
     code: string;
     /**
-     * Description of the tax.
-     * @example "description"
+     * Internal description of the taxe
+     * @example "French standard VAT"
      */
     description?: string;
     /**
-     * The rate of the tax
-     * @format ^[0-9]+.?[0-9]*$
-     * @example "25.0"
+     * The percentage rate of the tax
+     * @example 20
      */
-    rate?: string;
+    rate: number;
     /**
-     * Set to `true` if the tax is used as one of the organization's default.
+     * Set to `true` if the tax is used as one of the organization's default
      * @example true
      */
     applied_to_organization: boolean;
     /**
-     * Number of customers this tax is applied to (directly or via the organization's default).
-     * @example 12
+     * Number of customers this tax is applied to (directly or via the organization's default)
+     * @example 0
      */
     customers_count: number;
     /**
-     * The date and time when the tax 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 tax was initially created.
+     * Creation date of the tax.
      * @format date-time
-     * @example "2022-09-14T16:35:31Z"
+     * @example "2023-07-06T14:35:58Z"
      */
     created_at: string;
 }
+export interface TaxUpdateInput {
+    tax: TaxBaseInput;
+}
 /** @example "America/Los_Angeles" */
 export declare enum Timezone {
     UTC = "UTC",
@@ -3367,7 +3756,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.39.0-beta
+ * @version 0.41.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4133,7 +4522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/plans
          * @secure
          */
-        createPlan: (data: PlanInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        createPlan: (data: PlanCreateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves all existing plans.
          *
@@ -4164,7 +4553,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/plans/{code}
          * @secure
          */
-        updatePlan: (code: string, data: PlanInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        updatePlan: (code: string, data: PlanUpdateInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific plan.
          *
@@ -4227,6 +4616,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "premium"
              */
             plan_code?: string;
+            /**
+             * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
+             * @example ["active","pending"]
+             */
+            status?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to update a subscription.
@@ -4247,11 +4641,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/subscriptions/{external_id}
          * @secure
          */
-        destroySubscription: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
+        destroySubscription: (externalId: string, query?: {
+            /**
+             * If the field is not defined, Lago will terminate only `active` subscriptions. However, if you wish to cancel a `pending` subscription, please ensure that you include `status=pending` in your request.
+             * @example "pending"
+             */
+            status?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
     };
     taxes: {
         /**
-         * @description Create a tax
+         * @description This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer.
          *
          * @tags taxes
          * @name CreateTax
@@ -4259,50 +4659,50 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/taxes
          * @secure
          */
-        createTax: (data: TaxInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        createTax: (data: TaxCreateInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description Find all taxes in certain organization
+         * @description This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer.
          *
          * @tags taxes
          * @name FindAllTaxes
-         * @summary Find taxes
+         * @summary List all taxes
          * @request GET:/taxes
          * @secure
          */
         findAllTaxes: (query?: {
             /**
-             * Number of page
-             * @example 2
+             * Page number.
+             * @example 1
              */
             page?: number;
             /**
-             * Number of records per page
+             * Number of records per page.
              * @example 20
              */
             per_page?: number;
         }, params?: RequestParams) => Promise<HttpResponse<TaxesPaginated, ApiErrorUnauthorized>>;
         /**
-         * @description Update an existing tax by code
+         * @description This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer.
          *
          * @tags taxes
          * @name UpdateTax
-         * @summary Update an existing tax
+         * @summary Update a tax
          * @request PUT:/taxes/{code}
          * @secure
          */
-        updateTax: (code: string, data: TaxInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        updateTax: (code: string, data: TaxUpdateInput, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
-         * @description Return a single tax
+         * @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.
          *
          * @tags taxes
          * @name FindTax
-         * @summary Find tax by code
+         * @summary Retrieve a Tax
          * @request GET:/taxes/{code}
          * @secure
          */
         findTax: (code: string, params?: RequestParams) => Promise<HttpResponse<Tax, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
-         * @description Delete a tax
+         * @description This endpoint is used to delete a tax.
          *
          * @tags taxes
          * @name DestroyTax
@@ -4435,5 +4835,113 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         fetchPublicKey: (params?: RequestParams) => Promise<HttpResponse<string, ApiErrorUnauthorized>>;
     };
+    webhookEndpoints: {
+        /**
+         * @description This endpoint is used to create a webhook endpoint.
+         *
+         * @tags webhook_endpoints
+         * @name CreateWebhookEndpoint
+         * @summary Create a webhook_endpoint
+         * @request POST:/webhook_endpoints
+         * @secure
+         */
+        createWebhookEndpoint: (data: {
+            webhook_endpoint?: {
+                /**
+                 * The URL of the webhook endpoint.
+                 * @example "https://foo.bar"
+                 */
+                webhook_url: string;
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            webhook_endpoint: {
+                /**
+                 * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_id: string;
+                /**
+                 * Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_organization_id: string;
+                /**
+                 * The name of the wallet.
+                 * @example "Prepaid"
+                 */
+                webhook_url: string;
+                /**
+                 * The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+                 * @format date-time
+                 * @example "2022-04-29T08:59:51Z"
+                 */
+                created_at: string;
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all webhook endpoints.
+         *
+         * @tags webhook_endpoints
+         * @name FindAllWebhookEndpoints
+         * @summary List all webhook endpoints
+         * @request GET:/webhook_endpoints
+         * @secure
+         */
+        findAllWebhookEndpoints: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            webhook_endpoints: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+        /**
+         * @description This endpoint is used to update an existing webhook endpoint.
+         *
+         * @tags webhook_endpoints
+         * @name UpdateWebhookEndpoint
+         * @summary Update a webhook endpoint
+         * @request PUT:/webhook_endpoints/{lago_id}
+         * @secure
+         */
+        updateWebhookEndpoint: (lagoId: string, data: {
+            webhook_endpoint?: {
+                /**
+                 * The URL of the webhook endpoint.
+                 * @example "https://foo.bar"
+                 */
+                webhook_url: string;
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<any, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used to retrieve an existing webhook endpoint.
+         *
+         * @tags webhook_endpoints
+         * @name FindWebhookEndpoint
+         * @summary Retrieve a webhook endpoint
+         * @request GET:/webhook_endpoints/{lago_id}
+         * @secure
+         */
+        findWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<any, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used to delete an existing webhook endpoint.
+         *
+         * @tags webhook_endpoints
+         * @name DestroyWebhookEndpoint
+         * @summary Delete a webhook endpoint
+         * @request DELETE:/webhook_endpoints/{lago_id}
+         * @secure
+         */
+        destroyWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<any, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
+    };
 }
 export {};