lago-javascript-client 1.48.0 → 1.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3862,6 +3862,11 @@ export interface SubscriptionObject {
3862
3862
  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
3863
3863
  */
3864
3864
  external_customer_id: string;
3865
+ /**
3866
+ * The code of the billing entity associated with the subscription.
3867
+ * @example "default"
3868
+ */
3869
+ billing_entity_code?: string;
3865
3870
  /**
3866
3871
  * The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
3867
3872
  * @example "anniversary"
@@ -4053,6 +4058,11 @@ export interface WalletRecurringTransactionRule {
4053
4058
  * @example "10.0"
4054
4059
  */
4055
4060
  granted_credits: string;
4061
+ /**
4062
+ * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
4063
+ * @example false
4064
+ */
4065
+ grants_target_top_up: boolean | null;
4056
4066
  /**
4057
4067
  * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
4058
4068
  * @format date-time
@@ -4125,6 +4135,11 @@ export interface WalletObject {
4125
4135
  * @example "hooli_1234"
4126
4136
  */
4127
4137
  external_customer_id: string;
4138
+ /**
4139
+ * The code of the billing entity associated with the wallet.
4140
+ * @example "default"
4141
+ */
4142
+ billing_entity_code?: string;
4128
4143
  /**
4129
4144
  * The status of the wallet. Possible values are `active` or `terminated`.
4130
4145
  * @example "active"
@@ -4331,6 +4346,11 @@ export interface WalletCreateInput {
4331
4346
  * @example "hooli_1234"
4332
4347
  */
4333
4348
  external_customer_id: string;
4349
+ /**
4350
+ * The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.
4351
+ * @example "default"
4352
+ */
4353
+ billing_entity_code?: string;
4334
4354
  /**
4335
4355
  * The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
4336
4356
  * @format date-time
@@ -4423,6 +4443,11 @@ export interface WalletUpdateInput {
4423
4443
  * @example false
4424
4444
  */
4425
4445
  invoice_requires_successful_payment?: boolean;
4446
+ /**
4447
+ * The code of the billing entity associated with the wallet.
4448
+ * @example "default"
4449
+ */
4450
+ billing_entity_code?: string;
4426
4451
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
4427
4452
  invoice_custom_section?: InvoiceCustomSectionInput;
4428
4453
  /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
@@ -4466,6 +4491,11 @@ export interface WalletUpdateInput {
4466
4491
  * @example "10.0"
4467
4492
  */
4468
4493
  granted_credits?: string | null;
4494
+ /**
4495
+ * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
4496
+ * @example false
4497
+ */
4498
+ grants_target_top_up?: boolean | null;
4469
4499
  /**
4470
4500
  * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
4471
4501
  * @format date-time
@@ -5608,6 +5638,11 @@ export interface InvoiceOneOffCreateInput {
5608
5638
  * @example "hooli_1234"
5609
5639
  */
5610
5640
  external_customer_id: string;
5641
+ /**
5642
+ * The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.
5643
+ * @example "default"
5644
+ */
5645
+ billing_entity_code?: string;
5611
5646
  /**
5612
5647
  * The currency of the invoice.
5613
5648
  * @example "EUR"
@@ -6725,6 +6760,8 @@ export interface FixedChargeObject {
6725
6760
  properties: FixedChargeProperties;
6726
6761
  /**
6727
6762
  * The number of units for the fixed charge.
6763
+ *
6764
+ * When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units.
6728
6765
  * @example 1
6729
6766
  */
6730
6767
  units: number;
@@ -7776,7 +7813,7 @@ export interface PlanOverridesObject {
7776
7813
  conversion_rate?: string;
7777
7814
  };
7778
7815
  }[];
7779
- /** Additional fixed charges for this plan. */
7816
+ /** Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead. */
7780
7817
  fixed_charges?: {
7781
7818
  /**
7782
7819
  * Unique identifier of the fixed charge created by Lago.
@@ -7875,7 +7912,7 @@ export interface SubscriptionCreateInput {
7875
7912
  * @example "2022-08-08T00:00:00Z"
7876
7913
  */
7877
7914
  subscription_at?: string;
7878
- /** Based plan overrides. */
7915
+ /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
7879
7916
  plan_overrides?: PlanOverridesObject;
7880
7917
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
7881
7918
  invoice_custom_section?: InvoiceCustomSectionInput;
@@ -7941,7 +7978,7 @@ export interface SubscriptionUpdateInput {
7941
7978
  * @example "2022-08-08T00:00:00Z"
7942
7979
  */
7943
7980
  subscription_at?: string;
7944
- /** Based plan overrides. */
7981
+ /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
7945
7982
  plan_overrides?: PlanOverridesObject;
7946
7983
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
7947
7984
  invoice_custom_section?: InvoiceCustomSectionInput;
@@ -7955,6 +7992,11 @@ export interface SubscriptionUpdateInput {
7955
7992
  * @example false
7956
7993
  */
7957
7994
  consolidate_invoice?: boolean;
7995
+ /**
7996
+ * The code of the billing entity associated with the subscription. Updates take effect on future invoices only.
7997
+ * @example "default"
7998
+ */
7999
+ billing_entity_code?: string;
7958
8000
  };
7959
8001
  }
7960
8002
  export interface Subscription {
@@ -9093,7 +9135,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
9093
9135
  }
9094
9136
  /**
9095
9137
  * @title Lago API documentation
9096
- * @version 1.48.0
9138
+ * @version 1.49.0
9097
9139
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
9098
9140
  * @baseUrl https://api.getlago.com/api/v1
9099
9141
  * @externalDocs https://github.com/getlago
@@ -10306,6 +10348,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10306
10348
  * @example "pending"
10307
10349
  */
10308
10350
  payment_status?: "pending" | "failed" | "succeeded";
10351
+ /**
10352
+ * Filter payment requests by billing entity codes.
10353
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10354
+ */
10355
+ "billing_entity_codes[]"?: string[];
10309
10356
  }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
10310
10357
  /**
10311
10358
  * @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
@@ -10355,6 +10402,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10355
10402
  * @example ["active","pending"]
10356
10403
  */
10357
10404
  "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
10405
+ /**
10406
+ * Filter subscriptions by billing entity codes.
10407
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10408
+ */
10409
+ "billing_entity_codes[]"?: string[];
10358
10410
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
10359
10411
  /**
10360
10412
  * @description This endpoint is used to create a wallet with prepaid credits.
@@ -10386,6 +10438,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10386
10438
  * @example 20
10387
10439
  */
10388
10440
  per_page?: number;
10441
+ /**
10442
+ * Filter wallets by billing entity codes.
10443
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10444
+ */
10445
+ "billing_entity_codes[]"?: string[];
10389
10446
  }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
