lago-javascript-client 0.23.0-beta → 0.26.1-beta

package/types/swagger/client.d.ts

@@ -1,37 +1,39 @@
 export interface BillableMetricGroup {
     /** @example "region" */
-    key?: string;
-    values?: (string | object)[];
+    key: string;
+    values: (string | object)[];
 }
 export interface BillableMetricObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "bm1" */
-    name?: string;
+    name: string;
     /** @example "example_code" */
-    code?: string;
+    code: string;
     /** @example "description" */
     description?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "amount" */
     field_name?: string;
     /** Aggregation type */
-    aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "recurring_count_agg";
+    aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "recurring_count_agg";
     group?: BillableMetricGroup;
     /** @example 0 */
-    active_subscriptions_count?: number;
+    active_subscriptions_count: number;
     /** @example 0 */
-    draft_invoices_count?: number;
+    draft_invoices_count: number;
+    /** @example 0 */
+    plans_count: number;
 }
 export interface BillableMetric {
-    billable_metric?: BillableMetricObject;
+    billable_metric: BillableMetricObject;
 }
 export interface BillableMetrics {
-    billable_metrics?: BillableMetricObject[];
+    billable_metrics: BillableMetricObject[];
 }
 export interface BillableMetricInput {
-    billable_metric?: {
+    billable_metric: {
         /** @example "bm1" */
         name?: string;
         /** @example "example_code" */
@@ -46,40 +48,40 @@ export interface BillableMetricInput {
     };
 }
 export interface GroupObject {
+    /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+    lago_id: string;
     /** @example "region" */
-    key?: string;
+    key: string;
     /** @example "EU" */
-    value?: string;
-    /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    value: string;
 }
 export interface Groups {
-    groups?: GroupObject[];
+    groups: GroupObject[];
 }
 export interface AddOnObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "example name" */
-    name?: string;
+    name: string;
     /** @example "example_code" */
-    code?: string;
+    code: string;
     /** @example "description" */
     description?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
 }
 export interface AddOn {
-    add_on?: AddOnObject;
+    add_on: AddOnObject;
 }
 export interface AddOns {
-    add_ons?: AddOnObject[];
+    add_ons: AddOnObject[];
 }
 export interface AddOnInput {
-    add_on?: {
+    add_on: {
         /** @example "example name" */
         name?: string;
         /** @example "example_code" */
@@ -94,31 +96,31 @@ export interface AddOnInput {
 }
 export interface AppliedAddOnObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "457uj93c-c007-4fbb-afcd-b00c07c41kki" */
-    lago_add_on_id?: string;
+    lago_add_on_id: string;
     /** @example "code" */
-    add_on_code?: string;
+    add_on_code: string;
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_customer_id?: string;
-    /** @example 1234567 */
-    external_customer_id?: string;
+    lago_customer_id: string;
+    /** @example "1234567" */
+    external_customer_id: string;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
 }
 export interface AppliedAddOn {
-    applied_add_on?: AppliedAddOnObject;
+    applied_add_on: AppliedAddOnObject;
 }
 export interface AppliedAddOnInput {
-    applied_add_on?: {
-        /** @example 1234567 */
-        external_customer_id?: string;
+    applied_add_on: {
+        /** @example "1234567" */
+        external_customer_id: string;
         /** @example "code" */
-        add_on_code?: string;
+        add_on_code: string;
         /** @example 1200 */
         amount_cents?: number;
         /** @example "EUR" */
@@ -127,13 +129,13 @@ export interface AppliedAddOnInput {
 }
 export interface CouponObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "coupon1" */
-    name?: string;
+    name: string;
     /** @example "example_code" */
-    code?: string;
+    code: string;
     /** Coupon type */
-    coupon_type?: "fixed_amount" | "percentage";
+    coupon_type: "fixed_amount" | "percentage";
     /** @example 1200 */
     amount_cents?: number;
     /** @example "EUR" */
@@ -144,26 +146,26 @@ export interface CouponObject {
     limited_plans?: boolean;
     plan_codes?: string[];
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example 25 */
     percentage_rate?: number;
     /** Frequency type */
-    frequency?: "once" | "recurring";
+    frequency: "once" | "recurring";
     /** @example 3 */
     frequency_duration?: number;
     /** @example "2022-09-14T23:59:59.000Z" */
     expiration_at?: string;
     /** Expiration type */
-    expiration?: "no_expiration" | "time_limit";
+    expiration: "no_expiration" | "time_limit";
 }
 export interface Coupon {
-    coupon?: CouponObject;
+    coupon: CouponObject;
 }
 export interface Coupons {
-    coupons?: CouponObject[];
+    coupons: CouponObject[];
 }
 export interface CouponInput {
-    coupon?: {
+    coupon: {
         /** @example "coupon1" */
         name?: string;
         /** @example "example_code" */
@@ -193,27 +195,27 @@ export interface CouponInput {
 }
 export interface AppliedCouponObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "544da83c-c007-4fbb-afcd-b00c07c41iit" */
-    lago_coupon_id?: string;
+    lago_coupon_id: string;
     /** @example "example_code" */
-    coupon_code?: string;
+    coupon_code: string;
     /** @example "321da83c-c007-4fbb-afcd-b00c07c41ssd" */
-    lago_customer_id?: string;
-    /** @example 123456 */
-    external_customer_id?: string;
+    lago_customer_id: string;
+    /** @example "123456" */
+    external_customer_id: string;
     /** Status */
-    status?: "active" | "terminated";
+    status: "active" | "terminated";
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example 800 */
     amount_cents_remaining?: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
     /** @example 25 */
     percentage_rate?: number;
     /** Frequency type */
-    frequency?: "once" | "recurring";
+    frequency: "once" | "recurring";
     /** @example 3 */
     frequency_duration?: number;
     /** @example 2 */
@@ -221,22 +223,23 @@ export interface AppliedCouponObject {
     /** @example "2022-09-14T23:59:59.000Z" */
     expiration_at?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "2022-09-14T16:35:31.000Z" */
     terminated_at?: string;
+    credits: CreditObject[];
 }
 export interface AppliedCoupon {
-    applied_coupon?: AppliedCouponObject;
+    applied_coupon: AppliedCouponObject;
 }
 export interface AppliedCoupons {
-    applied_coupons?: AppliedCouponObject[];
+    applied_coupons: AppliedCouponObject[];
 }
 export interface AppliedCouponInput {
-    applied_coupon?: {
-        /** @example 123456 */
-        external_customer_id?: string;
+    applied_coupon: {
+        /** @example "123456" */
+        external_customer_id: string;
         /** @example "example_code" */
-        coupon_code?: string;
+        coupon_code: string;
         /** Frequency type */
         frequency?: "once" | "recurring";
         /** @example 3 */
@@ -263,9 +266,9 @@ export interface OrganizationObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
     lago_id?: string;
     /** @example "example name" */
-    name?: string;
+    name: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "https://example.com" */
     webhook_url?: string;
     /** @example "CZ" */
@@ -276,7 +279,7 @@ export interface OrganizationObject {
     address_line2?: string;
     /** @example "state1" */
     state?: string;
-    /** @example 10000 */
+    /** @example "10000" */
     zipcode?: string;
     /** @example "example@example.com" */
     email?: string;
@@ -284,17 +287,17 @@ export interface OrganizationObject {
     city?: string;
     /** @example "name1" */
     legal_name?: string;
-    /** @example 10000 */
+    /** @example "10000" */
     legal_number?: string;
     /** @example "UTC" */
     timezone?: string;
     billing_configuration?: BillingConfigurationOrganization;
 }
 export interface Organization {
-    organization?: OrganizationObject;
+    organization: OrganizationObject;
 }
 export interface OrganizationInput {
-    organization?: {
+    organization: {
         /** @example "https://example.com" */
         webhook_url?: string;
         /** @example "CZ" */
@@ -305,7 +308,7 @@ export interface OrganizationInput {
         address_line2?: string;
         /** @example "state1" */
         state?: string;
-        /** @example 10000 */
+        /** @example "10000" */
         zipcode?: string;
         /** @example "example@example.com" */
         email?: string;
@@ -325,7 +328,7 @@ export interface BillingConfigurationCustomer {
     invoice_grace_period?: number;
     /** Payment provider type */
     payment_provider?: "stripe" | "gocardless";
-    /** @example 123456 */
+    /** @example "123456" */
     provider_customer_id?: string;
     /** @example true */
     sync_with_provider?: boolean;
@@ -335,17 +338,29 @@ export interface BillingConfigurationCustomer {
     vat_rate?: number;
     [key: string]: any;
 }
-export interface CustomerObject {
+export interface CustomerMetadataObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
     lago_id?: string;
+    /** @example "name" */
+    key?: string;
+    /** @example "John" */
+    value?: string;
+    /** @example false */
+    display_in_invoice?: boolean;
+    /** @example "2022-09-14T16:35:31.000Z" */
+    created_at?: string;
+}
+export interface CustomerObject {
+    /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+    lago_id: string;
     /** @example "886da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    external_id?: string;
+    external_id: string;
     /** @example "John Doe" */
     name?: string;
     /** @example 12345 */
-    sequential_id?: number;
+    sequential_id: number;
     /** @example "slug" */
-    slug?: string;
+    slug: string;
     /** @example "2022-09-14T16:35:31.000Z" */
     created_at?: string;
     /** @example "CZ" */
@@ -379,17 +394,18 @@ export interface CustomerObject {
     /** @example "UTC" */
     applicable_timezone?: string;
     billing_configuration?: BillingConfigurationCustomer;
+    metadata?: CustomerMetadataObject[];
 }
 export interface Customer {
-    customer?: CustomerObject;
+    customer: CustomerObject;
 }
 export interface Customers {
-    customers?: CustomerObject[];
+    customers: CustomerObject[];
 }
 export interface CustomerInput {
-    customer?: {
+    customer: {
         /** @example "886da83c-c007-4fbb-afcd-b00c07c41ffe" */
-        external_id?: string;
+        external_id: string;
         /** @example "John Doe" */
         name?: string;
         /** @example "CZ" */
@@ -421,22 +437,32 @@ export interface CustomerInput {
         /** @example "Europe/Paris" */
         timezone?: string;
         billing_configuration?: BillingConfigurationCustomer;
+        metadata?: {
+            /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+            id?: string;
+            /** @example "name" */
+            key?: string;
+            /** @example "John" */
+            value?: string;
+            /** @example false */
+            display_in_invoice?: boolean;
+        }[];
     };
 }
 export interface ChargeUsageObject {
     /** @example 3 */
-    units?: number;
+    units: number;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
-    charge?: {
+    amount_currency: string;
+    charge: {
         /** @example "278da83c-c007-4fbb-afcd-b00c07c41utg" */
         lago_id?: string;
         /** Charge model type */
         charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
     };
-    billable_metric?: {
+    billable_metric: {
         /** @example "278da83c-c007-4fbb-afcd-b00c07c41utg" */
         lago_id?: string;
         /** @example "Example name" */
@@ -446,7 +472,7 @@ export interface ChargeUsageObject {
         /** Aggregation type */
         aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "recurring_count_agg";
     };
-    groups?: {
+    groups: {
         /** @example "278da83c-c007-4fbb-afcd-b00c07c41utg" */
         lago_id?: string;
         /** @example "key" */
@@ -461,115 +487,117 @@ export interface ChargeUsageObject {
 }
 export interface CustomerUsageObject {
     /** @example "2022-09-14T00:00:00.000Z" */
-    from_datetime?: string;
+    from_datetime: string;
     /** @example "2022-09-14T00:00:00.000Z" */
-    to_datetime?: string;
+    to_datetime: string;
     /** @example "2022-09-15T00:00:00.000Z" */
-    issuing_date?: string;
+    issuing_date: string;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
     /** @example 1400 */
-    total_amount_cents?: number;
+    total_amount_cents: number;
     /** @example "EUR" */
-    total_amount_currency?: string;
+    total_amount_currency: string;
     /** @example 200 */
-    vat_amount_cents?: number;
+    vat_amount_cents: number;
     /** @example "EUR" */
-    vat_amount_currency?: string;
-    charges_usage?: ChargeUsageObject[];
+    vat_amount_currency: string;
+    charges_usage: ChargeUsageObject[];
 }
 export interface CustomerUsage {
-    customer_usage?: CustomerUsageObject;
+    customer_usage: CustomerUsageObject;
 }
 export interface EventObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
-    /** @example 987654321 */
-    transaction_id?: string;
+    lago_id: string;
+    /** @example "987654321" */
+    transaction_id: string;
     /** @example "111da83c-c007-4fbb-afcd-b00c07c41iop" */
-    lago_customer_id?: string;
-    /** @example 123456 */
-    external_customer_id?: string;
+    lago_customer_id: string;
+    /** @example "123456" */
+    external_customer_id: string;
     /** @example "code" */
-    code?: string;
+    code: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    timestamp?: string;
+    timestamp: string;
     properties?: object;
     /** @example "447da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_subscription_id?: string;
-    /** @example 123456 */
-    external_subscription_id?: string;
+    lago_subscription_id: string;
+    /** @example "123456" */
+    external_subscription_id: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
 }
 export interface Event {
-    event?: EventObject;
+    event: EventObject;
 }
 export interface EventInput {
-    event?: {
-        /** @example 123456 */
-        transaction_id?: string;
-        /** @example 654321 */
+    event: {
+        /** @example "123456" */
+        transaction_id: string;
+        /** @example "654321" */
         external_customer_id?: string;
         /** @example "code" */
-        code?: string;
+        code: string;
         /** @example 1669823754 */
         timestamp?: number;
-        /** @example 123456 */
+        /** @example "123456" */
         external_subscription_id?: string;
         properties?: object;
     };
 }
 export interface BatchEventInput {
-    event?: {
-        /** @example 123456 */
-        transaction_id?: string;
-        /** @example 654321 */
+    event: {
+        /** @example "123456" */
+        transaction_id: string;
+        /** @example "654321" */
         external_customer_id?: string;
         /** @example "code" */
-        code?: string;
+        code: string;
         /** @example 1669823754 */
         timestamp?: number;
-        external_subscription_ids?: string[];
+        external_subscription_ids: string[];
         properties?: object;
     };
 }
 export interface GroupPropertiesObject {
-    /** @example 123456 */
-    group_id?: string;
-    values?: object;
+    /** @example "123456" */
+    group_id: string;
+    values: object;
 }
 export interface ChargeObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "278da83c-c007-4fbb-afcd-b00c07c41utg" */
-    lago_billable_metric_id?: string;
+    lago_billable_metric_id: string;
+    /** @example "bm_code" */
+    billable_metric_code: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** Charge model type */
-    charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
+    charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
     properties?: object;
     group_properties?: GroupPropertiesObject[];
 }
 export interface PlanObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "example name" */
-    name?: string;
+    name: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "example_code" */
-    code?: string;
+    code: string;
     /** Plan interval */
-    interval?: "weekly" | "monthly" | "yearly";
+    interval: "weekly" | "monthly" | "yearly";
     /** @example "description" */
     description?: string;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
     /** @example 2 */
     trial_period?: number;
     /** @example true */
@@ -577,19 +605,19 @@ export interface PlanObject {
     /** @example false */
     bill_charges_monthly?: boolean;
     /** @example 2 */
-    active_subscriptions_count?: number;
+    active_subscriptions_count: number;
     /** @example 2 */
-    draft_invoices_count?: number;
+    draft_invoices_count: number;
     charges?: ChargeObject[];
 }
 export interface Plan {
-    plan?: PlanObject;
+    plan: PlanObject;
 }
 export interface Plans {
-    plans?: PlanObject[];
+    plans: PlanObject[];
 }
 export interface PlanInput {
-    plan?: {
+    plan: {
         /** @example "example name" */
         name?: string;
         /** @example "example_code" */
@@ -617,40 +645,40 @@ export interface PlanInput {
             charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
             properties?: object;
             group_properties?: {
-                /** @example 123456 */
-                group_id?: string;
-                values?: object;
+                /** @example "123456" */
+                group_id: string;
+                values: object;
             }[];
         }[];
     };
 }
 export interface SubscriptionObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example 12345 */
-    external_id?: string;
+    external_id: string;
     /** @example "995da83c-c007-4fbb-afcd-b00c07c41tre" */
-    lago_customer_id?: string;
+    lago_customer_id: string;
     /** @example 54321 */
-    external_customer_id?: string;
+    external_customer_id: string;
     /** @example "Test subscription" */
     name?: string;
     /** @example "plan_code" */
-    plan_code?: string;
+    plan_code: string;
     /** Subscription status */
-    status?: "active" | "pending" | "terminated" | "canceled";
+    status: "active" | "pending" | "terminated" | "canceled";
     /** Billing time */
-    billing_time?: "calendar" | "anniversary";
+    billing_time: "calendar" | "anniversary";
     /** @example "2022-09-14T16:35:31.000Z" */
-    subscription_at?: string;
+    subscription_at: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    started_at?: string;
+    started_at: string;
     /** @example "2022-09-14T16:35:31.000Z" */
     terminated_at?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
     canceled_at?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "previous_code" */
     previous_plan_code?: string;
     /** @example "next_code" */
@@ -659,21 +687,21 @@ export interface SubscriptionObject {
     downgrade_plan_date?: string;
 }
 export interface Subscription {
-    subscription?: SubscriptionObject;
+    subscription: SubscriptionObject;
 }
 export interface Subscriptions {
-    subscriptions?: SubscriptionObject[];
+    subscriptions: SubscriptionObject[];
 }
 export interface SubscriptionCreateInput {
-    subscription?: {
+    subscription: {
         /** @example 12345 */
-        external_customer_id?: string;
+        external_customer_id: string;
         /** @example "example_code" */
-        plan_code?: string;
+        plan_code: string;
         /** @example "Test name" */
         name?: string;
         /** @example 54321 */
-        external_id?: string;
+        external_id: string;
         /** Billing time */
         billing_time?: "calendar" | "anniversary";
         /** @example "2022-08-08T00:00:00.000Z" */
@@ -681,7 +709,7 @@ export interface SubscriptionCreateInput {
     };
 }
 export interface SubscriptionUpdateInput {
-    subscription?: {
+    subscription: {
         /** @example "New name" */
         name?: string;
         /** @example "2022-08-08T00:00:00.000Z" */
@@ -690,120 +718,150 @@ export interface SubscriptionUpdateInput {
 }
 export interface CreditObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
-    item?: {
+    amount_currency: string;
+    item: {
         /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-        lago_id?: string;
+        lago_id: string;
         /** @example "coupon" */
-        type?: string;
+        type: string;
         /** @example "code" */
-        code?: string;
+        code: string;
         /** @example "name" */
-        name?: string;
+        name: string;
+    };
+    invoice: {
+        /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+        lago_id: string;
+        payment_status: "pending" | "succeeded" | "failed";
     };
 }
 export interface FeeObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
     lago_group_id?: string;
-    /** @example 1200 */
-    amount_cents?: number;
+    /** @example 1000 */
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
-    /** @example 1200 */
-    vat_amount_cents?: number;
+    amount_currency: string;
+    /** @example 200 */
+    vat_amount_cents: number;
     /** @example "EUR" */
-    vat_amount_currency?: string;
+    vat_amount_currency: string;
     /** @example 2.5 */
-    units?: number;
+    units: number;
+    /** @example 1200 */
+    total_amount_cents?: number;
+    /** @example "EUR" */
+    total_amount_currency?: string;
     /** @example 5 */
     events_count?: number;
-    item?: {
+    item: {
         /** Billing time */
-        type?: "charge" | "add_on" | "subscription" | "credit";
+        type: "charge" | "add_on" | "subscription" | "credit";
         /** @example "code" */
-        code?: string;
+        code: string;
         /** @example "name" */
-        name?: string;
+        name: string;
     };
 }
-export interface InvoiceObject {
+export interface InvoiceMetadataObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
     lago_id?: string;
+    /** @example "name" */
+    key?: string;
+    /** @example "John" */
+    value?: string;
+    /** @example "2022-09-14T16:35:31.000Z" */
+    created_at?: string;
+}
+export interface InvoiceObject {
+    /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+    lago_id: string;
     /** @example 12345 */
-    sequential_id?: number;
+    sequential_id: number;
     /** @example 222345 */
-    number?: string;
+    number: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    issuing_date?: string;
+    charges_from_date: string;
+    /** @example "2022-09-14T16:35:31.000Z" */
+    issuing_date: string;
     invoice_type?: "subscription" | "add_on" | "credit";
-    status?: "draft" | "finalized";
-    payment_status?: "pending" | "succeeded" | "failed";
+    status: "draft" | "finalized";
+    payment_status: "pending" | "succeeded" | "failed";
     /** @example 1200 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
+    amount_currency: string;
     /** @example 20 */
-    vat_amount_cents?: number;
+    vat_amount_cents: number;
     /** @example "EUR" */
-    vat_amount_currency?: string;
+    vat_amount_currency: string;
     /** @example 20 */
-    credit_amount_cents?: number;
+    credit_amount_cents: number;
     /** @example "EUR" */
-    credit_amount_currency?: string;
+    credit_amount_currency: string;
     /** @example 1220 */
-    total_amount_cents?: number;
+    total_amount_cents: number;
     /** @example "EUR" */
-    total_amount_currency?: string;
+    total_amount_currency: string;
     /** @example true */
-    legacy?: boolean;
+    legacy: boolean;
     /** @example "https://example.com" */
     file_url?: string;
-    customer?: CustomerObject;
-    subscriptions?: SubscriptionObject[];
-    fees?: FeeObject[];
-    credits?: CreditObject[];
+    customer: CustomerObject;
+    subscriptions: SubscriptionObject[];
+    metadata?: InvoiceMetadataObject[];
+    fees: FeeObject[];
+    credits: CreditObject[];
 }
 export interface Invoice {
-    invoice?: InvoiceObject;
+    invoice: InvoiceObject;
 }
 export interface Invoices {
-    invoices?: InvoiceObject[];
+    invoices: InvoiceObject[];
 }
 export interface InvoiceInput {
-    invoice?: {
+    invoice: {
         /** Status */
-        payment_status?: "pending" | "succeeded" | "failed";
+        payment_status: "pending" | "succeeded" | "failed";
+        metadata?: {
+            /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
+            id?: string;
+            /** @example "name" */
+            key?: string;
+            /** @example "John" */
+            value?: string;
+        }[];
     };
 }
 export interface WalletObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "254da83c-c007-4fbb-afcd-b00c07c41oit" */
-    lago_customer_id?: string;
+    lago_customer_id: string;
     /** @example 12345 */
-    external_customer_id?: string;
+    external_customer_id: string;
     /** Status */
-    status?: "active" | "terminated";
+    status: "active" | "terminated";
     /** @example "EUR" */
-    currency?: string;
+    currency: string;
     /** @example "Name" */
     name?: string;
     /** @example 2 */
-    rate_amount?: number;
+    rate_amount: number;
     /** @example 500 */
-    credits_balance?: number;
+    credits_balance: number;
     /** @example 1000 */
-    balance?: number;
+    balance: number;
     /** @example 100 */
-    consumed_credits?: number;
+    consumed_credits: number;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "2022-09-14T23:59:59.000Z" */
     expiration_at?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
@@ -814,31 +872,31 @@ export interface WalletObject {
     terminated_at?: string;
 }
 export interface Wallet {
-    wallet?: WalletObject;
+    wallet: WalletObject;
 }
 export interface Wallets {
-    wallets?: WalletObject[];
+    wallets: WalletObject[];
 }
 export interface WalletInput {
     wallet?: {
         /** @example "Wallet name" */
         name?: string;
         /** @example 2 */
-        rate_amount?: number;
+        rate_amount: number;
         /** @example "EUR" */
-        currency?: string;
+        currency: string;
         /** @example 500 */
         paid_credits?: number;
         /** @example 10 */
         granted_credits?: number;
         /** @example 12345 */
-        external_customer_id?: string;
+        external_customer_id: string;
         /** @example "2022-09-14T23:59:59.000Z" */
         expiration_at?: string;
     };
 }
 export interface WalletUpdateInput {
-    wallet?: {
+    wallet: {
         /** @example "Wallet name" */
         name?: string;
         /** @example "2022-09-14T23:59:59.000Z" */
@@ -847,32 +905,32 @@ export interface WalletUpdateInput {
 }
 export interface WalletTransactionObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example "985da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_wallet_id?: string;
+    lago_wallet_id: string;
     /** Status */
-    status?: "pending" | "settled";
+    status: "pending" | "settled";
     /** Transaction type */
-    transaction_type?: "inbound" | "outbound";
+    transaction_type: "inbound" | "outbound";
     /** @example 500 */
-    amount?: number;
+    amount: number;
     /** @example 100 */
-    credit_amount?: number;
+    credit_amount: number;
     /** @example "2022-09-14T16:35:31.000Z" */
     settled_at?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
 }
 export interface WalletTransaction {
-    wallet_transaction?: WalletTransactionObject;
+    wallet_transaction: WalletTransactionObject;
 }
 export interface WalletTransactions {
-    wallet_transactions?: WalletTransactionObject[];
+    wallet_transactions: WalletTransactionObject[];
 }
 export interface WalletTransactionInput {
-    wallet_transaction?: {
+    wallet_transaction: {
         /** @example "985da83c-c007-4fbb-afcd-b00c07c41ffe" */
-        wallet_id?: string;
+        wallet_id: string;
         /** @example 100 */
         paid_credits?: number;
         /** @example 10 */
@@ -881,97 +939,97 @@ export interface WalletTransactionInput {
 }
 export interface CreditNoteItemObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example 1220 */
-    amount_cents?: number;
+    amount_cents: number;
     /** @example "EUR" */
-    amount_currency?: string;
-    fee?: FeeObject;
+    amount_currency: string;
+    fee: FeeObject;
 }
 export interface CreditNoteObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_id?: string;
+    lago_id: string;
     /** @example 1234 */
-    sequential_id?: number;
-    /** @example 123456789 */
-    number?: string;
+    sequential_id: number;
+    /** @example "123456789" */
+    number: string;
     /** @example "144da83c-c007-4fbb-afcd-b00c07c41ffe" */
-    lago_invoice_id?: string;
-    /** @example 123456789 */
-    invoice_number?: string;
+    lago_invoice_id: string;
+    /** @example "123456789" */
+    invoice_number: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    issuing_date?: string;
+    issuing_date: string;
     /** Credit status */
     credit_status?: "available" | "consumed" | "voided";
     /** Refund status */
     refund_status?: "pending" | "succeeded" | "failed";
     /** Reason */
-    reason?: "duplicated_charge" | "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "other";
+    reason: "duplicated_charge" | "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "other";
     /** @example "description" */
     description?: string;
     /** @example 1220 */
-    total_amount_cents?: number;
+    total_amount_cents: number;
     /** @example "EUR" */
-    total_amount_currency?: string;
+    total_amount_currency: string;
     /** @example 20 */
-    vat_amount_cents?: number;
+    vat_amount_cents: number;
     /** @example "EUR" */
-    vat_amount_currency?: string;
+    vat_amount_currency: string;
     /** @example 1000 */
-    sub_total_vat_excluded_amount_cents?: number;
+    sub_total_vat_excluded_amount_cents: number;
     /** @example "EUR" */
-    sub_total_vat_excluded_amount_currency?: string;
+    sub_total_vat_excluded_amount_currency: string;
     /** @example 20 */
-    balance_amount_cents?: number;
+    balance_amount_cents: number;
     /** @example "EUR" */
-    balance_amount_currency?: string;
+    balance_amount_currency: string;
     /** @example 20 */
-    credit_amount_cents?: number;
+    credit_amount_cents: number;
     /** @example "EUR" */
-    credit_amount_currency?: string;
+    credit_amount_currency: string;
     /** @example 20 */
-    refund_amount_cents?: number;
+    refund_amount_cents: number;
     /** @example "EUR" */
-    refund_amount_currency?: string;
+    refund_amount_currency: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    created_at?: string;
+    created_at: string;
     /** @example "2022-09-14T16:35:31.000Z" */
-    updated_at?: string;
+    updated_at: string;
     /** @example "https://example.com" */
     file_url?: string;
     customer?: CustomerObject;
     items?: CreditNoteItemObject[];
 }
 export interface CreditNote {
-    credit_note?: CreditNoteObject;
+    credit_note: CreditNoteObject;
 }
 export interface CreditNotes {
-    credit_notes?: CreditNoteObject[];
+    credit_notes: CreditNoteObject[];
 }
 export interface CreditNoteInput {
-    credit_note?: {
+    credit_note: {
         /** @example "194da83c-c007-4fbb-afcd-b00c07c41fzh" */
-        invoice_id?: string;
+        invoice_id: string;
         /** Reason */
-        reason?: "duplicated_charge" | "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "other";
+        reason: "duplicated_charge" | "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "other";
         /** @example "description" */
         description?: string;
         /** @example 20 */
-        credit_amount_cents?: number;
+        credit_amount_cents: number;
         /** @example 20 */
-        refund_amount_cents?: number;
-        items?: {
+        refund_amount_cents: number;
+        items: {
             /** @example "144da83c-c007-4fbb-afcd-b00c07c41ffe" */
-            fee_id?: string;
+            fee_id: string;
             /** @example 20 */
-            amount_cents?: number;
+            amount_cents: number;
         }[];
     };
 }
 export interface CreditNoteUpdateInput {
-    credit_note?: {
+    credit_note: {
         /** Refund status */
-        refund_status?: "pending" | "succeeded" | "failed";
+        refund_status: "pending" | "succeeded" | "failed";
     };
 }
 export interface ApiResponseBadRequest {
@@ -979,52 +1037,52 @@ export interface ApiResponseBadRequest {
      * @format int32
      * @example 400
      */
-    status?: number;
+    status: number;
     /** @example "Bad request" */
-    error?: string;
+    error: string;
 }
 export interface ApiResponseUnauthorized {
     /**
      * @format int32
      * @example 401
      */
-    status?: number;
+    status: number;
     /** @example "Unauthorized" */
-    error?: string;
+    error: string;
 }
 export interface ApiResponseUnprocessableEntity {
     /**
      * @format int32
      * @example 422
      */
-    status?: number;
+    status: number;
     /** @example "Unprocessable entity" */
-    error?: string;
+    error: string;
     /** @example "validation_errors" */
-    code?: string;
-    error_details?: object;
+    code: string;
+    error_details: object;
 }
 export interface ApiResponseNotFound {
     /**
      * @format int32
      * @example 404
      */
-    status?: number;
+    status: number;
     /** @example "Not Found" */
-    error?: string;
+    error: string;
     /** @example "object_not_found" */
-    code?: string;
+    code: string;
 }
 export interface ApiResponseNotAllowed {
     /**
      * @format int32
      * @example 405
      */
-    status?: number;
+    status: number;
     /** @example "Method Not Allowed" */
-    error?: string;
+    error: string;
     /** @example "not_allowed" */
-    code?: string;
+    code: string;
 }
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
@@ -1086,7 +1144,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.23.0-beta
+ * @version 0.26.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
@@ -1351,7 +1409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             status?: "active" | "terminated";
             /**
              * External customer ID
-             * @example 12345
+             * @example "12345"
              */
             external_customer_id?: string;
         }, params?: RequestParams) => Promise<HttpResponse<AppliedCoupons, ApiResponseUnauthorized>>;
@@ -1411,7 +1469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findCustomerCurrentUsage: (customerExternalId: string, query: {
             /**
              * External subscription ID
-             * @example 54321
+             * @example "54321"
              */
             external_subscription_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiResponseUnauthorized | ApiResponseNotFound>>;
@@ -1595,7 +1653,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             per_page?: number;
             /**
              * External customer ID
-             * @example 12345
+             * @example "12345"
              */
             external_customer_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<Subscriptions, ApiResponseUnauthorized | ApiResponseNotFound>>;
@@ -1695,7 +1753,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             per_page?: number;
             /**
              * External customer ID
-             * @example 12345
+             * @example "12345"
              */
             external_customer_id?: string;
             /**
@@ -1715,6 +1773,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             status?: string;
         }, params?: RequestParams) => Promise<HttpResponse<Invoices, ApiResponseUnauthorized>>;
     };
+    fees: {
+        /**
+         * @description Return a single fee
+         *
+         * @tags fees
+         * @name FindFee
+         * @summary Find fee by ID
+         * @request GET:/fees/{id}
+         * @secure
+         */
+        findFee: (id: string, params?: RequestParams) => Promise<HttpResponse<FeeObject, ApiResponseUnauthorized | ApiResponseNotFound>>;
+    };
     wallets: {
         /**
          * @description Create a new wallet
@@ -1778,7 +1848,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             per_page?: number;
             /**
              * External customer ID
-             * @example 12345
+             * @example "12345"
              */
             external_customer_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<Wallets, ApiResponseUnauthorized>>;
@@ -1899,7 +1969,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             per_page?: number;
             /**
              * External customer ID
-             * @example 12345
+             * @example "12345"
              */
             external_customer_id?: string;
         }, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiResponseUnauthorized>>;