10390
10447
  /**
10391
10448
  * @description This endpoint is used to update an existing wallet with prepaid credits.
@@ -11250,6 +11307,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11250
11307
  * @example "pending"
11251
11308
  */
11252
11309
  payment_status?: "pending" | "failed" | "succeeded";
11310
+ /**
11311
+ * Filter payment requests by billing entity codes.
11312
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
11313
+ */
11314
+ "billing_entity_codes[]"?: string[];
11253
11315
  }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
11254
11316
  /**
11255
11317
  * @description This endpoint retrieves a specific payment request by its ID.
@@ -11708,6 +11770,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11708
11770
  * @example ["active","pending"]
11709
11771
  */
11710
11772
  "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
11773
+ /**
11774
+ * Filter subscriptions by billing entity codes.
11775
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
11776
+ */
11777
+ "billing_entity_codes[]"?: string[];
11711
11778
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized>>;
11712
11779
  /**
11713
11780
  * @description This endpoint retrieves a specific subscription.
@@ -11973,7 +12040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11973
12040
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
11974
12041
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlement, ApiErrorUnauthorized | ApiErrorBadRequest | ApiErrorNotFound>>;
11975
12042
  /**
11976
- * @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
12043
+ * @description This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
11977
12044
  *
11978
12045
  * @tags subscriptions
11979
12046
  * @name FindAllSubscriptionFixedCharges
@@ -12156,7 +12223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12156
12223
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
12157
12224
  }, params?: RequestParams) => Promise<HttpResponse<ChargeFilterResponse, ApiErrorUnauthorized | ApiErrorNotFound>>;
12158
12225
  /**
12159
- * @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
12226
+ * @description This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
12160
12227
  *
12161
12228
  * @tags subscriptions
12162
12229
  * @name FindSubscriptionFixedCharge
@@ -12173,7 +12240,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12173
12240
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
12174
12241
  }, params?: RequestParams) => Promise<HttpResponse<FixedCharge, ApiErrorUnauthorized | ApiErrorNotFound>>;
12175
12242
  /**
12176
- * @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
12243
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead. With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period. This is a premium feature.
12177
12244
  *
12178
12245
  * @tags subscriptions
12179
12246
  * @name OverrideSubscriptionFixedCharge
@@ -12289,6 +12356,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12289
12356
  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
12290
12357
  */
12291
12358
  external_customer_id: string;
12359
+ /**
12360
+ * Filter wallets by billing entity codes.
12361
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
12362
+ */
12363
+ "billing_entity_codes[]"?: string[];
12292
12364
  }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden>>;
12293
12365
  /**
12294
12366
  * @description This endpoint is used to update an existing wallet with prepaid credits.
@@ -148,7 +148,7 @@ export class HttpClient {
148
148
  }
149
149
  /**
150
150
  * @title Lago API documentation
151
- * @version 1.48.0
151
+ * @version 1.49.0
152
152
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
153
153
  * @baseUrl https://api.getlago.com/api/v1
154
154
  * @externalDocs https://github.com/getlago
@@ -2970,7 +2970,7 @@ export class Api extends HttpClient {
2970
2970
  ...params,
2971
2971
  }),
2972
2972
  /**
2973
- * @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
2973
+ * @description This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2974
2974
  *
2975
2975
  * @tags subscriptions
2976
2976
  * @name FindAllSubscriptionFixedCharges
@@ -3129,7 +3129,7 @@ export class Api extends HttpClient {
3129
3129
  ...params,
3130
3130
  }),
3131
3131
  /**
3132
- * @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
3132
+ * @description This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
3133
3133
  *
3134
3134
  * @tags subscriptions
3135
3135
  * @name FindSubscriptionFixedCharge
@@ -3146,7 +3146,7 @@ export class Api extends HttpClient {
3146
3146
  ...params,
3147
3147
  }),
3148
3148
  /**
3149
- * @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
3149
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead. With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period. This is a premium feature.
3150
3150
  *
3151
3151
  * @tags subscriptions
3152
3152
  * @name OverrideSubscriptionFixedCharge
@@ -2447,7 +2447,7 @@ export interface paths {
2447
2447
  /**
2448
2448
  * List all fixed charges for a subscription
2449
2449
  * @description This endpoint retrieves all effective fixed charges for a specific subscription.
2450
- * If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
2450
+ * The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2451
2451
  */
2452
2452
  get: operations["findAllSubscriptionFixedCharges"];
2453
2453
  put?: never;
@@ -2594,14 +2594,14 @@ export interface paths {
2594
2594
  /**
2595
2595
  * Retrieve a fixed charge for a subscription
2596
2596
  * @description This endpoint retrieves a specific effective fixed charge for a subscription.
2597
- * If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
2597
+ * The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2598
2598
  */
2599
2599
  get: operations["findSubscriptionFixedCharge"];
2600
2600
  /**
2601
2601
  * Override a fixed charge for a subscription
2602
- * @description This endpoint creates or updates a fixed charge override for a specific subscription.
2603
- * If the subscription does not have a plan override yet, one will be created automatically.
2604
- * The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge.
2602
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge.
2603
+ * When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead.
2604
+ * With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period.
2605
2605
  * This is a premium feature.
2606
2606
  */
2607
2607
  put: operations["overrideSubscriptionFixedCharge"];
@@ -8198,6 +8198,11 @@ export interface components {
8198
8198
  * @example 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba
8199
8199
  */
8200
8200
  external_customer_id: string;
8201
+ /**
8202
+ * @description The code of the billing entity associated with the subscription.
8203
+ * @example default
8204
+ */
8205
+ billing_entity_code?: string;
8201
8206
  /**
8202
8207
  * @description The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
8203
8208
  * @example anniversary
@@ -8394,6 +8399,11 @@ export interface components {
8394
8399
  * @example 10.0
8395
8400
  */
8396
8401
  granted_credits: string;
8402
+ /**
8403
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8404
+ * @example false
8405
+ */
8406
+ grants_target_top_up: boolean | null;
8397
8407
  /**
8398
8408
  * Format: date-time
8399
8409
  * @description The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
@@ -8474,6 +8484,11 @@ export interface components {
8474
8484
  * @example hooli_1234
8475
8485
  */
8476
8486
  external_customer_id: string;
8487
+ /**
8488
+ * @description The code of the billing entity associated with the wallet.
8489
+ * @example default
8490
+ */
8491
+ billing_entity_code?: string;
8477
8492
  /**
8478
8493
  * @description The status of the wallet. Possible values are `active` or `terminated`.
8479
8494
  * @example active
@@ -8671,6 +8686,11 @@ export interface components {
8671
8686
  * @example hooli_1234
8672
8687
  */
8673
8688
  external_customer_id: string;
8689
+ /**
8690
+ * @description The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.
8691
+ * @example default
8692
+ */
8693
+ billing_entity_code?: string;
8674
8694
  /**
8675
8695
  * Format: date-time
8676
8696
  * @description The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
@@ -8749,6 +8769,11 @@ export interface components {
8749
8769
  * @example 10.0
8750
8770
  */
8751
8771
  granted_credits?: string | null;
8772
+ /**
8773
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8774
+ * @example false
8775
+ */
8776
+ grants_target_top_up?: boolean | null;
8752
8777
  /**
8753
8778
  * @description The method used for recurring top-up. Possible values are `fixed` or `target`.
8754
8779
  * @example target
@@ -8863,6 +8888,11 @@ export interface components {
8863
8888
  * @example false
8864
8889
  */
8865
8890
  invoice_requires_successful_payment?: boolean;
8891
+ /**
8892
+ * @description The code of the billing entity associated with the wallet.
8893
+ * @example default
8894
+ */
8895
+ billing_entity_code?: string;
8866
8896
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
8867
8897
  /** @description List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
8868
8898
  recurring_transaction_rules?: {
@@ -8905,6 +8935,11 @@ export interface components {
8905
8935
  * @example 10.0
8906
8936
  */
8907
8937
  granted_credits?: string | null;
8938
+ /**
8939
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8940
+ * @example false
8941
+ */
8942
+ grants_target_top_up?: boolean | null;
8908
8943
  /**
8909
8944
  * Format: date-time
8910
8945
  * @description The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
@@ -10060,6 +10095,11 @@ export interface components {
10060
10095
  * @example hooli_1234
10061
10096
  */
10062
10097
  external_customer_id: string;
10098
+ /**
10099
+ * @description The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.
10100
+ * @example default
10101
+ */
10102
+ billing_entity_code?: string;
10063
10103
  /**
10064
10104
  * @description The currency of the invoice.
10065
10105
  * @example EUR
@@ -11180,6 +11220,8 @@ export interface components {
11180
11220
  properties: components["schemas"]["FixedChargeProperties"];
11181
11221
  /**
11182
11222
  * @description The number of units for the fixed charge.
11223
+ *
11224
+ * When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units.
11183
11225
  * @example 1
11184
11226
  */
11185
11227
  units: number;
@@ -12799,7 +12841,7 @@ export interface components {
12799
12841
  conversion_rate?: string;
12800
12842
  };
12801
12843
  }[];
12802
- /** @description Additional fixed charges for this plan. */
12844
+ /** @description Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead. */
12803
12845
  fixed_charges?: {
12804
12846
  /**
12805
12847
  * Format: uuid
@@ -12898,6 +12940,7 @@ export interface components {
12898
12940
  * @example 2022-08-08T00:00:00Z
12899
12941
  */
12900
12942
  subscription_at?: string;
12943
+ /** @description Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
12901
12944
  plan_overrides?: components["schemas"]["PlanOverridesObject"];
12902
12945
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
12903
12946
  /** @description Optional payment method to use for processing subscription payments. */
@@ -12963,6 +13006,7 @@ export interface components {
12963
13006
  * @example 2022-08-08T00:00:00Z
12964
13007
  */
12965
13008
  subscription_at?: string;
13009
+ /** @description Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
12966
13010
  plan_overrides?: components["schemas"]["PlanOverridesObject"];
12967
13011
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
12968
13012
  /** @description Optional payment method to use for processing subscription payments. */
@@ -12975,6 +13019,11 @@ export interface components {
12975
13019
  * @example false
12976
13020
  */
12977
13021
  consolidate_invoice?: boolean;
13022
+ /**
13023
+ * @description The code of the billing entity associated with the subscription. Updates take effect on future invoices only.
13024
+ * @example default
13025
+ */
13026
+ billing_entity_code?: string;
12978
13027
  };
12979
13028
  };
12980
13029
  Subscription: {
@@ -16030,6 +16079,8 @@ export interface operations {
16030
16079
  per_page?: components["parameters"]["per_page"];
16031
16080
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
16032
16081
  payment_status?: components["parameters"]["payment_status"];
16082
+ /** @description Filter payment requests by billing entity codes. */
16083
+ "billing_entity_codes[]"?: string[];
16033
16084
  };
16034
16085
  header?: never;
16035
16086
  path: {
@@ -16097,6 +16148,8 @@ export interface operations {
16097
16148
  plan_code?: string;
16098
16149
  /** @description 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`. */
16099
16150
  "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
16151
+ /** @description Filter subscriptions by billing entity codes. */
16152
+ "billing_entity_codes[]"?: string[];
16100
16153
  };
16101
16154
  header?: never;
16102
16155
  path: {
@@ -16127,6 +16180,8 @@ export interface operations {
16127
16180
  page?: components["parameters"]["page"];
16128
16181
  /** @description Number of records per page. */
16129
16182
  per_page?: components["parameters"]["per_page"];
16183
+ /** @description Filter wallets by billing entity codes. */
16184
+ "billing_entity_codes[]"?: string[];
16130
16185
  };
16131
16186
  header?: never;
16132
16187
  path: {
@@ -17642,6 +17697,8 @@ export interface operations {
17642
17697
  external_customer_id?: components["parameters"]["external_customer_id"];
17643
17698
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
17644
17699
  payment_status?: components["parameters"]["payment_status"];
17700
+ /** @description Filter payment requests by billing entity codes. */
17701
+ "billing_entity_codes[]"?: string[];
17645
17702
  };
17646
17703
  header?: never;
17647
17704
  path?: never;
@@ -18706,6 +18763,8 @@ export interface operations {
18706
18763
  plan_code?: string;
18707
18764
  /** @description 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`. */
18708
18765
  "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
18766
+ /** @description Filter subscriptions by billing entity codes. */
18767
+ "billing_entity_codes[]"?: string[];
18709
18768
  };
18710
18769
  header?: never;
18711
18770
  path?: never;
@@ -19788,6 +19847,8 @@ export interface operations {
19788
19847
  per_page?: components["parameters"]["per_page"];
19789
19848
  /** @description The customer external unique identifier (provided by your own application). */
19790
19849
  external_customer_id: string;
19850
+ /** @description Filter wallets by billing entity codes. */
19851
+ "billing_entity_codes[]"?: string[];
19791
19852
  };
19792
19853
  header?: never;
19793
19854
  path?: never;
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "main": "./script/mod.js",
4
4
  "name": "lago-javascript-client",
5
5
  "sideEffects": false,
6
- "version": "v1.48.0",
6
+ "version": "v1.49.0",
7
7
  "description": "Lago JavaScript API Client",
8
8
  "repository": {
9
9
  "type": "git",
@@ -3862,6 +3862,11 @@ export interface SubscriptionObject {
3862
3862
  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
3863
3863
  */
3864
3864
  external_customer_id: string;
3865
+ /**
3866
+ * The code of the billing entity associated with the subscription.
3867
+ * @example "default"
3868
+ */
3869
+ billing_entity_code?: string;
3865
3870
  /**
3866
3871
  * The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
3867
3872
  * @example "anniversary"
@@ -4053,6 +4058,11 @@ export interface WalletRecurringTransactionRule {
4053
4058
  * @example "10.0"
4054
4059
  */
4055
4060
  granted_credits: string;
4061
+ /**
4062
+ * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
4063
+ * @example false
4064
+ */
4065
+ grants_target_top_up: boolean | null;
4056
4066
  /**
4057
4067
  * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
4058
4068
  * @format date-time
@@ -4125,6 +4135,11 @@ export interface WalletObject {
4125
4135
  * @example "hooli_1234"
4126
4136
  */
4127
4137
  external_customer_id: string;
4138
+ /**
4139
+ * The code of the billing entity associated with the wallet.
4140
+ * @example "default"
4141
+ */
4142
+ billing_entity_code?: string;
4128
4143
  /**
4129
4144
  * The status of the wallet. Possible values are `active` or `terminated`.
4130
4145
  * @example "active"
@@ -4331,6 +4346,11 @@ export interface WalletCreateInput {
4331
4346
  * @example "hooli_1234"
4332
4347
  */
4333
4348
  external_customer_id: string;
4349
+ /**
4350
+ * The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.
4351
+ * @example "default"
4352
+ */
4353
+ billing_entity_code?: string;
4334
4354
  /**
4335
4355
  * The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
4336
4356
  * @format date-time
@@ -4423,6 +4443,11 @@ export interface WalletUpdateInput {
4423
4443
  * @example false
4424
4444
  */
4425
4445
  invoice_requires_successful_payment?: boolean;
4446
+ /**
4447
+ * The code of the billing entity associated with the wallet.
4448
+ * @example "default"
4449
+ */
4450
+ billing_entity_code?: string;
4426
4451
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
4427
4452
  invoice_custom_section?: InvoiceCustomSectionInput;
4428
4453
  /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
@@ -4466,6 +4491,11 @@ export interface WalletUpdateInput {
4466
4491
  * @example "10.0"
4467
4492
  */
4468
4493
  granted_credits?: string | null;
4494
+ /**
4495
+ * Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
4496
+ * @example false
4497
+ */
4498
+ grants_target_top_up?: boolean | null;
4469
4499
  /**
4470
4500
  * The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
4471
4501
  * @format date-time
@@ -5608,6 +5638,11 @@ export interface InvoiceOneOffCreateInput {
5608
5638
  * @example "hooli_1234"
5609
5639
  */
5610
5640
  external_customer_id: string;
5641
+ /**
5642
+ * The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.
5643
+ * @example "default"
5644
+ */
5645
+ billing_entity_code?: string;
5611
5646
  /**
5612
5647
  * The currency of the invoice.
5613
5648
  * @example "EUR"
@@ -6725,6 +6760,8 @@ export interface FixedChargeObject {
6725
6760
  properties: FixedChargeProperties;
6726
6761
  /**
6727
6762
  * The number of units for the fixed charge.
6763
+ *
6764
+ * When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units.
6728
6765
  * @example 1
6729
6766
  */
6730
6767
  units: number;
@@ -7776,7 +7813,7 @@ export interface PlanOverridesObject {
7776
7813
  conversion_rate?: string;
7777
7814
  };
7778
7815
  }[];
7779
- /** Additional fixed charges for this plan. */
7816
+ /** Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead. */
7780
7817
  fixed_charges?: {
7781
7818
  /**
7782
7819
  * Unique identifier of the fixed charge created by Lago.
@@ -7875,7 +7912,7 @@ export interface SubscriptionCreateInput {
7875
7912
  * @example "2022-08-08T00:00:00Z"
7876
7913
  */
7877
7914
  subscription_at?: string;
7878
- /** Based plan overrides. */
7915
+ /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
7879
7916
  plan_overrides?: PlanOverridesObject;
7880
7917
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
7881
7918
  invoice_custom_section?: InvoiceCustomSectionInput;
@@ -7941,7 +7978,7 @@ export interface SubscriptionUpdateInput {
7941
7978
  * @example "2022-08-08T00:00:00Z"
7942
7979
  */
7943
7980
  subscription_at?: string;
7944
- /** Based plan overrides. */
7981
+ /** Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
7945
7982
  plan_overrides?: PlanOverridesObject;
7946
7983
  /** Configuration for invoice custom sections to apply to invoices generated by this resource. */
7947
7984
  invoice_custom_section?: InvoiceCustomSectionInput;
@@ -7955,6 +7992,11 @@ export interface SubscriptionUpdateInput {
7955
7992
  * @example false
7956
7993
  */
7957
7994
  consolidate_invoice?: boolean;
7995
+ /**
7996
+ * The code of the billing entity associated with the subscription. Updates take effect on future invoices only.
7997
+ * @example "default"
7998
+ */
7999
+ billing_entity_code?: string;
7958
8000
  };
7959
8001
  }
7960
8002
  export interface Subscription {
@@ -9093,7 +9135,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
9093
9135
  }
9094
9136
  /**
9095
9137
  * @title Lago API documentation
9096
- * @version 1.48.0
9138
+ * @version 1.49.0
9097
9139
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
9098
9140
  * @baseUrl https://api.getlago.com/api/v1
9099
9141
  * @externalDocs https://github.com/getlago
@@ -10306,6 +10348,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10306
10348
  * @example "pending"
10307
10349
  */
10308
10350
  payment_status?: "pending" | "failed" | "succeeded";
10351
+ /**
10352
+ * Filter payment requests by billing entity codes.
10353
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10354
+ */
10355
+ "billing_entity_codes[]"?: string[];
10309
10356
  }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
10310
10357
  /**
10311
10358
  * @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
@@ -10355,6 +10402,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10355
10402
  * @example ["active","pending"]
10356
10403
  */
10357
10404
  "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
10405
+ /**
10406
+ * Filter subscriptions by billing entity codes.
10407
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10408
+ */
10409
+ "billing_entity_codes[]"?: string[];
10358
10410
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
10359
10411
  /**
10360
10412
  * @description This endpoint is used to create a wallet with prepaid credits.
@@ -10386,6 +10438,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10386
10438
  * @example 20
10387
10439
  */
10388
10440
  per_page?: number;
10441
+ /**
10442
+ * Filter wallets by billing entity codes.
10443
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
10444
+ */
10445
+ "billing_entity_codes[]"?: string[];
10389
10446
  }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden | ApiErrorNotFound>>;
10390
10447
  /**
10391
10448
  * @description This endpoint is used to update an existing wallet with prepaid credits.
@@ -11250,6 +11307,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11250
11307
  * @example "pending"
11251
11308
  */
11252
11309
  payment_status?: "pending" | "failed" | "succeeded";
11310
+ /**
11311
+ * Filter payment requests by billing entity codes.
11312
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
11313
+ */
11314
+ "billing_entity_codes[]"?: string[];
11253
11315
  }, params?: RequestParams) => Promise<HttpResponse<PaymentRequestsPaginated, ApiErrorUnauthorized>>;
11254
11316
  /**
11255
11317
  * @description This endpoint retrieves a specific payment request by its ID.
@@ -11708,6 +11770,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11708
11770
  * @example ["active","pending"]
11709
11771
  */
11710
11772
  "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
11773
+ /**
11774
+ * Filter subscriptions by billing entity codes.
11775
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
11776
+ */
11777
+ "billing_entity_codes[]"?: string[];
11711
11778
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized>>;
11712
11779
  /**
11713
11780
  * @description This endpoint retrieves a specific subscription.
@@ -11973,7 +12040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11973
12040
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
11974
12041
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionEntitlement, ApiErrorUnauthorized | ApiErrorBadRequest | ApiErrorNotFound>>;
11975
12042
  /**
11976
- * @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
12043
+ * @description This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
11977
12044
  *
11978
12045
  * @tags subscriptions
11979
12046
  * @name FindAllSubscriptionFixedCharges
@@ -12156,7 +12223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12156
12223
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
12157
12224
  }, params?: RequestParams) => Promise<HttpResponse<ChargeFilterResponse, ApiErrorUnauthorized | ApiErrorNotFound>>;
12158
12225
  /**
12159
- * @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
12226
+ * @description This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
12160
12227
  *
12161
12228
  * @tags subscriptions
12162
12229
  * @name FindSubscriptionFixedCharge
@@ -12173,7 +12240,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12173
12240
  subscription_status?: "pending" | "active" | "terminated" | "canceled";
12174
12241
  }, params?: RequestParams) => Promise<HttpResponse<FixedCharge, ApiErrorUnauthorized | ApiErrorNotFound>>;
12175
12242
  /**
12176
- * @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
12243
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead. With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period. This is a premium feature.
12177
12244
  *
12178
12245
  * @tags subscriptions
12179
12246
  * @name OverrideSubscriptionFixedCharge
@@ -12289,6 +12356,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12289
12356
  * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
12290
12357
  */
12291
12358
  external_customer_id: string;
12359
+ /**
12360
+ * Filter wallets by billing entity codes.
12361
+ * @example ["billing_entity_code_1","billing_entity_code_2"]
12362
+ */
12363
+ "billing_entity_codes[]"?: string[];
12292
12364
  }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiErrorUnauthorized | ApiErrorForbidden>>;
12293
12365
  /**
12294
12366
  * @description This endpoint is used to update an existing wallet with prepaid credits.
@@ -152,7 +152,7 @@ class HttpClient {
152
152
  exports.HttpClient = HttpClient;
153
153
  /**
154
154
  * @title Lago API documentation
155
- * @version 1.48.0
155
+ * @version 1.49.0
156
156
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
157
157
  * @baseUrl https://api.getlago.com/api/v1
158
158
  * @externalDocs https://github.com/getlago
@@ -2974,7 +2974,7 @@ class Api extends HttpClient {
2974
2974
  ...params,
2975
2975
  }),
2976
2976
  /**
2977
- * @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
2977
+ * @description This endpoint retrieves all effective fixed charges for a specific subscription. The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2978
2978
  *
2979
2979
  * @tags subscriptions
2980
2980
  * @name FindAllSubscriptionFixedCharges
@@ -3133,7 +3133,7 @@ class Api extends HttpClient {
3133
3133
  ...params,
3134
3134
  }),
3135
3135
  /**
3136
- * @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
3136
+ * @description This endpoint retrieves a specific effective fixed charge for a subscription. The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
3137
3137
  *
3138
3138
  * @tags subscriptions
3139
3139
  * @name FindSubscriptionFixedCharge
@@ -3150,7 +3150,7 @@ class Api extends HttpClient {
3150
3150
  ...params,
3151
3151
  }),
3152
3152
  /**
3153
- * @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
3153
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge. When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead. With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period. This is a premium feature.
3154
3154
  *
3155
3155
  * @tags subscriptions
3156
3156
  * @name OverrideSubscriptionFixedCharge
@@ -2447,7 +2447,7 @@ export interface paths {
2447
2447
  /**
2448
2448
  * List all fixed charges for a subscription
2449
2449
  * @description This endpoint retrieves all effective fixed charges for a specific subscription.
2450
- * If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
2450
+ * The `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2451
2451
  */
2452
2452
  get: operations["findAllSubscriptionFixedCharges"];
2453
2453
  put?: never;
@@ -2594,14 +2594,14 @@ export interface paths {
2594
2594
  /**
2595
2595
  * Retrieve a fixed charge for a subscription
2596
2596
  * @description This endpoint retrieves a specific effective fixed charge for a subscription.
2597
- * If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
2597
+ * The `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.
2598
2598
  */
2599
2599
  get: operations["findSubscriptionFixedCharge"];
2600
2600
  /**
2601
2601
  * Override a fixed charge for a subscription
2602
- * @description This endpoint creates or updates a fixed charge override for a specific subscription.
2603
- * If the subscription does not have a plan override yet, one will be created automatically.
2604
- * The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge.
2602
+ * @description This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge.
2603
+ * When the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead.
2604
+ * With `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period.
2605
2605
  * This is a premium feature.
2606
2606
  */
2607
2607
  put: operations["overrideSubscriptionFixedCharge"];
@@ -8198,6 +8198,11 @@ export interface components {
8198
8198
  * @example 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba
8199
8199
  */
8200
8200
  external_customer_id: string;
8201
+ /**
8202
+ * @description The code of the billing entity associated with the subscription.
8203
+ * @example default
8204
+ */
8205
+ billing_entity_code?: string;
8201
8206
  /**
8202
8207
  * @description The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
8203
8208
  * @example anniversary
@@ -8394,6 +8399,11 @@ export interface components {
8394
8399
  * @example 10.0
8395
8400
  */
8396
8401
  granted_credits: string;
8402
+ /**
8403
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8404
+ * @example false
8405
+ */
8406
+ grants_target_top_up: boolean | null;
8397
8407
  /**
8398
8408
  * Format: date-time
8399
8409
  * @description The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
@@ -8474,6 +8484,11 @@ export interface components {
8474
8484
  * @example hooli_1234
8475
8485
  */
8476
8486
  external_customer_id: string;
8487
+ /**
8488
+ * @description The code of the billing entity associated with the wallet.
8489
+ * @example default
8490
+ */
8491
+ billing_entity_code?: string;
8477
8492
  /**
8478
8493
  * @description The status of the wallet. Possible values are `active` or `terminated`.
8479
8494
  * @example active
@@ -8671,6 +8686,11 @@ export interface components {
8671
8686
  * @example hooli_1234
8672
8687
  */
8673
8688
  external_customer_id: string;
8689
+ /**
8690
+ * @description The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.
8691
+ * @example default
8692
+ */
8693
+ billing_entity_code?: string;
8674
8694
  /**
8675
8695
  * Format: date-time
8676
8696
  * @description The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
@@ -8749,6 +8769,11 @@ export interface components {
8749
8769
  * @example 10.0
8750
8770
  */
8751
8771
  granted_credits?: string | null;
8772
+ /**
8773
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8774
+ * @example false
8775
+ */
8776
+ grants_target_top_up?: boolean | null;
8752
8777
  /**
8753
8778
  * @description The method used for recurring top-up. Possible values are `fixed` or `target`.
8754
8779
  * @example target
@@ -8863,6 +8888,11 @@ export interface components {
8863
8888
  * @example false
8864
8889
  */
8865
8890
  invoice_requires_successful_payment?: boolean;
8891
+ /**
8892
+ * @description The code of the billing entity associated with the wallet.
8893
+ * @example default
8894
+ */
8895
+ billing_entity_code?: string;
8866
8896
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
8867
8897
  /** @description List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
8868
8898
  recurring_transaction_rules?: {
@@ -8905,6 +8935,11 @@ export interface components {
8905
8935
  * @example 10.0
8906
8936
  */
8907
8937
  granted_credits?: string | null;
8938
+ /**
8939
+ * @description Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted.
8940
+ * @example false
8941
+ */
8942
+ grants_target_top_up?: boolean | null;
8908
8943
  /**
8909
8944
  * Format: date-time
8910
8945
  * @description The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
@@ -10060,6 +10095,11 @@ export interface components {
10060
10095
  * @example hooli_1234
10061
10096
  */
10062
10097
  external_customer_id: string;
10098
+ /**
10099
+ * @description The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.
10100
+ * @example default
10101
+ */
10102
+ billing_entity_code?: string;
10063
10103
  /**
10064
10104
  * @description The currency of the invoice.
10065
10105
  * @example EUR
@@ -11180,6 +11220,8 @@ export interface components {
11180
11220
  properties: components["schemas"]["FixedChargeProperties"];
11181
11221
  /**
11182
11222
  * @description The number of units for the fixed charge.
11223
+ *
11224
+ * When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units.
11183
11225
  * @example 1
11184
11226
  */
11185
11227
  units: number;
@@ -12799,7 +12841,7 @@ export interface components {
12799
12841
  conversion_rate?: string;
12800
12842
  };
12801
12843
  }[];
12802
- /** @description Additional fixed charges for this plan. */
12844
+ /** @description Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead. */
12803
12845
  fixed_charges?: {
12804
12846
  /**
12805
12847
  * Format: uuid
@@ -12898,6 +12940,7 @@ export interface components {
12898
12940
  * @example 2022-08-08T00:00:00Z
12899
12941
  */
12900
12942
  subscription_at?: string;
12943
+ /** @description Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
12901
12944
  plan_overrides?: components["schemas"]["PlanOverridesObject"];
12902
12945
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
12903
12946
  /** @description Optional payment method to use for processing subscription payments. */
@@ -12963,6 +13006,7 @@ export interface components {
12963
13006
  * @example 2022-08-08T00:00:00Z
12964
13007
  */
12965
13008
  subscription_at?: string;
13009
+ /** @description Overrides applied to the plan for this subscription. A units-only `fixed_charges` override is recorded as a per-subscription unit override without creating a plan override; any other override creates a plan override for the subscription. See `fixed_charges` for the exact rule. */
12966
13010
  plan_overrides?: components["schemas"]["PlanOverridesObject"];
12967
13011
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
12968
13012
  /** @description Optional payment method to use for processing subscription payments. */
@@ -12975,6 +13019,11 @@ export interface components {
12975
13019
  * @example false
12976
13020
  */
12977
13021
  consolidate_invoice?: boolean;
13022
+ /**
13023
+ * @description The code of the billing entity associated with the subscription. Updates take effect on future invoices only.
13024
+ * @example default
13025
+ */
13026
+ billing_entity_code?: string;
12978
13027
  };
12979
13028
  };
12980
13029
  Subscription: {
@@ -16030,6 +16079,8 @@ export interface operations {
16030
16079
  per_page?: components["parameters"]["per_page"];
16031
16080
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
16032
16081
  payment_status?: components["parameters"]["payment_status"];
16082
+ /** @description Filter payment requests by billing entity codes. */
16083
+ "billing_entity_codes[]"?: string[];
16033
16084
  };
16034
16085
  header?: never;
16035
16086
  path: {
@@ -16097,6 +16148,8 @@ export interface operations {
16097
16148
  plan_code?: string;
16098
16149
  /** @description 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`. */
16099
16150
  "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
16151
+ /** @description Filter subscriptions by billing entity codes. */
16152
+ "billing_entity_codes[]"?: string[];
16100
16153
  };
16101
16154
  header?: never;
16102
16155
  path: {
@@ -16127,6 +16180,8 @@ export interface operations {
16127
16180
  page?: components["parameters"]["page"];
16128
16181
  /** @description Number of records per page. */
16129
16182
  per_page?: components["parameters"]["per_page"];
16183
+ /** @description Filter wallets by billing entity codes. */
16184
+ "billing_entity_codes[]"?: string[];
16130
16185
  };
16131
16186
  header?: never;
16132
16187
  path: {
@@ -17642,6 +17697,8 @@ export interface operations {
17642
17697
  external_customer_id?: components["parameters"]["external_customer_id"];
17643
17698
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
17644
17699
  payment_status?: components["parameters"]["payment_status"];
17700
+ /** @description Filter payment requests by billing entity codes. */
17701
+ "billing_entity_codes[]"?: string[];
17645
17702
  };
17646
17703
  header?: never;
17647
17704
  path?: never;
@@ -18706,6 +18763,8 @@ export interface operations {
18706
18763
  plan_code?: string;
18707
18764
  /** @description 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`. */
18708
18765
  "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
18766
+ /** @description Filter subscriptions by billing entity codes. */
18767
+ "billing_entity_codes[]"?: string[];
18709
18768
  };
18710
18769
  header?: never;
18711
18770
  path?: never;
@@ -19788,6 +19847,8 @@ export interface operations {
19788
19847
  per_page?: components["parameters"]["per_page"];
19789
19848
  /** @description The customer external unique identifier (provided by your own application). */
19790
19849
  external_customer_id: string;
19850
+ /** @description Filter wallets by billing entity codes. */
19851
+ "billing_entity_codes[]"?: string[];
19791
19852
  };
19792
19853
  header?: never;
19793
19854
  path?: never;