lago-javascript-client 1.52.1 → 1.54.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.
@@ -32,7 +32,7 @@ export interface paths {
32
32
  query?: never;
33
33
  header?: never;
34
34
  path: {
35
- /** @description The ID of the billing entity */
35
+ /** @description The unique code of the billing entity */
36
36
  code: string;
37
37
  };
38
38
  cookie?: never;
@@ -969,7 +969,7 @@ export interface paths {
969
969
  get: operations["findCustomerWallet"];
970
970
  /**
971
971
  * Update a wallet
972
- * @description This endpoint is used to update an existing wallet with prepaid credits.
972
+ * @description This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.
973
973
  */
974
974
  put: operations["updateCustomerWallet"];
975
975
  post?: never;
@@ -1226,7 +1226,7 @@ export interface paths {
1226
1226
  get?: never;
1227
1227
  /**
1228
1228
  * Set the payment method as default
1229
- * @description Use the payment method as default when not selected a payment method
1229
+ * @description This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.
1230
1230
  */
1231
1231
  put: operations["paymentMethodSetAsDefault"];
1232
1232
  post?: never;
@@ -1401,7 +1401,7 @@ export interface paths {
1401
1401
  };
1402
1402
  /**
1403
1403
  * List all fees
1404
- * @description This endpoint is used for retrieving all fees that has been issued.
1404
+ * @description This endpoint is used for retrieving all fees that have been issued.
1405
1405
  */
1406
1406
  get: operations["findAllFees"];
1407
1407
  put?: never;
@@ -1484,7 +1484,7 @@ export interface paths {
1484
1484
  get: operations["findInvoice"];
1485
1485
  /**
1486
1486
  * Update an invoice
1487
- * @description This endpoint is used for updating an existing invoice.
1487
+ * @description This endpoint is used for updating an existing invoice. A voided invoice cannot be updated and returns a `405` error.
1488
1488
  */
1489
1489
  put: operations["updateInvoice"];
1490
1490
  post?: never;
@@ -1859,7 +1859,11 @@ export interface paths {
1859
1859
  path?: never;
1860
1860
  cookie?: never;
1861
1861
  };
1862
- get?: never;
1862
+ /**
1863
+ * Retrieve your organization
1864
+ * @description This endpoint retrieves your own organization's settings.
1865
+ */
1866
+ get: operations["findOrganization"];
1863
1867
  /**
1864
1868
  * Update your organization
1865
1869
  * @description This endpoint is used to update your own organization's settings.
@@ -1897,7 +1901,7 @@ export interface paths {
1897
1901
  query?: never;
1898
1902
  header?: never;
1899
1903
  path: {
1900
- /** @description Payment receipt ID */
1904
+ /** @description Unique identifier of the payment receipt. */
1901
1905
  lago_id: string;
1902
1906
  };
1903
1907
  cookie?: never;
@@ -3058,7 +3062,7 @@ export interface paths {
3058
3062
  get: operations["findWallet"];
3059
3063
  /**
3060
3064
  * Update a wallet
3061
- * @description This endpoint is used to update an existing wallet with prepaid credits.
3065
+ * @description This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.
3062
3066
  */
3063
3067
  put: operations["updateWallet"];
3064
3068
  post?: never;
@@ -3915,7 +3919,8 @@ export interface webhooks {
3915
3919
  put?: never;
3916
3920
  /**
3917
3921
  * A new add on invoice has been emitted
3918
- * @description A new add on invoice has been emitted
3922
+ * @deprecated
3923
+ * @description **Deprecated.** This webhook is no longer emitted by Lago. Use `invoice.one_off_created` for invoices created from add-ons.
3919
3924
  */
3920
3925
  post: operations["invoiceAddOnAdded"];
3921
3926
  delete?: never;
@@ -4353,6 +4358,46 @@ export interface webhooks {
4353
4358
  patch?: never;
4354
4359
  trace?: never;
4355
4360
  };
4361
+ payment_receipt_created: {
4362
+ parameters: {
4363
+ query?: never;
4364
+ header?: never;
4365
+ path?: never;
4366
+ cookie?: never;
4367
+ };
4368
+ get?: never;
4369
+ put?: never;
4370
+ /**
4371
+ * A new payment receipt has been created
4372
+ * @description A new payment receipt has been created
4373
+ */
4374
+ post: operations["paymentReceiptCreated"];
4375
+ delete?: never;
4376
+ options?: never;
4377
+ head?: never;
4378
+ patch?: never;
4379
+ trace?: never;
4380
+ };
4381
+ payment_receipt_generated: {
4382
+ parameters: {
4383
+ query?: never;
4384
+ header?: never;
4385
+ path?: never;
4386
+ cookie?: never;
4387
+ };
4388
+ get?: never;
4389
+ put?: never;
4390
+ /**
4391
+ * The PDF of a payment receipt has been generated
4392
+ * @description The PDF of a payment receipt has been generated
4393
+ */
4394
+ post: operations["paymentReceiptGenerated"];
4395
+ delete?: never;
4396
+ options?: never;
4397
+ head?: never;
4398
+ patch?: never;
4399
+ trace?: never;
4400
+ };
4356
4401
  payment_request_created: {
4357
4402
  parameters: {
4358
4403
  query?: never;
@@ -4696,6 +4741,66 @@ export interface webhooks {
4696
4741
  patch?: never;
4697
4742
  trace?: never;
4698
4743
  };
4744
+ wallet_created: {
4745
+ parameters: {
4746
+ query?: never;
4747
+ header?: never;
4748
+ path?: never;
4749
+ cookie?: never;
4750
+ };
4751
+ get?: never;
4752
+ put?: never;
4753
+ /**
4754
+ * A new wallet has been created
4755
+ * @description A new wallet has been created
4756
+ */
4757
+ post: operations["walletCreated"];
4758
+ delete?: never;
4759
+ options?: never;
4760
+ head?: never;
4761
+ patch?: never;
4762
+ trace?: never;
4763
+ };
4764
+ wallet_updated: {
4765
+ parameters: {
4766
+ query?: never;
4767
+ header?: never;
4768
+ path?: never;
4769
+ cookie?: never;
4770
+ };
4771
+ get?: never;
4772
+ put?: never;
4773
+ /**
4774
+ * A wallet has been updated
4775
+ * @description A wallet has been updated
4776
+ */
4777
+ post: operations["walletUpdated"];
4778
+ delete?: never;
4779
+ options?: never;
4780
+ head?: never;
4781
+ patch?: never;
4782
+ trace?: never;
4783
+ };
4784
+ wallet_terminated: {
4785
+ parameters: {
4786
+ query?: never;
4787
+ header?: never;
4788
+ path?: never;
4789
+ cookie?: never;
4790
+ };
4791
+ get?: never;
4792
+ put?: never;
4793
+ /**
4794
+ * A wallet has been terminated
4795
+ * @description A wallet has been terminated
4796
+ */
4797
+ post: operations["walletTerminated"];
4798
+ delete?: never;
4799
+ options?: never;
4800
+ head?: never;
4801
+ patch?: never;
4802
+ trace?: never;
4803
+ };
4699
4804
  wallet_depleted_ongoing_balance: {
4700
4805
  parameters: {
4701
4806
  query?: never;
@@ -4783,12 +4888,12 @@ export interface components {
4783
4888
  * @example USD
4784
4889
  * @enum {string}
4785
4890
  */
4786
- Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
4891
+ Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
4787
4892
  /**
4788
4893
  * @example US
4789
- * @enum {string}
4894
+ * @enum {string|null}
4790
4895
  */
4791
- Country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
4896
+ CountryOrNull: null | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
4792
4897
  /**
4793
4898
  * @example America/Los_Angeles
4794
4899
  * @enum {string}
@@ -4863,7 +4968,7 @@ export interface components {
4863
4968
  */
4864
4969
  subscription_invoice_issuing_date_adjustment: "align_with_finalization_date" | "keep_anchor";
4865
4970
  /**
4866
- * @description Whether this billing entity is the default billing entity for the organization. Default billing entity will be used as fallback in services if no billing entity is specified when billing_entity is not provided. Default billing entity is the billing entity that will be used to generate invoices if no billing entity is specified when invoice is created. is the oldest active billing entity and this flag cannot be changed
4971
+ * @description Whether this billing entity is the organization's default billing entity. The default billing entity is the oldest active one, and is used as a fallback whenever no billing entity is provided, for example when an invoice is created. This flag cannot be changed.
4867
4972
  * @example false
4868
4973
  */
4869
4974
  is_default?: boolean;
@@ -4882,6 +4987,11 @@ export interface components {
4882
4987
  * @example Suite 100
4883
4988
  */
4884
4989
  address_line2?: string | null;
4990
+ /**
4991
+ * @description The phone number of the billing entity
4992
+ * @example 1-171-883-3711 x245
4993
+ */
4994
+ phone?: string | null;
4885
4995
  /**
4886
4996
  * @description The city of the billing address
4887
4997
  * @example Woodland Hills
@@ -4893,7 +5003,7 @@ export interface components {
4893
5003
  */
4894
5004
  state?: string | null;
4895
5005
  /** @description The country code of the billing address */
4896
- country?: components["schemas"]["Country"];
5006
+ country?: components["schemas"]["CountryOrNull"];
4897
5007
  /**
4898
5008
  * @description The zipcode of the billing address
4899
5009
  * @example 91364
@@ -4932,6 +5042,11 @@ export interface components {
4932
5042
  * @example false
4933
5043
  */
4934
5044
  eu_tax_management?: boolean;
5045
+ /**
5046
+ * @description Whether e-invoicing is enabled for this billing entity
5047
+ * @example false
5048
+ */
5049
+ einvoicing?: boolean;
4935
5050
  /**
4936
5051
  * Format: uri
4937
5052
  * @description The URL of the billing entity's logo
@@ -5051,6 +5166,11 @@ export interface components {
5051
5166
  * @example Suite 100
5052
5167
  */
5053
5168
  address_line2?: string | null;
5169
+ /**
5170
+ * @description The phone number of the billing entity
5171
+ * @example 1-171-883-3711 x245
5172
+ */
5173
+ phone?: string | null;
5054
5174
  /**
5055
5175
  * @description The city of the billing address
5056
5176
  * @example Woodland Hills
@@ -5062,7 +5182,7 @@ export interface components {
5062
5182
  */
5063
5183
  state?: string | null;
5064
5184
  /** @description The country code of the billing address */
5065
- country?: components["schemas"]["Country"];
5185
+ country?: components["schemas"]["CountryOrNull"];
5066
5186
  /**
5067
5187
  * @description The zipcode of the billing address
5068
5188
  * @example 91364
@@ -5095,12 +5215,17 @@ export interface components {
5095
5215
  */
5096
5216
  timezone?: components["schemas"]["Timezone"];
5097
5217
  /** @description The email notification settings for this billing entity */
5098
- email_settings?: ("invoice.finalized" | "credit_note.created")[];
5218
+ email_settings?: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
5099
5219
  /**
5100
5220
  * @description Whether EU tax management is enabled for this billing entity
5101
5221
  * @example false
5102
5222
  */
5103
5223
  eu_tax_management?: boolean;
5224
+ /**
5225
+ * @description Whether e-invoicing is enabled for this billing entity
5226
+ * @example false
5227
+ */
5228
+ einvoicing?: boolean;
5104
5229
  /**
5105
5230
  * Format: uri
5106
5231
  * @description The base64 encoded logo image for the billing entity
@@ -5162,6 +5287,14 @@ export interface components {
5162
5287
  * @example true
5163
5288
  */
5164
5289
  applied_to_organization: boolean;
5290
+ /**
5291
+ * @description The codes of the billing entities the tax is applied to, sorted alphabetically. It is empty when the tax is only attached to customers.
5292
+ * @example [
5293
+ * "acme_corp",
5294
+ * "foo_bar"
5295
+ * ]
5296
+ */
5297
+ applied_to_billing_entities_codes?: string[];
5165
5298
  /**
5166
5299
  * Format: date-time
5167
5300
  * @description Creation date of the tax.
@@ -5244,143 +5377,155 @@ export interface components {
5244
5377
  TaxCodes: string[];
5245
5378
  /** @description Billing entity update input */
5246
5379
  BillingEntityUpdateInput: {
5247
- /**
5248
- * @description The name of the billing entity
5249
- * @example Acme Corp
5250
- */
5251
- name?: string;
5252
- /**
5253
- * @description The default currency of the billing entity
5254
- * @example USD
5255
- */
5256
- default_currency?: components["schemas"]["Currency"];
5257
- /**
5258
- * @description The type of document numbering for this billing entity:
5259
- * - `per_customer`: document numbers are unique per customer
5260
- * - `per_billing_entity`: document numbers are unique per billing entity
5261
- * @enum {string}
5262
- */
5263
- document_numbering?: "per_customer" | "per_billing_entity";
5264
- /**
5265
- * @description The prefix used in document numbers for this billing entity
5266
- * @example ABC-123
5267
- */
5268
- document_number_prefix?: string | null;
5269
- /**
5270
- * @description Whether to finalize invoices with zero amount for this billing entity
5271
- * @example true
5272
- */
5273
- finalize_zero_amount_invoice?: boolean;
5274
- billing_configuration?: {
5380
+ billing_entity: {
5381
+ /**
5382
+ * @description The name of the billing entity
5383
+ * @example Acme Corp
5384
+ */
5385
+ name?: string;
5386
+ /**
5387
+ * @description The default currency of the billing entity
5388
+ * @example USD
5389
+ */
5390
+ default_currency?: components["schemas"]["Currency"];
5391
+ /**
5392
+ * @description The type of document numbering for this billing entity:
5393
+ * - `per_customer`: document numbers are unique per customer
5394
+ * - `per_billing_entity`: document numbers are unique per billing entity
5395
+ * @enum {string}
5396
+ */
5397
+ document_numbering?: "per_customer" | "per_billing_entity";
5275
5398
  /**
5276
- * @description The footer text to be displayed on invoices for this billing entity
5277
- * @example Thank you for your business
5399
+ * @description The prefix used in document numbers for this billing entity
5400
+ * @example ABC-123
5278
5401
  */
5279
- invoice_footer?: string;
5402
+ document_number_prefix?: string | null;
5280
5403
  /**
5281
- * @description The language of the documents generated for this billing entity
5282
- * @example en
5404
+ * @description Whether to finalize invoices with zero amount for this billing entity
5405
+ * @example true
5283
5406
  */
5284
- document_locale?: string;
5407
+ finalize_zero_amount_invoice?: boolean;
5408
+ billing_configuration?: {
5409
+ /**
5410
+ * @description The footer text to be displayed on invoices for this billing entity
5411
+ * @example Thank you for your business
5412
+ */
5413
+ invoice_footer?: string;
5414
+ /**
5415
+ * @description The language of the documents generated for this billing entity
5416
+ * @example en
5417
+ */
5418
+ document_locale?: string;
5419
+ /**
5420
+ * @description The grace period (in days) for invoice finalization
5421
+ * @example 0
5422
+ */
5423
+ invoice_grace_period?: number;
5424
+ /**
5425
+ * @description Defines whether the issuing date follows the current billing period's end date or the next period starting date.
5426
+ * @default next_period_start
5427
+ * @enum {string}
5428
+ */
5429
+ subscription_invoice_issuing_date_anchor: "current_period_end" | "next_period_start";
5430
+ /**
5431
+ * @description The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.
5432
+ * @default align_with_finalization_date
5433
+ * @enum {string}
5434
+ */
5435
+ subscription_invoice_issuing_date_adjustment: "align_with_finalization_date" | "keep_anchor";
5436
+ };
5285
5437
  /**
5286
- * @description The grace period (in days) for invoice finalization
5438
+ * @description The net payment term (in days) for this billing entity
5287
5439
  * @example 0
5288
5440
  */
5289
- invoice_grace_period?: number;
5441
+ net_payment_term?: number;
5290
5442
  /**
5291
- * @description Defines whether the issuing date follows the current billing period's end date or the next period starting date.
5292
- * @default next_period_start
5293
- * @enum {string}
5443
+ * @description The first line of the billing address
5444
+ * @example 5230 Penfield Ave
5294
5445
  */
5295
- subscription_invoice_issuing_date_anchor: "current_period_end" | "next_period_start";
5446
+ address_line1?: string | null;
5296
5447
  /**
5297
- * @description The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.
5298
- * @default align_with_finalization_date
5299
- * @enum {string}
5448
+ * @description The second line of the billing address
5449
+ * @example Suite 100
5300
5450
  */
5301
- subscription_invoice_issuing_date_adjustment: "align_with_finalization_date" | "keep_anchor";
5302
- };
5303
- /**
5304
- * @description The net payment term (in days) for this billing entity
5305
- * @example 0
5306
- */
5307
- net_payment_term?: number;
5308
- /**
5309
- * @description The first line of the billing address
5310
- * @example 5230 Penfield Ave
5311
- */
5312
- address_line1?: string | null;
5313
- /**
5314
- * @description The second line of the billing address
5315
- * @example Suite 100
5316
- */
5317
- address_line2?: string | null;
5318
- /**
5319
- * @description The city of the billing address
5320
- * @example Woodland Hills
5321
- */
5322
- city?: string | null;
5323
- /**
5324
- * @description The state of the billing address
5325
- * @example CA
5326
- */
5327
- state?: string | null;
5328
- /** @description The country code of the billing address */
5329
- country?: components["schemas"]["Country"];
5330
- /**
5331
- * @description The zipcode of the billing address
5332
- * @example 91364
5333
- */
5334
- zipcode?: string | null;
5335
- /**
5336
- * Format: email
5337
- * @description The email address of the billing entity
5338
- * @example billing@acme.com
5339
- */
5340
- email?: string | null;
5341
- /**
5342
- * @description The legal name of the billing entity
5343
- * @example Acme Corporation
5344
- */
5345
- legal_name?: string | null;
5346
- /**
5347
- * @description The legal registration number of the billing entity
5348
- * @example US123456789
5349
- */
5350
- legal_number?: string | null;
5351
- /**
5352
- * @description The tax identification number of the billing entity
5353
- * @example EU123456789
5354
- */
5355
- tax_identification_number?: string | null;
5356
- /**
5357
- * @description The timezone of the billing entity
5358
- * @example UTC
5359
- */
5360
- timezone?: components["schemas"]["Timezone"];
5361
- /** @description The tax codes that should be associated with this billing entity */
5362
- tax_codes?: components["schemas"]["TaxCodes"];
5363
- /** @description The email notification settings for this billing entity */
5364
- email_settings?: ("invoice.finalized" | "credit_note.created")[];
5365
- /**
5366
- * @description Whether EU tax management is enabled for this billing entity
5367
- * @example false
5368
- */
5369
- eu_tax_management?: boolean;
5370
- /**
5371
- * Format: uri
5372
- * @description The base64 encoded logo image for the billing entity. Sending "null" will remove the logo, if any exist.
5373
- * @example data:image/png;base64,...
5374
- */
5375
- logo?: string | null;
5376
- /**
5377
- * @description The codes of the invoice custom section that should be associated with this billing entity
5378
- * @example [
5379
- * "custom_section_1",
5380
- * "custom_section_2"
5381
- * ]
5382
- */
5383
- invoice_custom_section_codes?: string[];
5451
+ address_line2?: string | null;
5452
+ /**
5453
+ * @description The phone number of the billing entity
5454
+ * @example 1-171-883-3711 x245
5455
+ */
5456
+ phone?: string | null;
5457
+ /**
5458
+ * @description The city of the billing address
5459
+ * @example Woodland Hills
5460
+ */
5461
+ city?: string | null;
5462
+ /**
5463
+ * @description The state of the billing address
5464
+ * @example CA
5465
+ */
5466
+ state?: string | null;
5467
+ /** @description The country code of the billing address */
5468
+ country?: components["schemas"]["CountryOrNull"];
5469
+ /**
5470
+ * @description The zipcode of the billing address
5471
+ * @example 91364
5472
+ */
5473
+ zipcode?: string | null;
5474
+ /**
5475
+ * Format: email
5476
+ * @description The email address of the billing entity
5477
+ * @example billing@acme.com
5478
+ */
5479
+ email?: string | null;
5480
+ /**
5481
+ * @description The legal name of the billing entity
5482
+ * @example Acme Corporation
5483
+ */
5484
+ legal_name?: string | null;
5485
+ /**
5486
+ * @description The legal registration number of the billing entity
5487
+ * @example US123456789
5488
+ */
5489
+ legal_number?: string | null;
5490
+ /**
5491
+ * @description The tax identification number of the billing entity
5492
+ * @example EU123456789
5493
+ */
5494
+ tax_identification_number?: string | null;
5495
+ /**
5496
+ * @description The timezone of the billing entity
5497
+ * @example UTC
5498
+ */
5499
+ timezone?: components["schemas"]["Timezone"];
5500
+ /** @description The tax codes that should be associated with this billing entity */
5501
+ tax_codes?: components["schemas"]["TaxCodes"];
5502
+ /** @description The email notification settings for this billing entity */
5503
+ email_settings?: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
5504
+ /**
5505
+ * @description Whether EU tax management is enabled for this billing entity
5506
+ * @example false
5507
+ */
5508
+ eu_tax_management?: boolean;
5509
+ /**
5510
+ * @description Whether e-invoicing is enabled for this billing entity
5511
+ * @example false
5512
+ */
5513
+ einvoicing?: boolean;
5514
+ /**
5515
+ * Format: uri
5516
+ * @description The base64 encoded logo image for the billing entity. Sending "null" will remove the logo, if any exist.
5517
+ * @example data:image/png;base64,...
5518
+ */
5519
+ logo?: string | null;
5520
+ /**
5521
+ * @description The codes of the invoice custom section that should be associated with this billing entity
5522
+ * @example [
5523
+ * "custom_section_1",
5524
+ * "custom_section_2"
5525
+ * ]
5526
+ */
5527
+ invoice_custom_section_codes?: string[];
5528
+ };
5384
5529
  };
5385
5530
  ActivityLogObject: {
5386
5531
  /**
@@ -5680,6 +5825,12 @@ export interface components {
5680
5825
  * @example 10
5681
5826
  */
5682
5827
  invoices_count: number;
5828
+ /**
5829
+ * Format: uuid
5830
+ * @description Unique identifier assigned to the billing entity the revenue is attributed to, created by Lago.
5831
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
5832
+ */
5833
+ billing_entity_id: string;
5683
5834
  };
5684
5835
  GrossRevenues: {
5685
5836
  gross_revenues: components["schemas"]["GrossRevenueObject"][];
@@ -5783,10 +5934,21 @@ export interface components {
5783
5934
  * ]
5784
5935
  */
5785
5936
  lago_invoice_ids: string[];
5937
+ /**
5938
+ * Format: uuid
5939
+ * @description Unique identifier assigned to the billing entity the overdue balance is attributed to, created by Lago.
5940
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
5941
+ */
5942
+ billing_entity_id: string;
5786
5943
  };
5787
5944
  OverdueBalances: {
5788
5945
  overdue_balances: components["schemas"]["OverdueBalanceObject"][];
5789
5946
  };
5947
+ /**
5948
+ * @example US
5949
+ * @enum {string}
5950
+ */
5951
+ Country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
5790
5952
  UsageObject: {
5791
5953
  /**
5792
5954
  * Format: uuid
@@ -5839,7 +6001,7 @@ export interface components {
5839
6001
  * @example USD
5840
6002
  * @enum {string|null}
5841
6003
  */
5842
- CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
6004
+ CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
5843
6005
  AppliedCouponObject: {
5844
6006
  /**
5845
6007
  * Format: uuid
@@ -5863,6 +6025,11 @@ export interface components {
5863
6025
  * @example Startup Deal
5864
6026
  */
5865
6027
  coupon_name: string;
6028
+ /**
6029
+ * @description The description of the parent coupon.
6030
+ * @example I am a coupon description
6031
+ */
6032
+ coupon_description?: string | null;
5866
6033
  /**
5867
6034
  * @description The status of the parent coupon. Can be either `active` or `terminated`.
5868
6035
  * @example active
@@ -6983,6 +7150,12 @@ export interface components {
6983
7150
  * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
6984
7151
  */
6985
7152
  lago_true_up_parent_fee_id?: string | null;
7153
+ /**
7154
+ * Format: uuid
7155
+ * @description Unique identifier assigned to the fee this fee was derived from. It is set on fees regenerated from an existing fee, and `null` otherwise.
7156
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
7157
+ */
7158
+ lago_original_fee_id?: string | null;
6986
7159
  /**
6987
7160
  * Format: uuid
6988
7161
  * @description Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.
@@ -7157,13 +7330,13 @@ export interface components {
7157
7330
  /** @description Item attached to the fee */
7158
7331
  item: {
7159
7332
  /**
7160
- * @description The fee type. Possible values are `add-on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.
7333
+ * @description The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.
7161
7334
  * @example subscription
7162
7335
  * @enum {string}
7163
7336
  */
7164
7337
  type: "charge" | "fixed_charge" | "add_on" | "subscription" | "credit" | "commitment";
7165
7338
  /**
7166
- * @description The code of the fee item. It can be the code of the `add-on`, the code of the `charge`, the code of the `fixed_charge`, the code of the `credit` or the code of the `subscription`.
7339
+ * @description The code of the fee item. It can be the code of the `add_on`, the code of the `charge`, the code of the `fixed_charge`, the code of the `credit` or the code of the `subscription`.
7167
7340
  * @example startup
7168
7341
  */
7169
7342
  code: string;
@@ -7171,7 +7344,7 @@ export interface components {
7171
7344
  * @description The name of the fee item. The value depends on the type of the fee item:
7172
7345
  *
7173
7346
  * - If the fee item is a `charge`, it is the billable metric name.
7174
- * - If the fee item is a `add-on`, it is the add-on name.
7347
+ * - If the fee item is an `add_on`, it is the add-on name.
7175
7348
  * - If the fee item is a `credit`, it is the wallet transaction name if set, or `"credit"` if not.
7176
7349
  * - If the fee item is a `fixed_charge`, it is the fixed charge add-on name.
7177
7350
  * - For all the other fee items, it is the subscription plan name.
@@ -7182,7 +7355,7 @@ export interface components {
7182
7355
  * @description The description of the fee item. The value depends on the type of the fee item:
7183
7356
  *
7184
7357
  * - If the fee item is a `charge`, it is the billable metric description.
7185
- * - If the fee item is a `add-on`, it is the add-on description.
7358
+ * - If the fee item is an `add_on`, it is the add-on description.
7186
7359
  * - If the fee item is a `credit`, it is always `"credit"`.
7187
7360
  * - If the fee item is a `fixed_charge`, it is the fixed charge add-on description.
7188
7361
  * - For all the other fee items, it is the subscription plan description.
@@ -7193,7 +7366,7 @@ export interface components {
7193
7366
  * @description Specifies the name that will be displayed on an invoice. If no value is set for this field, we'll fallback to a value that depends on the type of the fee items:
7194
7367
  *
7195
7368
  * - If the fee item is a `charge`, we'll fallback to the `invoice_display_name` of the `charge` or the billable metric name if no `invoice_display_name` is set.
7196
- * - If the fee item is a `add-on`, we'll fallback to the `invoice_name` of the `add-on` or the `name` of the `add-on`.
7369
+ * - If the fee item is an `add_on`, we'll fallback to the `invoice_name` of the `add_on` or the `name` of the `add_on`.
7197
7370
  * - If the fee item is a `credit`, we'll fallback to the wallet transaction name if set, or `credit` if not.
7198
7371
  * - If the fee item is a `fixed_charge`, we'll fallback to the `invoice_display_name` of the `fixed_charge` or the `invoice_name` of the `fixed_charge_add_on` if no `invoice_display_name` is set.
7199
7372
  * - For all the other fee items, we'll fallback to the `invoice_display_name` of the subscription plan.
@@ -7211,7 +7384,7 @@ export interface components {
7211
7384
  } | null;
7212
7385
  /**
7213
7386
  * Format: uuid
7214
- * @description Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
7387
+ * @description Unique identifier of the fee item, created by Lago. It can be the identifier of the `add_on`, the `charge`, the `credit`, the `subscription` or the `commitment`.
7215
7388
  * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
7216
7389
  */
7217
7390
  lago_item_id: string;
@@ -7262,11 +7435,6 @@ export interface components {
7262
7435
  /** @example 100 */
7263
7436
  base_amount_cents?: number;
7264
7437
  } & components["schemas"]["BaseAppliedTax"];
7265
- /**
7266
- * @example US
7267
- * @enum {string|null}
7268
- */
7269
- CountryOrNull: null | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
7270
7438
  /**
7271
7439
  * @example America/Los_Angeles
7272
7440
  * @enum {string|null}
@@ -7295,11 +7463,11 @@ export interface components {
7295
7463
  subscription_invoice_issuing_date_adjustment: "align_with_finalization_date" | "keep_anchor" | null;
7296
7464
  /**
7297
7465
  * @description The payment provider utilized to initiate payments for invoices issued by Lago.
7298
- * Accepted values: `stripe`, `adyen`, `gocardless` or null. This field is required if you intend to assign a `provider_customer_id`.
7466
+ * Accepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`.
7299
7467
  * @example stripe
7300
7468
  * @enum {string}
7301
7469
  */
7302
- payment_provider?: "stripe" | "adyen" | "gocardless";
7470
+ payment_provider?: "stripe" | "adyen" | "cashfree" | "flutterwave" | "gocardless" | "moneyhash";
7303
7471
  /**
7304
7472
  * @description Unique code used to identify a payment provider connection.
7305
7473
  * @example stripe-eu-1
@@ -7411,7 +7579,7 @@ export interface components {
7411
7579
  */
7412
7580
  lago_id: string;
7413
7581
  /**
7414
- * @description The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation
7582
+ * @description The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id` associated with them, allowing for easy identification and sorting based on the order of creation
7415
7583
  * @example 1
7416
7584
  */
7417
7585
  sequential_id: number;
@@ -7540,6 +7708,11 @@ export interface components {
7540
7708
  * @example 30
7541
7709
  */
7542
7710
  net_payment_term?: number | null;
7711
+ /**
7712
+ * @description The customer ID within the Salesforce system
7713
+ * @example 0015p00001JQx1QAAT
7714
+ */
7715
+ external_salesforce_id?: string | null;
7543
7716
  /**
7544
7717
  * Format: date-time
7545
7718
  * @description The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created
@@ -7579,8 +7752,8 @@ export interface components {
7579
7752
  */
7580
7753
  lago_id: string;
7581
7754
  /**
7582
- * @description The integration type used for accounting and tax syncs.
7583
- * Accepted values: `netsuite, anrok`.
7755
+ * @description The integration type used for accounting, tax and CRM syncs.
7756
+ * Accepted values: `netsuite`, `anrok`, `xero`, `hubspot`, `salesforce`.
7584
7757
  * @example netsuite
7585
7758
  * @enum {string}
7586
7759
  */
@@ -7733,11 +7906,21 @@ export interface components {
7733
7906
  * @example 120
7734
7907
  */
7735
7908
  total_amount_cents: number;
7909
+ /**
7910
+ * @description The total amount of the credit note, expressed in cents, with precision.
7911
+ * @example 120.0001
7912
+ */
7913
+ precise_total_amount_cents?: string | null;
7736
7914
  /**
7737
7915
  * @description The tax amount of the credit note, expressed in cents.
7738
7916
  * @example 20
7739
7917
  */
7740
7918
  taxes_amount_cents: number;
7919
+ /**
7920
+ * @description The tax amount of the credit note, expressed in cents, with precision.
7921
+ * @example 20.0001
7922
+ */
7923
+ precise_taxes_amount_cents?: string | null;
7741
7924
  /**
7742
7925
  * @description The tax rate associated with this specific credit note.
7743
7926
  * @example 20
@@ -7764,7 +7947,7 @@ export interface components {
7764
7947
  */
7765
7948
  refund_amount_cents: number;
7766
7949
  /**
7767
- * @description The ofsetted amount (deducted from the invoice balance) of the credit note, expressed in cents.
7950
+ * @description The offset amount (deducted from the invoice balance) of the credit note, expressed in cents.
7768
7951
  * @example 0
7769
7952
  */
7770
7953
  offset_amount_cents: number;
@@ -7786,10 +7969,15 @@ export interface components {
7786
7969
  */
7787
7970
  updated_at: string;
7788
7971
  /**
7789
- * @description The PDF file of the credit note.
7972
+ * @description The PDF file of the credit note. It is `null` while no PDF has been generated.
7790
7973
  * @example https://getlago.com/credit_note/file
7791
7974
  */
7792
7975
  file_url?: string | null;
7976
+ /**
7977
+ * @description The e-invoicing XML file of the credit note. It is `null` while no XML file has been generated.
7978
+ * @example https://getlago.com/credit_note/xml
7979
+ */
7980
+ xml_url?: string | null;
7793
7981
  /** @description Array of credit note's items. */
7794
7982
  items?: components["schemas"]["CreditNoteItemObject"][];
7795
7983
  applied_taxes?: components["schemas"]["CreditNoteAppliedTaxObject"][];
@@ -7837,17 +8025,17 @@ export interface components {
7837
8025
  */
7838
8026
  description?: string;
7839
8027
  /**
7840
- * @description The total amount to be credited to the customer balance for discounts on future invoices. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice’s total fees.”
8028
+ * @description The total amount to be credited to the customer balance for discounts on future invoices. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.
7841
8029
  * @example 100
7842
8030
  */
7843
8031
  credit_amount_cents?: number | null;
7844
8032
  /**
7845
- * @description The total amount to be refunded immediately to the payment method used by the customer. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice’s total fees.”
8033
+ * @description The total amount to be refunded immediately to the payment method used by the customer. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.
7846
8034
  * @example 500
7847
8035
  */
7848
8036
  refund_amount_cents?: number | null;
7849
8037
  /**
7850
- * @description The total amount to be immediately deducted from the invoice balance. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice’s total fees.”
8038
+ * @description The total amount to be immediately deducted from the invoice balance. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.
7851
8039
  * @example 200
7852
8040
  */
7853
8041
  offset_amount_cents?: number | null;
@@ -8103,9 +8291,9 @@ export interface components {
8103
8291
  metadata?: components["schemas"]["CustomerMetadata"][];
8104
8292
  /** @description List of customer taxes */
8105
8293
  taxes?: components["schemas"]["TaxObject"][];
8106
- /** @description The customer’s invoice custom section used for generating invoices. */
8294
+ /** @description The customer's invoice custom sections used for generating invoices. */
8107
8295
  applicable_invoice_custom_sections?: components["schemas"]["InvoiceCustomSectionObject"][];
8108
- /** @description List of errors with details that might have been raised while processing backgroud actions for the customers */
8296
+ /** @description List of errors with details that might have been raised while processing background actions for the customer */
8109
8297
  error_details?: components["schemas"]["ErrorDetailObject"][];
8110
8298
  };
8111
8299
  CustomersPaginated: {
@@ -8186,10 +8374,12 @@ export interface components {
8186
8374
  * @description The type of the account. It can have one of the following values:
8187
8375
  * - `customer`: the account is a customer, default value.
8188
8376
  * - `partner`: the account is a partner.
8377
+ *
8378
+ * This field is only applied when revenue share is enabled on your organization; otherwise it is ignored.
8189
8379
  * @example customer
8190
- * @enum {string|null}
8380
+ * @enum {string}
8191
8381
  */
8192
- account_type?: "customer" | "partner" | null;
8382
+ account_type?: "customer" | "partner";
8193
8383
  /**
8194
8384
  * @description The type of the customer. It can have one of the following values:
8195
8385
  * - `company`: the customer is a company.
@@ -8230,6 +8420,11 @@ export interface components {
8230
8420
  * @example 30
8231
8421
  */
8232
8422
  net_payment_term?: number | null;
8423
+ /**
8424
+ * @description The customer ID within the Salesforce system
8425
+ * @example 0015p00001JQx1QAAT
8426
+ */
8427
+ external_salesforce_id?: string | null;
8233
8428
  /**
8234
8429
  * @description Specifies how invoices with a zero total amount should be handled:
8235
8430
  * - `inherit`: (Default) Follows the organization-level configuration.
@@ -8249,12 +8444,12 @@ export interface components {
8249
8444
  */
8250
8445
  id?: string;
8251
8446
  /**
8252
- * @description The integration type used for accounting and tax syncs.
8253
- * Accepted values: `netsuite, anrok, xero`.
8447
+ * @description The integration type used for accounting, tax and CRM syncs.
8448
+ * Accepted values: `netsuite`, `anrok`, `avalara`, `xero`, `hubspot`, `salesforce`.
8254
8449
  * @example netsuite
8255
8450
  * @enum {string}
8256
8451
  */
8257
- integration_type?: "netsuite" | "anrok" | "xero";
8452
+ integration_type?: "netsuite" | "anrok" | "avalara" | "xero" | "hubspot" | "salesforce";
8258
8453
  /**
8259
8454
  * @description Unique code used to identify an integration connection.
8260
8455
  * @example netsuite-eu-1
@@ -8275,6 +8470,11 @@ export interface components {
8275
8470
  * @example 2
8276
8471
  */
8277
8472
  subsidiary_id?: string;
8473
+ /**
8474
+ * @description This optional field is needed only when working with `hubspot` connection.
8475
+ * @example contacts
8476
+ */
8477
+ targeted_object?: string | null;
8278
8478
  }[];
8279
8479
  /** @description Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format */
8280
8480
  metadata?: {
@@ -8298,7 +8498,7 @@ export interface components {
8298
8498
  * @description Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice.
8299
8499
  * @example true
8300
8500
  */
8301
- display_in_invoice: boolean;
8501
+ display_in_invoice?: boolean;
8302
8502
  }[];
8303
8503
  /**
8304
8504
  * @description Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default
@@ -8352,16 +8552,16 @@ export interface components {
8352
8552
  issuing_date: string;
8353
8553
  /**
8354
8554
  * Format: date-time
8355
- * @description The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
8555
+ * @description The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC). It is `null` until a dispute is lost on the invoice.
8356
8556
  * @example 2022-09-14T16:35:31Z
8357
8557
  */
8358
- payment_dispute_lost_at?: string;
8558
+ payment_dispute_lost_at?: string | null;
8359
8559
  /**
8360
8560
  * Format: date
8361
8561
  * @description The payment due date for the invoice, specified in the ISO 8601 date format.
8362
8562
  * @example 2022-04-30
8363
8563
  */
8364
- payment_due_date?: string;
8564
+ payment_due_date?: string | null;
8365
8565
  /**
8366
8566
  * @description Specifies if the payment is considered as overdue.
8367
8567
  * @example true
@@ -8373,11 +8573,11 @@ export interface components {
8373
8573
  */
8374
8574
  net_payment_term?: number;
8375
8575
  /**
8376
- * @description The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.
8576
+ * @description The type of invoice issued. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.
8377
8577
  * @example subscription
8378
8578
  * @enum {string}
8379
8579
  */
8380
- invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
8580
+ invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
8381
8581
  /**
8382
8582
  * @description The status of the invoice. It indicates the current state of the invoice and can have following values:
8383
8583
  * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
@@ -8467,6 +8667,21 @@ export interface components {
8467
8667
  * @example 100
8468
8668
  */
8469
8669
  total_amount_cents: number;
8670
+ /**
8671
+ * @description The amount already paid on the invoice, expressed in cents.
8672
+ * @example 40
8673
+ */
8674
+ total_paid_amount_cents?: number;
8675
+ /**
8676
+ * @description The amount of the invoice settled by finalized credit notes, expressed in cents.
8677
+ * @example 10
8678
+ */
8679
+ total_offsetted_credit_note_amount_cents?: number;
8680
+ /**
8681
+ * @description The amount still due on the invoice, expressed in cents. It is equal to `total_amount_cents` minus `total_paid_amount_cents` and `total_offsetted_credit_note_amount_cents`, and is `0` for voided invoices.
8682
+ * @example 50
8683
+ */
8684
+ total_due_amount_cents?: number;
8470
8685
  /** @example 3 */
8471
8686
  version_number: number;
8472
8687
  /**
@@ -8476,10 +8691,16 @@ export interface components {
8476
8691
  self_billed?: boolean;
8477
8692
  /**
8478
8693
  * Format: uri
8479
- * @description Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice
8694
+ * @description Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice. It is `null` while no PDF has been generated, which is the case for draft invoices.
8480
8695
  * @example https://getlago.com/invoice/file
8481
8696
  */
8482
- file_url?: string;
8697
+ file_url?: string | null;
8698
+ /**
8699
+ * Format: uri
8700
+ * @description Contains the URL that provides direct access to the e-invoicing XML file. It is `null` while no XML file has been generated for the invoice.
8701
+ * @example https://getlago.com/invoice/xml
8702
+ */
8703
+ xml_url?: string | null;
8483
8704
  /**
8484
8705
  * Format: uri
8485
8706
  * @description Contains the URL to the invoice page in the Lago dashboard. It is `null` for invoices that are not visible in the dashboard (for example while still generating). Use it to link users directly to the invoice overview page.
@@ -8498,6 +8719,12 @@ export interface components {
8498
8719
  * @example 2022-04-29T08:59:51Z
8499
8720
  */
8500
8721
  updated_at: string;
8722
+ /**
8723
+ * Format: date-time
8724
+ * @description The date when the invoice was voided, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). It is `null` for invoices that have not been voided.
8725
+ * @example 2022-04-29T08:59:51Z
8726
+ */
8727
+ voided_at?: string | null;
8501
8728
  };
8502
8729
  InvoiceMetadataObject: {
8503
8730
  /**
@@ -8654,7 +8881,7 @@ export interface components {
8654
8881
  /** @description List of invoice IDs associated with the payment. */
8655
8882
  invoice_ids: string[];
8656
8883
  /** @description List of invoice numbers associated with the payment. */
8657
- invoice_numbers?: string[];
8884
+ invoice_numbers: string[];
8658
8885
  /**
8659
8886
  * Format: uuid
8660
8887
  * @description The unique identifier of the paid resource, created by Lago.
@@ -8695,15 +8922,15 @@ export interface components {
8695
8922
  */
8696
8923
  type: "manual" | "provider";
8697
8924
  /**
8698
- * @description Reference for the payment.
8925
+ * @description Reference for the payment. Set on manual payments only; it is always `null` for payments collected through a payment provider.
8699
8926
  * @example ref1
8700
8927
  */
8701
- reference: string;
8928
+ reference: string | null;
8702
8929
  /**
8703
- * @description Code of the payment provider
8930
+ * @description Code of the payment provider. It is `null` for manual payments, which are not attached to a payment provider.
8704
8931
  * @example stripe_prod
8705
8932
  */
8706
- payment_provider_code: string;
8933
+ payment_provider_code: string | null;
8707
8934
  /**
8708
8935
  * @description The type of payment provider
8709
8936
  * @example stripe
@@ -8718,16 +8945,10 @@ export interface components {
8718
8945
  */
8719
8946
  provider_payment_id: string | null;
8720
8947
  /**
8721
- * @description Unique identifier of the customer within the payment provider
8948
+ * @description Unique identifier of the customer within the payment provider. It is `null` for manual payments.
8722
8949
  * @example cus_5eb0285bcf941bc6ba
8723
8950
  */
8724
- provider_customer_id: string;
8725
- /**
8726
- * Format: uuid
8727
- * @description The unique identifier of the payment method used for this payment.
8728
- * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
8729
- */
8730
- payment_method_id?: string | null;
8951
+ provider_customer_id: string | null;
8731
8952
  /**
8732
8953
  * @description The next action to be taken by the customer to complete the payment. Should usually be empty, except when receiving the `payment.requires_action` webhook.
8733
8954
  * @example {
@@ -8761,10 +8982,10 @@ export interface components {
8761
8982
  lago_id: string;
8762
8983
  /**
8763
8984
  * Format: email
8764
- * @description The customer's email address used for sending dunning notifications
8985
+ * @description The email address used for sending dunning notifications. It defaults to the customer's own email address, and is `null` when the customer has none.
8765
8986
  * @example dinesh@piedpiper.test
8766
8987
  */
8767
- email: string;
8988
+ email: string | null;
8768
8989
  /**
8769
8990
  * @description The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
8770
8991
  * @example 100
@@ -9259,7 +9480,7 @@ export interface components {
9259
9480
  */
9260
9481
  code?: string | null;
9261
9482
  /**
9262
- * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
9483
+ * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
9263
9484
  * @example 50
9264
9485
  */
9265
9486
  priority?: number;
@@ -9398,7 +9619,7 @@ export interface components {
9398
9619
  invoice_custom_section_codes?: string[];
9399
9620
  };
9400
9621
  WalletCreateInput: {
9401
- wallet?: {
9622
+ wallet: {
9402
9623
  /**
9403
9624
  * @description The name of the wallet.
9404
9625
  * @example Prepaid
@@ -9410,7 +9631,7 @@ export interface components {
9410
9631
  */
9411
9632
  code?: string | null;
9412
9633
  /**
9413
- * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
9634
+ * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
9414
9635
  * @example 50
9415
9636
  */
9416
9637
  priority?: number;
@@ -9479,6 +9700,11 @@ export interface components {
9479
9700
  * @example Tokens for models 'high-fidelity-boost'
9480
9701
  */
9481
9702
  transaction_name?: string | null;
9703
+ /**
9704
+ * @description The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
9705
+ * @example 50
9706
+ */
9707
+ transaction_priority?: number;
9482
9708
  /**
9483
9709
  * @description The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
9484
9710
  * @example PO-123
@@ -9636,7 +9862,7 @@ export interface components {
9636
9862
  */
9637
9863
  code?: string | null;
9638
9864
  /**
9639
- * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
9865
+ * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
9640
9866
  * @example 50
9641
9867
  */
9642
9868
  priority?: number;
@@ -9651,6 +9877,16 @@ export interface components {
9651
9877
  * @example false
9652
9878
  */
9653
9879
  invoice_requires_successful_payment?: boolean;
9880
+ /**
9881
+ * @description Minimum amount of cents that can be top-up with a single paid transaction.
9882
+ * @example 100
9883
+ */
9884
+ paid_top_up_min_amount_cents?: number | null;
9885
+ /**
9886
+ * @description Maximum amount of cents that can be top-up with a single paid transaction.
9887
+ * @example 1000
9888
+ */
9889
+ paid_top_up_max_amount_cents?: number | null;
9654
9890
  /**
9655
9891
  * @description The code of the billing entity associated with the wallet.
9656
9892
  * @example default
@@ -9675,7 +9911,7 @@ export interface components {
9675
9911
  * @example interval
9676
9912
  * @enum {string}
9677
9913
  */
9678
- trigger?: "interval" | "threshold";
9914
+ trigger: "interval" | "threshold";
9679
9915
  /**
9680
9916
  * @description The method used for recurring top-up. Possible values are `fixed` or `target`.
9681
9917
  * @example target
@@ -9802,6 +10038,8 @@ export interface components {
9802
10038
  AlertThresholdObject: components["schemas"]["AlertThresholdBaseObject"] & {
9803
10039
  /**
9804
10040
  * @description A value that should trigger this alert, formatted as a BigDecimal.
10041
+ *
10042
+ * The unit depends on the alert type: `billable_metric_current_usage_units` and `billable_metric_lifetime_usage_units` are expressed in units, `wallet_credits_balance` and `wallet_credits_ongoing_balance` in credits, and all other types in cents.
9805
10043
  * @example 99.0
9806
10044
  */
9807
10045
  value: string;
@@ -9880,6 +10118,8 @@ export interface components {
9880
10118
  AlertThresholdInput: components["schemas"]["AlertThresholdBaseObject"] & {
9881
10119
  /**
9882
10120
  * @description A value that should trigger this alert. This can be an integer or a string formatted as a BigDecimal.
10121
+ *
10122
+ * The unit depends on the alert type: `billable_metric_current_usage_units` and `billable_metric_lifetime_usage_units` are expressed in units, `wallet_credits_balance` and `wallet_credits_ongoing_balance` in credits, and all other types in cents.
9883
10123
  * @example 99
9884
10124
  */
9885
10125
  value: number | string;
@@ -9980,22 +10220,22 @@ export interface components {
9980
10220
  * @description The number of units consumed for a specific charge filter related to a charge item.
9981
10221
  * @example 0.9
9982
10222
  */
9983
- units?: string;
10223
+ units: string;
9984
10224
  /**
9985
10225
  * @description The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
9986
10226
  * @example 1.0
9987
10227
  */
9988
- total_aggregated_units?: string;
10228
+ total_aggregated_units: string;
9989
10229
  /**
9990
10230
  * @description The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
9991
10231
  * @example 1000
9992
10232
  */
9993
- amount_cents?: number;
10233
+ amount_cents: number;
9994
10234
  /**
9995
10235
  * @description The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.
9996
10236
  * @example 10
9997
10237
  */
9998
- events_count?: number;
10238
+ events_count: number;
9999
10239
  /**
10000
10240
  * @description Specifies the name that will be displayed on an invoice.
10001
10241
  * @example AWS eu-east-1
@@ -10010,7 +10250,7 @@ export interface components {
10010
10250
  * ]
10011
10251
  * }
10012
10252
  */
10013
- values?: {
10253
+ values: {
10014
10254
  [key: string]: string[];
10015
10255
  };
10016
10256
  presentation_breakdowns?: components["schemas"]["PresentationBreakdownsObject"];
@@ -10021,25 +10261,25 @@ export interface components {
10021
10261
  * @description The amount in cents, tax excluded, consumed for a specific group related to a charge item.
10022
10262
  * @example 1000
10023
10263
  */
10024
- amount_cents?: number;
10264
+ amount_cents: number;
10025
10265
  /**
10026
10266
  * @description The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
10027
10267
  * @example 10
10028
10268
  */
10029
- events_count?: number;
10269
+ events_count: number;
10030
10270
  /**
10031
10271
  * @description The number of units consumed for a specific group related to a charge item.
10032
10272
  * @example 0.9
10033
10273
  */
10034
- units?: string;
10274
+ units: string;
10035
10275
  /**
10036
10276
  * @description The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
10037
10277
  * @example 1.0
10038
10278
  */
10039
- total_aggregated_units?: string;
10279
+ total_aggregated_units: string;
10040
10280
  pricing_unit_details?: components["schemas"]["UsagePricingUnitDetailsObject"];
10041
10281
  /** @description Key value list of event properties aggregated by the charge model */
10042
- grouped_by?: {
10282
+ grouped_by: {
10043
10283
  [key: string]: string;
10044
10284
  };
10045
10285
  filters?: components["schemas"]["CustomerChargeFiltersUsageObject"];
@@ -10178,27 +10418,27 @@ export interface components {
10178
10418
  * @description The number of units consumed for a specific charge filter related to a charge item.
10179
10419
  * @example 0.9
10180
10420
  */
10181
- units?: string;
10421
+ units: string;
10182
10422
  /**
10183
10423
  * @description The projected number of units that can be consumed for a specific charge filter related to a charge item.
10184
10424
  * @example 1.8
10185
10425
  */
10186
- projected_units?: string;
10426
+ projected_units: string;
10187
10427
  /**
10188
10428
  * @description The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
10189
10429
  * @example 1000
10190
10430
  */
10191
- amount_cents?: number;
10431
+ amount_cents: number;
10192
10432
  /**
10193
10433
  * @description The projected amount in cents, tax excluded, that can be consumed for a specific charge filter related to a charge item.
10194
10434
  * @example 2000
10195
10435
  */
10196
- projected_amount_cents?: number;
10436
+ projected_amount_cents: number;
10197
10437
  /**
10198
10438
  * @description The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.
10199
10439
  * @example 10
10200
10440
  */
10201
- events_count?: number;
10441
+ events_count: number;
10202
10442
  /**
10203
10443
  * @description Specifies the name that will be displayed on an invoice.
10204
10444
  * @example AWS eu-east-1
@@ -10213,7 +10453,7 @@ export interface components {
10213
10453
  * ]
10214
10454
  * }
10215
10455
  */
10216
- values?: {
10456
+ values: {
10217
10457
  [key: string]: string[];
10218
10458
  };
10219
10459
  presentation_breakdowns?: components["schemas"]["PresentationBreakdownsObject"];
@@ -10225,30 +10465,30 @@ export interface components {
10225
10465
  * @description The amount in cents, tax excluded, consumed for a specific group related to a charge item.
10226
10466
  * @example 1000
10227
10467
  */
10228
- amount_cents?: number;
10468
+ amount_cents: number;
10229
10469
  /**
10230
10470
  * @description The projected amount in cents, tax excluded, that can be consumed for a specific group related to a charge item.
10231
10471
  * @example 2000
10232
10472
  */
10233
- projected_amount_cents?: number;
10473
+ projected_amount_cents: number;
10234
10474
  /**
10235
10475
  * @description The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
10236
10476
  * @example 10
10237
10477
  */
10238
- events_count?: number;
10478
+ events_count: number;
10239
10479
  /**
10240
10480
  * @description The number of units consumed for a specific group related to a charge item.
10241
10481
  * @example 0.9
10242
10482
  */
10243
- units?: string;
10483
+ units: string;
10244
10484
  /**
10245
10485
  * @description The projected number of units that can be consumed for a specific group related to a charge item.
10246
10486
  * @example 1.8
10247
10487
  */
10248
- projected_units?: string;
10488
+ projected_units: string;
10249
10489
  pricing_unit_details?: components["schemas"]["UsagePricingUnitDetailsObject"];
10250
10490
  /** @description Key value list of event properties aggregated by the charge model */
10251
- grouped_by?: {
10491
+ grouped_by: {
10252
10492
  [key: string]: string;
10253
10493
  };
10254
10494
  filters?: components["schemas"]["CustomerProjectedChargeFiltersUsageObject"];
@@ -10440,18 +10680,18 @@ export interface components {
10440
10680
  * @description Code of the payment provider associated with this payment method.
10441
10681
  * @example stripe_prod
10442
10682
  */
10443
- payment_provider_code?: string | null;
10683
+ payment_provider_code: string | null;
10444
10684
  /**
10445
10685
  * @description Human-readable name of the payment provider.
10446
10686
  * @example Stripe
10447
10687
  */
10448
- payment_provider_name?: string | null;
10688
+ payment_provider_name: string | null;
10449
10689
  /**
10450
- * @description The type of the payment provider.
10690
+ * @description The type of the payment provider. It is `null` when the payment method is no longer attached to a payment provider.
10451
10691
  * @example stripe
10452
- * @enum {string}
10692
+ * @enum {string|null}
10453
10693
  */
10454
- payment_provider_type: "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
10694
+ payment_provider_type: null | "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
10455
10695
  /**
10456
10696
  * @description Unique identifier of the payment method within the payment provider.
10457
10697
  * @example pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ
@@ -10580,9 +10820,19 @@ export interface components {
10580
10820
  * "gb": 10
10581
10821
  * }
10582
10822
  */
10583
- properties?: {
10823
+ properties?: ({
10824
+ /**
10825
+ * @description The code of the wallet targeted by this event for prepaid credits deduction.
10826
+ * When provided, credits are drawn from this specific wallet instead of following the standard wallet selection logic.
10827
+ * If the code does not match an existing wallet, no credits will be applied for the event.
10828
+ * This field is only taken into account when the targeted charge has `accepts_target_wallet` set to `true`.
10829
+ * This field requires a premium integration.
10830
+ * @example main_wallet
10831
+ */
10832
+ target_wallet_code?: string | null;
10833
+ } & {
10584
10834
  [key: string]: string | number;
10585
- } | null;
10835
+ }) | null;
10586
10836
  };
10587
10837
  EventInput: {
10588
10838
  event: components["schemas"]["EventInputObject"];
@@ -10620,8 +10870,20 @@ export interface components {
10620
10870
  * @example sub_1234567890
10621
10871
  */
10622
10872
  external_subscription_id: string;
10623
- /** @description This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. */
10624
- properties?: Record<string, never>;
10873
+ /** @description This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. Any property of the targeted billable metric can be sent here, in addition to the documented fields below. */
10874
+ properties?: {
10875
+ /**
10876
+ * @description The code of the wallet targeted by this event for prepaid credits deduction.
10877
+ * When provided, credits are drawn from this specific wallet instead of following the standard wallet selection logic.
10878
+ * If the code does not match an existing wallet, no credits will be applied for the event.
10879
+ * This field is only taken into account when the targeted charge has `accepts_target_wallet` set to `true`.
10880
+ * This field requires a premium integration.
10881
+ * @example main_wallet
10882
+ */
10883
+ target_wallet_code?: string | null;
10884
+ } & {
10885
+ [key: string]: unknown;
10886
+ };
10625
10887
  };
10626
10888
  };
10627
10889
  Fees: {
@@ -10877,6 +11139,12 @@ export interface components {
10877
11139
  * @example EUR
10878
11140
  */
10879
11141
  currency?: components["schemas"]["Currency"];
11142
+ /**
11143
+ * @description If true, the invoice will be created but not sent to the payment provider.
11144
+ * @default false
11145
+ * @example true
11146
+ */
11147
+ skip_psp: boolean | null;
10880
11148
  /**
10881
11149
  * @description The purchase order number to associate with the invoice.
10882
11150
  * @example PO-123
@@ -10899,13 +11167,13 @@ export interface components {
10899
11167
  */
10900
11168
  unit_amount_cents?: number | null;
10901
11169
  /**
10902
- * @description The quantity of units associated with the fee. By default, only 1 unit is added to the invoice.
11170
+ * @description The quantity of units associated with the fee. Accepts a number or a string formatted as a BigDecimal. By default, only 1 unit is added to the invoice.
10903
11171
  * @example 2.5
10904
11172
  */
10905
- units?: string | null;
11173
+ units?: string | number | null;
10906
11174
  /**
10907
- * @description This is a description
10908
- * @example The description of the fee line item in the invoice. By default, the description of the add-on is used.
11175
+ * @description The description of the fee line item in the invoice. By default, the description of the add-on is used.
11176
+ * @example Onboarding session, June 2024
10909
11177
  */
10910
11178
  description?: string | null;
10911
11179
  /**
@@ -10921,12 +11189,6 @@ export interface components {
10921
11189
  */
10922
11190
  to_datetime?: string;
10923
11191
  tax_codes?: components["schemas"]["TaxCodes"];
10924
- /**
10925
- * @description If true, the invoice will be created but not sent to the payment provider.
10926
- * @default false
10927
- * @example true
10928
- */
10929
- skip_psp: boolean | null;
10930
11192
  }[];
10931
11193
  invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
10932
11194
  /** @description Optional payment method to use for processing the invoice payment. */
@@ -12055,111 +12317,6 @@ export interface components {
12055
12317
  */
12056
12318
  document_locale?: string;
12057
12319
  };
12058
- OrganizationUpdateInput: {
12059
- organization: {
12060
- /**
12061
- * @description The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.
12062
- * @example https://webhook.brex.com
12063
- */
12064
- webhook_url?: string | null;
12065
- /**
12066
- * @description The country of your organization.
12067
- * @example US
12068
- */
12069
- country?: components["schemas"]["CountryOrNull"];
12070
- /**
12071
- * @description The default currency of an organization.
12072
- * @example USD
12073
- */
12074
- default_currency?: components["schemas"]["Currency"];
12075
- /**
12076
- * @description The first line of your organization's billing address.
12077
- * @example 100 Brex Street
12078
- */
12079
- address_line1?: string | null;
12080
- /**
12081
- * @description The second line of your organization's billing address.
12082
- * @example null
12083
- */
12084
- address_line2?: string | null;
12085
- /**
12086
- * @description The state of your organization's billing address.
12087
- * @example NYC
12088
- */
12089
- state?: string | null;
12090
- /**
12091
- * @description The zipcode of your organization's billing address.
12092
- * @example 10000
12093
- */
12094
- zipcode?: string | null;
12095
- /**
12096
- * Format: email
12097
- * @description The email address of your organization used to bill your customers.
12098
- * @example brex@brex.com
12099
- */
12100
- email?: string | null;
12101
- /**
12102
- * @description The city of your organization's billing address.
12103
- * @example New York
12104
- */
12105
- city?: string | null;
12106
- /**
12107
- * @description The legal name of your organization.
12108
- * @example null
12109
- */
12110
- legal_name?: string | null;
12111
- /**
12112
- * @description The legal number of your organization.
12113
- * @example null
12114
- */
12115
- legal_number?: string | null;
12116
- /**
12117
- * @description This parameter configures the method of incrementing invoice numbers for your customers.
12118
- *
12119
- * - `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.
12120
- * - `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
12121
- *
12122
- * The default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
12123
- * @example per_customer
12124
- * @enum {string}
12125
- */
12126
- document_numbering?: "per_customer" | "per_organization";
12127
- /**
12128
- * @description Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
12129
- * @example ORG-1234
12130
- */
12131
- document_number_prefix?: string;
12132
- /**
12133
- * @description The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
12134
- * @example 30
12135
- */
12136
- net_payment_term?: number;
12137
- /**
12138
- * @description The tax identification number of your organization.
12139
- * @example US123456789
12140
- */
12141
- tax_identification_number?: string | null;
12142
- /**
12143
- * @description Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
12144
- * @example America/New_York
12145
- */
12146
- timezone?: components["schemas"]["Timezone"];
12147
- /**
12148
- * @description Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
12149
- * @example [
12150
- * "invoice.finalized",
12151
- * "credit_note.created"
12152
- * ]
12153
- */
12154
- email_settings?: ("invoice.finalized" | "credit_note.created")[];
12155
- billing_configuration?: components["schemas"]["OrganizationBillingConfiguration"];
12156
- /**
12157
- * @description Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
12158
- * @example false
12159
- */
12160
- finalize_zero_amount_invoice?: boolean;
12161
- };
12162
- };
12163
12320
  OrganizationObject: {
12164
12321
  /**
12165
12322
  * Format: uuid
@@ -12172,6 +12329,11 @@ export interface components {
12172
12329
  * @example Name1
12173
12330
  */
12174
12331
  name: string;
12332
+ /**
12333
+ * @description A concise and unique identifier for your organization, formed by combining the organization's `name` and `id`.
12334
+ * @example NAME1-1234
12335
+ */
12336
+ slug?: string;
12175
12337
  /**
12176
12338
  * Format: date-time
12177
12339
  * @description The date of creation of your organization, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
@@ -12273,6 +12435,14 @@ export interface components {
12273
12435
  * @example America/New_York
12274
12436
  */
12275
12437
  timezone?: components["schemas"]["Timezone"];
12438
+ /**
12439
+ * @description Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values are `invoice.finalized`, `credit_note.created` and `payment_receipt.created`.
12440
+ * @example [
12441
+ * "invoice.finalized",
12442
+ * "credit_note.created"
12443
+ * ]
12444
+ */
12445
+ email_settings: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
12276
12446
  billing_configuration: components["schemas"]["OrganizationBillingConfiguration"];
12277
12447
  /** @description List of default organization taxes */
12278
12448
  taxes?: components["schemas"]["TaxObject"][];
@@ -12290,6 +12460,116 @@ export interface components {
12290
12460
  Organization: {
12291
12461
  organization: components["schemas"]["OrganizationObject"];
12292
12462
  };
12463
+ OrganizationUpdateInput: {
12464
+ organization: {
12465
+ /**
12466
+ * @description The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.
12467
+ * @example https://webhook.brex.com
12468
+ */
12469
+ webhook_url?: string | null;
12470
+ /**
12471
+ * @description The country of your organization.
12472
+ * @example US
12473
+ */
12474
+ country?: components["schemas"]["CountryOrNull"];
12475
+ /**
12476
+ * @description The default currency of an organization.
12477
+ * @example USD
12478
+ */
12479
+ default_currency?: components["schemas"]["Currency"];
12480
+ /**
12481
+ * @description The first line of your organization's billing address.
12482
+ * @example 100 Brex Street
12483
+ */
12484
+ address_line1?: string | null;
12485
+ /**
12486
+ * @description The second line of your organization's billing address.
12487
+ * @example null
12488
+ */
12489
+ address_line2?: string | null;
12490
+ /**
12491
+ * @description The state of your organization's billing address.
12492
+ * @example NYC
12493
+ */
12494
+ state?: string | null;
12495
+ /**
12496
+ * @description The zipcode of your organization's billing address.
12497
+ * @example 10000
12498
+ */
12499
+ zipcode?: string | null;
12500
+ /**
12501
+ * Format: email
12502
+ * @description The email address of your organization used to bill your customers.
12503
+ * @example brex@brex.com
12504
+ */
12505
+ email?: string | null;
12506
+ /**
12507
+ * @description The city of your organization's billing address.
12508
+ * @example New York
12509
+ */
12510
+ city?: string | null;
12511
+ /**
12512
+ * @description The legal name of your organization.
12513
+ * @example null
12514
+ */
12515
+ legal_name?: string | null;
12516
+ /**
12517
+ * @description The legal number of your organization.
12518
+ * @example null
12519
+ */
12520
+ legal_number?: string | null;
12521
+ /**
12522
+ * @description This parameter configures the method of incrementing invoice numbers for your customers.
12523
+ *
12524
+ * - `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.
12525
+ * - `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
12526
+ *
12527
+ * The default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
12528
+ * @example per_customer
12529
+ * @enum {string}
12530
+ */
12531
+ document_numbering?: "per_customer" | "per_organization";
12532
+ /**
12533
+ * @description Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
12534
+ * @example ORG-1234
12535
+ */
12536
+ document_number_prefix?: string;
12537
+ /**
12538
+ * @description The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
12539
+ * @example 30
12540
+ */
12541
+ net_payment_term?: number;
12542
+ /**
12543
+ * @description The tax identification number of your organization.
12544
+ * @example US123456789
12545
+ */
12546
+ tax_identification_number?: string | null;
12547
+ /**
12548
+ * @description Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
12549
+ * @example America/New_York
12550
+ */
12551
+ timezone?: components["schemas"]["Timezone"];
12552
+ /**
12553
+ * @description Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values are `invoice.finalized`, `credit_note.created` and `payment_receipt.created`.
12554
+ * @example [
12555
+ * "invoice.finalized",
12556
+ * "credit_note.created"
12557
+ * ]
12558
+ */
12559
+ email_settings?: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
12560
+ billing_configuration?: components["schemas"]["OrganizationBillingConfiguration"];
12561
+ /**
12562
+ * @description Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
12563
+ * @example false
12564
+ */
12565
+ finalize_zero_amount_invoice?: boolean;
12566
+ /**
12567
+ * @description A concise and unique identifier for your organization, used as a prefix in customer slugs.
12568
+ * @example NAME1-1234
12569
+ */
12570
+ slug?: string;
12571
+ };
12572
+ };
12293
12573
  PaymentReceiptObject: {
12294
12574
  /**
12295
12575
  * Format: uuid
@@ -12308,6 +12588,16 @@ export interface components {
12308
12588
  * @example LAG-1234-001-002
12309
12589
  */
12310
12590
  number: string;
12591
+ /**
12592
+ * @description The PDF file of the payment receipt. It is `null` while no PDF has been generated.
12593
+ * @example https://getlago.com/payment_receipt/file
12594
+ */
12595
+ file_url?: string | null;
12596
+ /**
12597
+ * @description The e-invoicing XML file of the payment receipt. It is `null` while no XML file has been generated.
12598
+ * @example https://getlago.com/payment_receipt/xml
12599
+ */
12600
+ xml_url?: string | null;
12311
12601
  payment: components["schemas"]["PaymentObject"];
12312
12602
  };
12313
12603
  PaymentReceiptsPaginated: {
@@ -12326,10 +12616,10 @@ export interface components {
12326
12616
  external_customer_id: string;
12327
12617
  /**
12328
12618
  * Format: email
12329
- * @description The customer's email address used for sending dunning notifications
12619
+ * @description The email address used for sending dunning notifications. When omitted, the customer's own email address is used.
12330
12620
  * @example dinesh@piedpiper.test
12331
12621
  */
12332
- email: string;
12622
+ email?: string;
12333
12623
  /** @description A list of Lago IDs for the customer's overdue invoices to start the dunning process */
12334
12624
  lago_invoice_ids: string[];
12335
12625
  /** @description Optional payment method to use for processing the payment request. */
@@ -12700,6 +12990,8 @@ export interface components {
12700
12990
  } | null;
12701
12991
  /**
12702
12992
  * @description Specifies whether the charge accepts a target wallet for prepaid credits deduction.
12993
+ * When `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.
12994
+ * This field requires a premium integration.
12703
12995
  * @example false
12704
12996
  */
12705
12997
  accepts_target_wallet?: boolean | null;
@@ -14139,6 +14431,16 @@ export interface components {
14139
14431
  * @example false
14140
14432
  */
14141
14433
  prorated?: boolean;
14434
+ /**
14435
+ * @description Specifies whether the charge accepts a target wallet for prepaid credits deduction.
14436
+ * When set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.
14437
+ * If no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.
14438
+ * If the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.
14439
+ *
14440
+ * This field requires a premium integration.
14441
+ * @example false
14442
+ */
14443
+ accepts_target_wallet?: boolean | null;
14142
14444
  };
14143
14445
  ChargeCreateInput: {
14144
14446
  charge: components["schemas"]["ChargeInput"] & unknown & {
@@ -14974,7 +15276,7 @@ export interface components {
14974
15276
  * @example billable_metric_current_usage_amount
14975
15277
  * @enum {string}
14976
15278
  */
14977
- alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
15279
+ alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
14978
15280
  /**
14979
15281
  * @description Unique code used to identify the alert.
14980
15282
  * @example storage_threshold_alert
@@ -15022,7 +15324,7 @@ export interface components {
15022
15324
  * @example billable_metric_current_usage_amount
15023
15325
  * @enum {string}
15024
15326
  */
15025
- alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
15327
+ alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
15026
15328
  /**
15027
15329
  * @description Unique code used to identify the alert.
15028
15330
  * @example storage_threshold_alert
@@ -15043,7 +15345,7 @@ export interface components {
15043
15345
  * @example billable_metric_current_usage_amount
15044
15346
  * @enum {string}
15045
15347
  */
15046
- alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
15348
+ alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
15047
15349
  /**
15048
15350
  * @description Unique code used to identify the alert.
15049
15351
  * @example storage_threshold_alert
@@ -15191,7 +15493,7 @@ export interface components {
15191
15493
  */
15192
15494
  rate?: string;
15193
15495
  /**
15194
- * @description Internal description of the taxe
15496
+ * @description Internal description of the tax
15195
15497
  * @example French standard VAT
15196
15498
  */
15197
15499
  description?: string | null;
@@ -15241,6 +15543,17 @@ export interface components {
15241
15543
  * @example 5.0
15242
15544
  */
15243
15545
  voided_credits?: string | null;
15546
+ /**
15547
+ * Format: uuid
15548
+ * @description Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount.
15549
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
15550
+ */
15551
+ voided_transaction_id?: string | null;
15552
+ /**
15553
+ * @description The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
15554
+ * @example 50
15555
+ */
15556
+ priority?: number;
15244
15557
  /**
15245
15558
  * @description A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
15246
15559
  * @example false
@@ -15293,6 +15606,11 @@ export interface components {
15293
15606
  * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
15294
15607
  */
15295
15608
  lago_wallet_id: string;
15609
+ /**
15610
+ * @description The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one.
15611
+ * @example default
15612
+ */
15613
+ billing_entity_code?: string;
15296
15614
  /**
15297
15615
  * Format: uuid
15298
15616
  * @description Unique identifier assigned to the invoice associated with this wallet transaction. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
@@ -15677,7 +15995,7 @@ export interface components {
15677
15995
  * @example billable_metric_current_usage_amount
15678
15996
  * @enum {string}
15679
15997
  */
15680
- alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
15998
+ alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units" | "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
15681
15999
  /**
15682
16000
  * @description Unique code used to identify the alert triggered.
15683
16001
  * @example storage_threshold_alert
@@ -15707,7 +16025,7 @@ export interface components {
15707
16025
  /** @description Array of thresholds crossed. All the recurring threshold values are present. */
15708
16026
  crossed_thresholds: components["schemas"]["AlertThresholdObject"][];
15709
16027
  };
15710
- CustomerIntegratrionErrorObject: {
16028
+ CustomerIntegrationErrorObject: {
15711
16029
  /**
15712
16030
  * Format: uuid
15713
16031
  * @description Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
@@ -16134,7 +16452,6 @@ export interface components {
16134
16452
  [key: string]: unknown;
16135
16453
  };
16136
16454
  };
16137
- CustomerPaymentProvidernErrorObject: components["schemas"]["CustomerPaymentProviderErrorObject"];
16138
16455
  };
16139
16456
  responses: {
16140
16457
  /** @description Unauthorized error */
@@ -16207,6 +16524,8 @@ export interface components {
16207
16524
  purchase_order_number: string;
16208
16525
  /** @description The customer external unique identifier (provided by your own application) */
16209
16526
  external_customer_id_path: string;
16527
+ /** @description Filter the results by currency, expressed as an ISO 4217 code. */
16528
+ currency: string;
16210
16529
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
16211
16530
  payment_status: "pending" | "failed" | "succeeded";
16212
16531
  /** @description A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. */
@@ -16217,8 +16536,6 @@ export interface components {
16217
16536
  lago_order_form_id: string;
16218
16537
  /** @description Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the order's record within the Lago system. */
16219
16538
  lago_order_id: string;
16220
- /** @description Filter the results by currency, expressed as an ISO 4217 code. */
16221
- currency: string;
16222
16539
  /** @description Code of the existing plan. */
16223
16540
  plan_code: string;
16224
16541
  /** @description Code of the existing charge. */
@@ -16235,7 +16552,11 @@ export interface components {
16235
16552
  subscription_status: "pending" | "active" | "terminated" | "canceled";
16236
16553
  /** @description External ID of the existing subscription. */
16237
16554
  subscription_external_id_path: string;
16238
- /** @description Signature of the webhook payload */
16555
+ /**
16556
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
16557
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
16558
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
16559
+ */
16239
16560
  webhook_signature: string;
16240
16561
  /** @description Algorithm used to generate the signature */
16241
16562
  webhook_signature_algorithm: "jwt" | "hmac";
@@ -16292,7 +16613,9 @@ export interface operations {
16292
16613
  [name: string]: unknown;
16293
16614
  };
16294
16615
  content: {
16295
- "application/json": components["schemas"]["BillingEntityObject"];
16616
+ "application/json": {
16617
+ billing_entity: components["schemas"]["BillingEntityObject"];
16618
+ };
16296
16619
  };
16297
16620
  };
16298
16621
  400: components["responses"]["BadRequest"];
@@ -16306,7 +16629,7 @@ export interface operations {
16306
16629
  query?: never;
16307
16630
  header?: never;
16308
16631
  path: {
16309
- /** @description The ID of the billing entity */
16632
+ /** @description The unique code of the billing entity */
16310
16633
  code: string;
16311
16634
  };
16312
16635
  cookie?: never;
@@ -16334,13 +16657,13 @@ export interface operations {
16334
16657
  query?: never;
16335
16658
  header?: never;
16336
16659
  path: {
16337
- /** @description The ID of the billing entity */
16660
+ /** @description The unique code of the billing entity */
16338
16661
  code: string;
16339
16662
  };
16340
16663
  cookie?: never;
16341
16664
  };
16342
16665
  /** @description The billing entity update payload */
16343
- requestBody?: {
16666
+ requestBody: {
16344
16667
  content: {
16345
16668
  "application/json": components["schemas"]["BillingEntityUpdateInput"];
16346
16669
  };
@@ -16352,7 +16675,9 @@ export interface operations {
16352
16675
  [name: string]: unknown;
16353
16676
  };
16354
16677
  content: {
16355
- "application/json": components["schemas"]["BillingEntityObjectExtended"];
16678
+ "application/json": {
16679
+ billing_entity: components["schemas"]["BillingEntityObjectExtended"];
16680
+ };
16356
16681
  };
16357
16682
  };
16358
16683
  400: components["responses"]["BadRequest"];
@@ -17369,9 +17694,9 @@ export interface operations {
17369
17694
  currency?: string;
17370
17695
  /** @description Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`. */
17371
17696
  reason?: "product_unsatisfactory" | "order_change" | "order_cancellation" | "fraudulent_charge" | "duplicated_charge" | "other";
17372
- /** @description Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`. */
17697
+ /** @description Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`. */
17373
17698
  credit_status?: "available" | "consumed" | "voided";
17374
- /** @description Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`. */
17699
+ /** @description Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`. */
17375
17700
  refund_status?: "pending" | "succeeded" | "failed";
17376
17701
  /** @description Filter credit notes by their related invoice number. */
17377
17702
  invoice_number?: string;
@@ -17381,6 +17706,8 @@ export interface operations {
17381
17706
  amount_from?: number;
17382
17707
  /** @description Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. */
17383
17708
  amount_to?: number;
17709
+ /** @description Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded amount and `offset` those with an amount deducted from the invoice balance. A credit note can match several types. */
17710
+ "types[]"?: ("credit" | "refund" | "offset")[];
17384
17711
  /** @description Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`. */
17385
17712
  self_billed?: boolean;
17386
17713
  /** @description Filter credit notes by billing entity codes. */
@@ -17687,6 +18014,8 @@ export interface operations {
17687
18014
  page?: components["parameters"]["page"];
17688
18015
  /** @description Number of records per page. */
17689
18016
  per_page?: components["parameters"]["per_page"];
18017
+ /** @description Filter customers by external ID. */
18018
+ external_id?: string;
17690
18019
  /** @description Filter customers by account type. */
17691
18020
  "account_type[]"?: ("customer" | "partner")[];
17692
18021
  /** @description Filter customers by billing entity codes. */
@@ -18015,6 +18344,8 @@ export interface operations {
18015
18344
  page?: components["parameters"]["page"];
18016
18345
  /** @description Number of records per page. */
18017
18346
  per_page?: components["parameters"]["per_page"];
18347
+ /** @description Filter the results by currency, expressed as an ISO 4217 code. */
18348
+ currency?: components["parameters"]["currency"];
18018
18349
  /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
18019
18350
  payment_status?: components["parameters"]["payment_status"];
18020
18351
  /** @description Filter payment requests by billing entity codes. */
@@ -18082,6 +18413,8 @@ export interface operations {
18082
18413
  page?: components["parameters"]["page"];
18083
18414
  /** @description Number of records per page. */
18084
18415
  per_page?: components["parameters"]["per_page"];
18416
+ /** @description The subscription external unique identifier (provided by your own application). */
18417
+ external_id?: string;
18085
18418
  /** @description The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans. */
18086
18419
  plan_code?: string;
18087
18420
  /** @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`. */
@@ -18118,6 +18451,8 @@ export interface operations {
18118
18451
  page?: components["parameters"]["page"];
18119
18452
  /** @description Number of records per page. */
18120
18453
  per_page?: components["parameters"]["per_page"];
18454
+ /** @description Filter the results by currency, expressed as an ISO 4217 code. */
18455
+ currency?: components["parameters"]["currency"];
18121
18456
  /** @description Filter wallets by billing entity codes. */
18122
18457
  "billing_entity_codes[]"?: string[];
18123
18458
  };
@@ -18390,7 +18725,12 @@ export interface operations {
18390
18725
  };
18391
18726
  getCustomerWalletAlerts: {
18392
18727
  parameters: {
18393
- query?: never;
18728
+ query?: {
18729
+ /** @description Page number. */
18730
+ page?: components["parameters"]["page"];
18731
+ /** @description Number of records per page. */
18732
+ per_page?: components["parameters"]["per_page"];
18733
+ };
18394
18734
  header?: never;
18395
18735
  path: {
18396
18736
  /** @description The customer external unique identifier (provided by your own application) */
@@ -18769,7 +19109,7 @@ export interface operations {
18769
19109
  };
18770
19110
  requestBody?: never;
18771
19111
  responses: {
18772
- /** @description Return a 200 status to indicate that the data was received successfully */
19112
+ /** @description Payment method set as default */
18773
19113
  200: {
18774
19114
  headers: {
18775
19115
  [name: string]: unknown;
@@ -19034,29 +19374,29 @@ export interface operations {
19034
19374
  external_subscription_id?: components["parameters"]["external_subscription_id"];
19035
19375
  /** @description Filter results by event transaction ID */
19036
19376
  event_transaction_id?: string;
19037
- /** @description Filter results by fee"s currency. */
19377
+ /** @description Filter results by the fee's currency. */
19038
19378
  currency?: components["schemas"]["Currency"] & unknown;
19039
- /** @description The fee type. Possible values are `add-on`, `charge`, `credit`, `subscription` or "commitment". */
19040
- fee_type?: "charge" | "add_on" | "subscription" | "credit" | "commitment";
19379
+ /** @description The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`. */
19380
+ fee_type?: "charge" | "fixed_charge" | "add_on" | "subscription" | "credit" | "commitment";
19041
19381
  /** @description Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types. */
19042
19382
  billable_metric_code?: string;
19043
- /** @description Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and refunded`. */
19383
+ /** @description Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and `refunded`. */
19044
19384
  payment_status?: "pending" | "succeeded" | "failed" | "refunded";
19045
- /** @description Filter results created after creation date and time in UTC. */
19385
+ /** @description Filter results created at or after this date and time in UTC. */
19046
19386
  created_at_from?: string;
19047
- /** @description Filter results created before creation date and time in UTC. */
19387
+ /** @description Filter results created at or before this date and time in UTC. */
19048
19388
  created_at_to?: string;
19049
- /** @description Filter results with payment success after creation date and time in UTC. */
19389
+ /** @description Filter results with a payment success at or after this date and time in UTC. */
19050
19390
  succeeded_at_from?: string;
19051
- /** @description Filter results with payment success after creation date and time in UTC. */
19391
+ /** @description Filter results with a payment success at or before this date and time in UTC. */
19052
19392
  succeeded_at_to?: string;
19053
- /** @description Filter results with payment failure after creation date and time in UTC. */
19393
+ /** @description Filter results with a payment failure at or after this date and time in UTC. */
19054
19394
  failed_at_from?: string;
19055
- /** @description Filter results with payment failure after creation date and time in UTC. */
19395
+ /** @description Filter results with a payment failure at or before this date and time in UTC. */
19056
19396
  failed_at_to?: string;
19057
- /** @description Filter results with payment refund after creation date and time in UTC. */
19397
+ /** @description Filter results with a payment refund at or after this date and time in UTC. */
19058
19398
  refunded_at_from?: string;
19059
- /** @description Filter results with payment refund after creation date and time in UTC. */
19399
+ /** @description Filter results with a payment refund at or before this date and time in UTC. */
19060
19400
  refunded_at_to?: string;
19061
19401
  };
19062
19402
  header?: never;
@@ -19191,6 +19531,10 @@ export interface operations {
19191
19531
  currency?: string;
19192
19532
  /** @description Filter invoices with a payment dispute lost. Possible values are `true` or `false`. */
19193
19533
  payment_dispute_lost?: boolean;
19534
+ /** @description Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned. When `false`, those invoices are excluded. */
19535
+ partially_paid?: boolean;
19536
+ /** @description Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note` matches invoices settled by a credit note. */
19537
+ "settlements[]"?: ("payment" | "credit_note")[];
19194
19538
  /** @description Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`. */
19195
19539
  invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
19196
19540
  /** @description Filter invoices by self billed. Possible values are `true` or `false`. */
@@ -19302,6 +19646,7 @@ export interface operations {
19302
19646
  400: components["responses"]["BadRequest"];
19303
19647
  401: components["responses"]["Unauthorized"];
19304
19648
  404: components["responses"]["NotFound"];
19649
+ 405: components["responses"]["NotAllowed"];
19305
19650
  422: components["responses"]["UnprocessableEntity"];
19306
19651
  };
19307
19652
  };
@@ -19812,6 +20157,27 @@ export interface operations {
19812
20157
  422: components["responses"]["UnprocessableEntity"];
19813
20158
  };
19814
20159
  };
20160
+ findOrganization: {
20161
+ parameters: {
20162
+ query?: never;
20163
+ header?: never;
20164
+ path?: never;
20165
+ cookie?: never;
20166
+ };
20167
+ requestBody?: never;
20168
+ responses: {
20169
+ /** @description Organization */
20170
+ 200: {
20171
+ headers: {
20172
+ [name: string]: unknown;
20173
+ };
20174
+ content: {
20175
+ "application/json": components["schemas"]["Organization"];
20176
+ };
20177
+ };
20178
+ 401: components["responses"]["Unauthorized"];
20179
+ };
20180
+ };
19815
20181
  updateOrganization: {
19816
20182
  parameters: {
19817
20183
  query?: never;
@@ -19873,7 +20239,7 @@ export interface operations {
19873
20239
  query?: never;
19874
20240
  header?: never;
19875
20241
  path: {
19876
- /** @description Payment receipt ID */
20242
+ /** @description Unique identifier of the payment receipt. */
19877
20243
  lago_id: string;
19878
20244
  };
19879
20245
  cookie?: never;
@@ -21181,8 +21547,12 @@ export interface operations {
21181
21547
  currency?: components["parameters"]["currency"];
21182
21548
  /** @description The customer external unique identifier (provided by your own application) */
21183
21549
  external_customer_id?: string;
21550
+ /** @description Filter subscriptions by their external unique identifier (provided by your own application). */
21551
+ external_id?: string;
21184
21552
  /** @description The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans. */
21185
21553
  plan_code?: string;
21554
+ /** @description When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden plans; `false` returns only those on standard (non-overridden) plans. */
21555
+ overridden?: boolean;
21186
21556
  /** @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`. */
21187
21557
  "status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
21188
21558
  /** @description Filter subscriptions by billing entity codes. */
@@ -21417,9 +21787,13 @@ export interface operations {
21417
21787
  query?: {
21418
21788
  /** @description Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`. */
21419
21789
  subscription_status?: components["parameters"]["subscription_status"];
21420
- };
21421
- header?: never;
21422
- path: {
21790
+ /** @description Page number. */
21791
+ page?: components["parameters"]["page"];
21792
+ /** @description Number of records per page. */
21793
+ per_page?: components["parameters"]["per_page"];
21794
+ };
21795
+ header?: never;
21796
+ path: {
21423
21797
  /** @description External ID of the existing subscription */
21424
21798
  external_id: string;
21425
21799
  };
@@ -22267,15 +22641,15 @@ export interface operations {
22267
22641
  };
22268
22642
  findAllWallets: {
22269
22643
  parameters: {
22270
- query: {
22644
+ query?: {
22271
22645
  /** @description Page number. */
22272
22646
  page?: components["parameters"]["page"];
22273
22647
  /** @description Number of records per page. */
22274
22648
  per_page?: components["parameters"]["per_page"];
22275
22649
  /** @description Filter the results by currency, expressed as an ISO 4217 code. */
22276
22650
  currency?: components["parameters"]["currency"];
22277
- /** @description The customer external unique identifier (provided by your own application). */
22278
- external_customer_id: string;
22651
+ /** @description Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization are returned. */
22652
+ external_customer_id?: string;
22279
22653
  /** @description Filter wallets by billing entity codes. */
22280
22654
  "billing_entity_codes[]"?: string[];
22281
22655
  };
@@ -22684,6 +23058,8 @@ export interface operations {
22684
23058
  transaction_status?: string;
22685
23059
  /** @description The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance). */
22686
23060
  transaction_type?: string;
23061
+ /** @description Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`. */
23062
+ "metadata[key]"?: string;
22687
23063
  };
22688
23064
  header?: never;
22689
23065
  path: {
@@ -22891,7 +23267,11 @@ export interface operations {
22891
23267
  parameters: {
22892
23268
  query?: never;
22893
23269
  header: {
22894
- /** @description Signature of the webhook payload */
23270
+ /**
23271
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23272
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23273
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23274
+ */
22895
23275
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
22896
23276
  /** @description Algorithm used to generate the signature */
22897
23277
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -22933,7 +23313,11 @@ export interface operations {
22933
23313
  parameters: {
22934
23314
  query?: never;
22935
23315
  header: {
22936
- /** @description Signature of the webhook payload */
23316
+ /**
23317
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23318
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23319
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23320
+ */
22937
23321
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
22938
23322
  /** @description Algorithm used to generate the signature */
22939
23323
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -22975,7 +23359,11 @@ export interface operations {
22975
23359
  parameters: {
22976
23360
  query?: never;
22977
23361
  header: {
22978
- /** @description Signature of the webhook payload */
23362
+ /**
23363
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23364
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23365
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23366
+ */
22979
23367
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
22980
23368
  /** @description Algorithm used to generate the signature */
22981
23369
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23017,7 +23405,11 @@ export interface operations {
23017
23405
  parameters: {
23018
23406
  query?: never;
23019
23407
  header: {
23020
- /** @description Signature of the webhook payload */
23408
+ /**
23409
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23410
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23411
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23412
+ */
23021
23413
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23022
23414
  /** @description Algorithm used to generate the signature */
23023
23415
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23059,7 +23451,11 @@ export interface operations {
23059
23451
  parameters: {
23060
23452
  query?: never;
23061
23453
  header: {
23062
- /** @description Signature of the webhook payload */
23454
+ /**
23455
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23456
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23457
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23458
+ */
23063
23459
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23064
23460
  /** @description Algorithm used to generate the signature */
23065
23461
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23101,7 +23497,11 @@ export interface operations {
23101
23497
  parameters: {
23102
23498
  query?: never;
23103
23499
  header: {
23104
- /** @description Signature of the webhook payload */
23500
+ /**
23501
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23502
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23503
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23504
+ */
23105
23505
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23106
23506
  /** @description Algorithm used to generate the signature */
23107
23507
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23143,7 +23543,11 @@ export interface operations {
23143
23543
  parameters: {
23144
23544
  query?: never;
23145
23545
  header: {
23146
- /** @description Signature of the webhook payload */
23546
+ /**
23547
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23548
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23549
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23550
+ */
23147
23551
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23148
23552
  /** @description Algorithm used to generate the signature */
23149
23553
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23185,7 +23589,11 @@ export interface operations {
23185
23589
  parameters: {
23186
23590
  query?: never;
23187
23591
  header: {
23188
- /** @description Signature of the webhook payload */
23592
+ /**
23593
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23594
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23595
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23596
+ */
23189
23597
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23190
23598
  /** @description Algorithm used to generate the signature */
23191
23599
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23209,7 +23617,7 @@ export interface operations {
23209
23617
  * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
23210
23618
  */
23211
23619
  organization_id: string;
23212
- accounting_provider_customer_error: components["schemas"]["CustomerIntegratrionErrorObject"];
23620
+ accounting_provider_customer_error: components["schemas"]["CustomerIntegrationErrorObject"];
23213
23621
  };
23214
23622
  };
23215
23623
  };
@@ -23227,7 +23635,11 @@ export interface operations {
23227
23635
  parameters: {
23228
23636
  query?: never;
23229
23637
  header: {
23230
- /** @description Signature of the webhook payload */
23638
+ /**
23639
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23640
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23641
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23642
+ */
23231
23643
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23232
23644
  /** @description Algorithm used to generate the signature */
23233
23645
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23269,7 +23681,11 @@ export interface operations {
23269
23681
  parameters: {
23270
23682
  query?: never;
23271
23683
  header: {
23272
- /** @description Signature of the webhook payload */
23684
+ /**
23685
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23686
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23687
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23688
+ */
23273
23689
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23274
23690
  /** @description Algorithm used to generate the signature */
23275
23691
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23293,7 +23709,7 @@ export interface operations {
23293
23709
  * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
23294
23710
  */
23295
23711
  organization_id: string;
23296
- crm_provider_customer_error: components["schemas"]["CustomerIntegratrionErrorObject"];
23712
+ crm_provider_customer_error: components["schemas"]["CustomerIntegrationErrorObject"];
23297
23713
  };
23298
23714
  };
23299
23715
  };
@@ -23311,7 +23727,11 @@ export interface operations {
23311
23727
  parameters: {
23312
23728
  query?: never;
23313
23729
  header: {
23314
- /** @description Signature of the webhook payload */
23730
+ /**
23731
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23732
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23733
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23734
+ */
23315
23735
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23316
23736
  /** @description Algorithm used to generate the signature */
23317
23737
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23353,7 +23773,11 @@ export interface operations {
23353
23773
  parameters: {
23354
23774
  query?: never;
23355
23775
  header: {
23356
- /** @description Signature of the webhook payload */
23776
+ /**
23777
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23778
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23779
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23780
+ */
23357
23781
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23358
23782
  /** @description Algorithm used to generate the signature */
23359
23783
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23395,7 +23819,11 @@ export interface operations {
23395
23819
  parameters: {
23396
23820
  query?: never;
23397
23821
  header: {
23398
- /** @description Signature of the webhook payload */
23822
+ /**
23823
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23824
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23825
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23826
+ */
23399
23827
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23400
23828
  /** @description Algorithm used to generate the signature */
23401
23829
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23437,7 +23865,11 @@ export interface operations {
23437
23865
  parameters: {
23438
23866
  query?: never;
23439
23867
  header: {
23440
- /** @description Signature of the webhook payload */
23868
+ /**
23869
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23870
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23871
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23872
+ */
23441
23873
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23442
23874
  /** @description Algorithm used to generate the signature */
23443
23875
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23479,7 +23911,11 @@ export interface operations {
23479
23911
  parameters: {
23480
23912
  query?: never;
23481
23913
  header: {
23482
- /** @description Signature of the webhook payload */
23914
+ /**
23915
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23916
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23917
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23918
+ */
23483
23919
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23484
23920
  /** @description Algorithm used to generate the signature */
23485
23921
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23521,7 +23957,11 @@ export interface operations {
23521
23957
  parameters: {
23522
23958
  query?: never;
23523
23959
  header: {
23524
- /** @description Signature of the webhook payload */
23960
+ /**
23961
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
23962
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
23963
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
23964
+ */
23525
23965
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23526
23966
  /** @description Algorithm used to generate the signature */
23527
23967
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23563,7 +24003,11 @@ export interface operations {
23563
24003
  parameters: {
23564
24004
  query?: never;
23565
24005
  header: {
23566
- /** @description Signature of the webhook payload */
24006
+ /**
24007
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24008
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24009
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24010
+ */
23567
24011
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23568
24012
  /** @description Algorithm used to generate the signature */
23569
24013
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23605,7 +24049,11 @@ export interface operations {
23605
24049
  parameters: {
23606
24050
  query?: never;
23607
24051
  header: {
23608
- /** @description Signature of the webhook payload */
24052
+ /**
24053
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24054
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24055
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24056
+ */
23609
24057
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23610
24058
  /** @description Algorithm used to generate the signature */
23611
24059
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23641,7 +24089,11 @@ export interface operations {
23641
24089
  parameters: {
23642
24090
  query?: never;
23643
24091
  header: {
23644
- /** @description Signature of the webhook payload */
24092
+ /**
24093
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24094
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24095
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24096
+ */
23645
24097
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23646
24098
  /** @description Algorithm used to generate the signature */
23647
24099
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23683,7 +24135,11 @@ export interface operations {
23683
24135
  parameters: {
23684
24136
  query?: never;
23685
24137
  header: {
23686
- /** @description Signature of the webhook payload */
24138
+ /**
24139
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24140
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24141
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24142
+ */
23687
24143
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23688
24144
  /** @description Algorithm used to generate the signature */
23689
24145
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23725,7 +24181,11 @@ export interface operations {
23725
24181
  parameters: {
23726
24182
  query?: never;
23727
24183
  header: {
23728
- /** @description Signature of the webhook payload */
24184
+ /**
24185
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24186
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24187
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24188
+ */
23729
24189
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23730
24190
  /** @description Algorithm used to generate the signature */
23731
24191
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23767,7 +24227,11 @@ export interface operations {
23767
24227
  parameters: {
23768
24228
  query?: never;
23769
24229
  header: {
23770
- /** @description Signature of the webhook payload */
24230
+ /**
24231
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24232
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24233
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24234
+ */
23771
24235
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23772
24236
  /** @description Algorithm used to generate the signature */
23773
24237
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23809,7 +24273,11 @@ export interface operations {
23809
24273
  parameters: {
23810
24274
  query?: never;
23811
24275
  header: {
23812
- /** @description Signature of the webhook payload */
24276
+ /**
24277
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24278
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24279
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24280
+ */
23813
24281
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23814
24282
  /** @description Algorithm used to generate the signature */
23815
24283
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23851,7 +24319,11 @@ export interface operations {
23851
24319
  parameters: {
23852
24320
  query?: never;
23853
24321
  header: {
23854
- /** @description Signature of the webhook payload */
24322
+ /**
24323
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24324
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24325
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24326
+ */
23855
24327
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23856
24328
  /** @description Algorithm used to generate the signature */
23857
24329
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23893,7 +24365,11 @@ export interface operations {
23893
24365
  parameters: {
23894
24366
  query?: never;
23895
24367
  header: {
23896
- /** @description Signature of the webhook payload */
24368
+ /**
24369
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24370
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24371
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24372
+ */
23897
24373
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23898
24374
  /** @description Algorithm used to generate the signature */
23899
24375
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23935,7 +24411,11 @@ export interface operations {
23935
24411
  parameters: {
23936
24412
  query?: never;
23937
24413
  header: {
23938
- /** @description Signature of the webhook payload */
24414
+ /**
24415
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24416
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24417
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24418
+ */
23939
24419
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23940
24420
  /** @description Algorithm used to generate the signature */
23941
24421
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -23977,7 +24457,11 @@ export interface operations {
23977
24457
  parameters: {
23978
24458
  query?: never;
23979
24459
  header: {
23980
- /** @description Signature of the webhook payload */
24460
+ /**
24461
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24462
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24463
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24464
+ */
23981
24465
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
23982
24466
  /** @description Algorithm used to generate the signature */
23983
24467
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24019,7 +24503,11 @@ export interface operations {
24019
24503
  parameters: {
24020
24504
  query?: never;
24021
24505
  header: {
24022
- /** @description Signature of the webhook payload */
24506
+ /**
24507
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24508
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24509
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24510
+ */
24023
24511
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24024
24512
  /** @description Algorithm used to generate the signature */
24025
24513
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24061,7 +24549,11 @@ export interface operations {
24061
24549
  parameters: {
24062
24550
  query?: never;
24063
24551
  header: {
24064
- /** @description Signature of the webhook payload */
24552
+ /**
24553
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24554
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24555
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24556
+ */
24065
24557
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24066
24558
  /** @description Algorithm used to generate the signature */
24067
24559
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24103,7 +24595,11 @@ export interface operations {
24103
24595
  parameters: {
24104
24596
  query?: never;
24105
24597
  header: {
24106
- /** @description Signature of the webhook payload */
24598
+ /**
24599
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24600
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24601
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24602
+ */
24107
24603
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24108
24604
  /** @description Algorithm used to generate the signature */
24109
24605
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24145,7 +24641,11 @@ export interface operations {
24145
24641
  parameters: {
24146
24642
  query?: never;
24147
24643
  header: {
24148
- /** @description Signature of the webhook payload */
24644
+ /**
24645
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24646
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24647
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24648
+ */
24149
24649
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24150
24650
  /** @description Algorithm used to generate the signature */
24151
24651
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24187,7 +24687,11 @@ export interface operations {
24187
24687
  parameters: {
24188
24688
  query?: never;
24189
24689
  header: {
24190
- /** @description Signature of the webhook payload */
24690
+ /**
24691
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24692
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24693
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24694
+ */
24191
24695
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24192
24696
  /** @description Algorithm used to generate the signature */
24193
24697
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24229,7 +24733,11 @@ export interface operations {
24229
24733
  parameters: {
24230
24734
  query?: never;
24231
24735
  header: {
24232
- /** @description Signature of the webhook payload */
24736
+ /**
24737
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24738
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24739
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24740
+ */
24233
24741
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24234
24742
  /** @description Algorithm used to generate the signature */
24235
24743
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24271,7 +24779,11 @@ export interface operations {
24271
24779
  parameters: {
24272
24780
  query?: never;
24273
24781
  header: {
24274
- /** @description Signature of the webhook payload */
24782
+ /**
24783
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24784
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24785
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24786
+ */
24275
24787
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24276
24788
  /** @description Algorithm used to generate the signature */
24277
24789
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24313,7 +24825,11 @@ export interface operations {
24313
24825
  parameters: {
24314
24826
  query?: never;
24315
24827
  header: {
24316
- /** @description Signature of the webhook payload */
24828
+ /**
24829
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24830
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24831
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24832
+ */
24317
24833
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24318
24834
  /** @description Algorithm used to generate the signature */
24319
24835
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24355,7 +24871,11 @@ export interface operations {
24355
24871
  parameters: {
24356
24872
  query?: never;
24357
24873
  header: {
24358
- /** @description Signature of the webhook payload */
24874
+ /**
24875
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24876
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24877
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24878
+ */
24359
24879
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24360
24880
  /** @description Algorithm used to generate the signature */
24361
24881
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24397,7 +24917,11 @@ export interface operations {
24397
24917
  parameters: {
24398
24918
  query?: never;
24399
24919
  header: {
24400
- /** @description Signature of the webhook payload */
24920
+ /**
24921
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24922
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24923
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24924
+ */
24401
24925
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24402
24926
  /** @description Algorithm used to generate the signature */
24403
24927
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24439,7 +24963,11 @@ export interface operations {
24439
24963
  parameters: {
24440
24964
  query?: never;
24441
24965
  header: {
24442
- /** @description Signature of the webhook payload */
24966
+ /**
24967
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
24968
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
24969
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
24970
+ */
24443
24971
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24444
24972
  /** @description Algorithm used to generate the signature */
24445
24973
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24481,7 +25009,11 @@ export interface operations {
24481
25009
  parameters: {
24482
25010
  query?: never;
24483
25011
  header: {
24484
- /** @description Signature of the webhook payload */
25012
+ /**
25013
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25014
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25015
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25016
+ */
24485
25017
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24486
25018
  /** @description Algorithm used to generate the signature */
24487
25019
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24523,7 +25055,11 @@ export interface operations {
24523
25055
  parameters: {
24524
25056
  query?: never;
24525
25057
  header: {
24526
- /** @description Signature of the webhook payload */
25058
+ /**
25059
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25060
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25061
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25062
+ */
24527
25063
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24528
25064
  /** @description Algorithm used to generate the signature */
24529
25065
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24565,7 +25101,11 @@ export interface operations {
24565
25101
  parameters: {
24566
25102
  query?: never;
24567
25103
  header: {
24568
- /** @description Signature of the webhook payload */
25104
+ /**
25105
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25106
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25107
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25108
+ */
24569
25109
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24570
25110
  /** @description Algorithm used to generate the signature */
24571
25111
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24607,7 +25147,11 @@ export interface operations {
24607
25147
  parameters: {
24608
25148
  query?: never;
24609
25149
  header: {
24610
- /** @description Signature of the webhook payload */
25150
+ /**
25151
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25152
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25153
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25154
+ */
24611
25155
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24612
25156
  /** @description Algorithm used to generate the signature */
24613
25157
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24649,7 +25193,11 @@ export interface operations {
24649
25193
  parameters: {
24650
25194
  query?: never;
24651
25195
  header: {
24652
- /** @description Signature of the webhook payload */
25196
+ /**
25197
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25198
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25199
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25200
+ */
24653
25201
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24654
25202
  /** @description Algorithm used to generate the signature */
24655
25203
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24691,7 +25239,11 @@ export interface operations {
24691
25239
  parameters: {
24692
25240
  query?: never;
24693
25241
  header: {
24694
- /** @description Signature of the webhook payload */
25242
+ /**
25243
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25244
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25245
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25246
+ */
24695
25247
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24696
25248
  /** @description Algorithm used to generate the signature */
24697
25249
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24733,7 +25285,11 @@ export interface operations {
24733
25285
  parameters: {
24734
25286
  query?: never;
24735
25287
  header: {
24736
- /** @description Signature of the webhook payload */
25288
+ /**
25289
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25290
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25291
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25292
+ */
24737
25293
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24738
25294
  /** @description Algorithm used to generate the signature */
24739
25295
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24775,7 +25331,11 @@ export interface operations {
24775
25331
  parameters: {
24776
25332
  query?: never;
24777
25333
  header: {
24778
- /** @description Signature of the webhook payload */
25334
+ /**
25335
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25336
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25337
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25338
+ */
24779
25339
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24780
25340
  /** @description Algorithm used to generate the signature */
24781
25341
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24817,7 +25377,11 @@ export interface operations {
24817
25377
  parameters: {
24818
25378
  query?: never;
24819
25379
  header: {
24820
- /** @description Signature of the webhook payload */
25380
+ /**
25381
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25382
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25383
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25384
+ */
24821
25385
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24822
25386
  /** @description Algorithm used to generate the signature */
24823
25387
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24859,7 +25423,11 @@ export interface operations {
24859
25423
  parameters: {
24860
25424
  query?: never;
24861
25425
  header: {
24862
- /** @description Signature of the webhook payload */
25426
+ /**
25427
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25428
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25429
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25430
+ */
24863
25431
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24864
25432
  /** @description Algorithm used to generate the signature */
24865
25433
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24901,7 +25469,11 @@ export interface operations {
24901
25469
  parameters: {
24902
25470
  query?: never;
24903
25471
  header: {
24904
- /** @description Signature of the webhook payload */
25472
+ /**
25473
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25474
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25475
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25476
+ */
24905
25477
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24906
25478
  /** @description Algorithm used to generate the signature */
24907
25479
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24943,7 +25515,11 @@ export interface operations {
24943
25515
  parameters: {
24944
25516
  query?: never;
24945
25517
  header: {
24946
- /** @description Signature of the webhook payload */
25518
+ /**
25519
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25520
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25521
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25522
+ */
24947
25523
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24948
25524
  /** @description Algorithm used to generate the signature */
24949
25525
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -24981,11 +25557,107 @@ export interface operations {
24981
25557
  };
24982
25558
  };
24983
25559
  };
25560
+ paymentReceiptCreated: {
25561
+ parameters: {
25562
+ query?: never;
25563
+ header: {
25564
+ /**
25565
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25566
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25567
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25568
+ */
25569
+ "X-Lago-Signature": components["parameters"]["webhook_signature"];
25570
+ /** @description Algorithm used to generate the signature */
25571
+ "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
25572
+ /** @description Unique id of the webhook. It can be used for idempotency */
25573
+ "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
25574
+ };
25575
+ path?: never;
25576
+ cookie?: never;
25577
+ };
25578
+ /** @description Details of the new payment receipt */
25579
+ requestBody?: {
25580
+ content: {
25581
+ "application/json": {
25582
+ /** @enum {string} */
25583
+ webhook_type: "payment_receipt.created";
25584
+ /** @enum {string} */
25585
+ object_type: "payment_receipt";
25586
+ /**
25587
+ * Format: uuid
25588
+ * @description Unique identifier of the organization, created by Lago.
25589
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
25590
+ */
25591
+ organization_id: string;
25592
+ payment_receipt: components["schemas"]["PaymentReceiptObject"];
25593
+ };
25594
+ };
25595
+ };
25596
+ responses: {
25597
+ /** @description Return a 200 status to indicate that the data was received successfully */
25598
+ 200: {
25599
+ headers: {
25600
+ [name: string]: unknown;
25601
+ };
25602
+ content?: never;
25603
+ };
25604
+ };
25605
+ };
25606
+ paymentReceiptGenerated: {
25607
+ parameters: {
25608
+ query?: never;
25609
+ header: {
25610
+ /**
25611
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25612
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25613
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25614
+ */
25615
+ "X-Lago-Signature": components["parameters"]["webhook_signature"];
25616
+ /** @description Algorithm used to generate the signature */
25617
+ "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
25618
+ /** @description Unique id of the webhook. It can be used for idempotency */
25619
+ "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
25620
+ };
25621
+ path?: never;
25622
+ cookie?: never;
25623
+ };
25624
+ /** @description Details of the payment receipt whose PDF has been generated */
25625
+ requestBody?: {
25626
+ content: {
25627
+ "application/json": {
25628
+ /** @enum {string} */
25629
+ webhook_type: "payment_receipt.generated";
25630
+ /** @enum {string} */
25631
+ object_type: "payment_receipt";
25632
+ /**
25633
+ * Format: uuid
25634
+ * @description Unique identifier of the organization, created by Lago.
25635
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
25636
+ */
25637
+ organization_id: string;
25638
+ payment_receipt: components["schemas"]["PaymentReceiptObject"];
25639
+ };
25640
+ };
25641
+ };
25642
+ responses: {
25643
+ /** @description Return a 200 status to indicate that the data was received successfully */
25644
+ 200: {
25645
+ headers: {
25646
+ [name: string]: unknown;
25647
+ };
25648
+ content?: never;
25649
+ };
25650
+ };
25651
+ };
24984
25652
  paymentRequestCreated: {
24985
25653
  parameters: {
24986
25654
  query?: never;
24987
25655
  header: {
24988
- /** @description Signature of the webhook payload */
25656
+ /**
25657
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25658
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25659
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25660
+ */
24989
25661
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
24990
25662
  /** @description Algorithm used to generate the signature */
24991
25663
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25027,7 +25699,11 @@ export interface operations {
25027
25699
  parameters: {
25028
25700
  query?: never;
25029
25701
  header: {
25030
- /** @description Signature of the webhook payload */
25702
+ /**
25703
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25704
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25705
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25706
+ */
25031
25707
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25032
25708
  /** @description Algorithm used to generate the signature */
25033
25709
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25069,7 +25745,11 @@ export interface operations {
25069
25745
  parameters: {
25070
25746
  query?: never;
25071
25747
  header: {
25072
- /** @description Signature of the webhook payload */
25748
+ /**
25749
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25750
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25751
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25752
+ */
25073
25753
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25074
25754
  /** @description Algorithm used to generate the signature */
25075
25755
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25111,7 +25791,11 @@ export interface operations {
25111
25791
  parameters: {
25112
25792
  query?: never;
25113
25793
  header: {
25114
- /** @description Signature of the webhook payload */
25794
+ /**
25795
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25796
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25797
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25798
+ */
25115
25799
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25116
25800
  /** @description Algorithm used to generate the signature */
25117
25801
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25153,7 +25837,11 @@ export interface operations {
25153
25837
  parameters: {
25154
25838
  query?: never;
25155
25839
  header: {
25156
- /** @description Signature of the webhook payload */
25840
+ /**
25841
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25842
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25843
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25844
+ */
25157
25845
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25158
25846
  /** @description Algorithm used to generate the signature */
25159
25847
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25195,7 +25883,11 @@ export interface operations {
25195
25883
  parameters: {
25196
25884
  query?: never;
25197
25885
  header: {
25198
- /** @description Signature of the webhook payload */
25886
+ /**
25887
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25888
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25889
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25890
+ */
25199
25891
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25200
25892
  /** @description Algorithm used to generate the signature */
25201
25893
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25237,7 +25929,11 @@ export interface operations {
25237
25929
  parameters: {
25238
25930
  query?: never;
25239
25931
  header: {
25240
- /** @description Signature of the webhook payload */
25932
+ /**
25933
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25934
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25935
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25936
+ */
25241
25937
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25242
25938
  /** @description Algorithm used to generate the signature */
25243
25939
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25279,7 +25975,11 @@ export interface operations {
25279
25975
  parameters: {
25280
25976
  query?: never;
25281
25977
  header: {
25282
- /** @description Signature of the webhook payload */
25978
+ /**
25979
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
25980
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
25981
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
25982
+ */
25283
25983
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25284
25984
  /** @description Algorithm used to generate the signature */
25285
25985
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25321,7 +26021,11 @@ export interface operations {
25321
26021
  parameters: {
25322
26022
  query?: never;
25323
26023
  header: {
25324
- /** @description Signature of the webhook payload */
26024
+ /**
26025
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26026
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26027
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26028
+ */
25325
26029
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25326
26030
  /** @description Algorithm used to generate the signature */
25327
26031
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25363,7 +26067,11 @@ export interface operations {
25363
26067
  parameters: {
25364
26068
  query?: never;
25365
26069
  header: {
25366
- /** @description Signature of the webhook payload */
26070
+ /**
26071
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26072
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26073
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26074
+ */
25367
26075
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25368
26076
  /** @description Algorithm used to generate the signature */
25369
26077
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25405,7 +26113,11 @@ export interface operations {
25405
26113
  parameters: {
25406
26114
  query?: never;
25407
26115
  header: {
25408
- /** @description Signature of the webhook payload */
26116
+ /**
26117
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26118
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26119
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26120
+ */
25409
26121
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25410
26122
  /** @description Algorithm used to generate the signature */
25411
26123
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25447,7 +26159,11 @@ export interface operations {
25447
26159
  parameters: {
25448
26160
  query?: never;
25449
26161
  header: {
25450
- /** @description Signature of the webhook payload */
26162
+ /**
26163
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26164
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26165
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26166
+ */
25451
26167
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25452
26168
  /** @description Algorithm used to generate the signature */
25453
26169
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25489,7 +26205,11 @@ export interface operations {
25489
26205
  parameters: {
25490
26206
  query?: never;
25491
26207
  header: {
25492
- /** @description Signature of the webhook payload */
26208
+ /**
26209
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26210
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26211
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26212
+ */
25493
26213
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25494
26214
  /** @description Algorithm used to generate the signature */
25495
26215
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25531,7 +26251,11 @@ export interface operations {
25531
26251
  parameters: {
25532
26252
  query?: never;
25533
26253
  header: {
25534
- /** @description Signature of the webhook payload */
26254
+ /**
26255
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26256
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26257
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26258
+ */
25535
26259
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25536
26260
  /** @description Algorithm used to generate the signature */
25537
26261
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25573,7 +26297,11 @@ export interface operations {
25573
26297
  parameters: {
25574
26298
  query?: never;
25575
26299
  header: {
25576
- /** @description Signature of the webhook payload */
26300
+ /**
26301
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26302
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26303
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26304
+ */
25577
26305
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25578
26306
  /** @description Algorithm used to generate the signature */
25579
26307
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25615,7 +26343,11 @@ export interface operations {
25615
26343
  parameters: {
25616
26344
  query?: never;
25617
26345
  header: {
25618
- /** @description Signature of the webhook payload */
26346
+ /**
26347
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26348
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26349
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26350
+ */
25619
26351
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25620
26352
  /** @description Algorithm used to generate the signature */
25621
26353
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25657,7 +26389,11 @@ export interface operations {
25657
26389
  parameters: {
25658
26390
  query?: never;
25659
26391
  header: {
25660
- /** @description Signature of the webhook payload */
26392
+ /**
26393
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26394
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26395
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26396
+ */
25661
26397
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25662
26398
  /** @description Algorithm used to generate the signature */
25663
26399
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25695,11 +26431,153 @@ export interface operations {
25695
26431
  };
25696
26432
  };
25697
26433
  };
26434
+ walletCreated: {
26435
+ parameters: {
26436
+ query?: never;
26437
+ header: {
26438
+ /**
26439
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26440
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26441
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26442
+ */
26443
+ "X-Lago-Signature": components["parameters"]["webhook_signature"];
26444
+ /** @description Algorithm used to generate the signature */
26445
+ "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
26446
+ /** @description Unique id of the webhook. It can be used for idempotency */
26447
+ "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
26448
+ };
26449
+ path?: never;
26450
+ cookie?: never;
26451
+ };
26452
+ /** @description Details of the new wallet */
26453
+ requestBody?: {
26454
+ content: {
26455
+ "application/json": {
26456
+ /** @enum {string} */
26457
+ webhook_type: "wallet.created";
26458
+ /** @enum {string} */
26459
+ object_type: "wallet";
26460
+ /**
26461
+ * Format: uuid
26462
+ * @description Unique identifier of the organization, created by Lago.
26463
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
26464
+ */
26465
+ organization_id: string;
26466
+ wallet: components["schemas"]["WalletObject"];
26467
+ };
26468
+ };
26469
+ };
26470
+ responses: {
26471
+ /** @description Return a 200 status to indicate that the data was received successfully */
26472
+ 200: {
26473
+ headers: {
26474
+ [name: string]: unknown;
26475
+ };
26476
+ content?: never;
26477
+ };
26478
+ };
26479
+ };
26480
+ walletUpdated: {
26481
+ parameters: {
26482
+ query?: never;
26483
+ header: {
26484
+ /**
26485
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26486
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26487
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26488
+ */
26489
+ "X-Lago-Signature": components["parameters"]["webhook_signature"];
26490
+ /** @description Algorithm used to generate the signature */
26491
+ "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
26492
+ /** @description Unique id of the webhook. It can be used for idempotency */
26493
+ "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
26494
+ };
26495
+ path?: never;
26496
+ cookie?: never;
26497
+ };
26498
+ /** @description Details of the updated wallet */
26499
+ requestBody?: {
26500
+ content: {
26501
+ "application/json": {
26502
+ /** @enum {string} */
26503
+ webhook_type: "wallet.updated";
26504
+ /** @enum {string} */
26505
+ object_type: "wallet";
26506
+ /**
26507
+ * Format: uuid
26508
+ * @description Unique identifier of the organization, created by Lago.
26509
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
26510
+ */
26511
+ organization_id: string;
26512
+ wallet: components["schemas"]["WalletObject"];
26513
+ };
26514
+ };
26515
+ };
26516
+ responses: {
26517
+ /** @description Return a 200 status to indicate that the data was received successfully */
26518
+ 200: {
26519
+ headers: {
26520
+ [name: string]: unknown;
26521
+ };
26522
+ content?: never;
26523
+ };
26524
+ };
26525
+ };
26526
+ walletTerminated: {
26527
+ parameters: {
26528
+ query?: never;
26529
+ header: {
26530
+ /**
26531
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26532
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26533
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26534
+ */
26535
+ "X-Lago-Signature": components["parameters"]["webhook_signature"];
26536
+ /** @description Algorithm used to generate the signature */
26537
+ "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
26538
+ /** @description Unique id of the webhook. It can be used for idempotency */
26539
+ "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
26540
+ };
26541
+ path?: never;
26542
+ cookie?: never;
26543
+ };
26544
+ /** @description Details of the terminated wallet */
26545
+ requestBody?: {
26546
+ content: {
26547
+ "application/json": {
26548
+ /** @enum {string} */
26549
+ webhook_type: "wallet.terminated";
26550
+ /** @enum {string} */
26551
+ object_type: "wallet";
26552
+ /**
26553
+ * Format: uuid
26554
+ * @description Unique identifier of the organization, created by Lago.
26555
+ * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
26556
+ */
26557
+ organization_id: string;
26558
+ wallet: components["schemas"]["WalletObject"];
26559
+ };
26560
+ };
26561
+ };
26562
+ responses: {
26563
+ /** @description Return a 200 status to indicate that the data was received successfully */
26564
+ 200: {
26565
+ headers: {
26566
+ [name: string]: unknown;
26567
+ };
26568
+ content?: never;
26569
+ };
26570
+ };
26571
+ };
25698
26572
  walletDepletedOngoingBalance: {
25699
26573
  parameters: {
25700
26574
  query?: never;
25701
26575
  header: {
25702
- /** @description Signature of the webhook payload */
26576
+ /**
26577
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26578
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26579
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26580
+ */
25703
26581
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25704
26582
  /** @description Algorithm used to generate the signature */
25705
26583
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25741,7 +26619,11 @@ export interface operations {
25741
26619
  parameters: {
25742
26620
  query?: never;
25743
26621
  header: {
25744
- /** @description Signature of the webhook payload */
26622
+ /**
26623
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26624
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26625
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26626
+ */
25745
26627
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25746
26628
  /** @description Algorithm used to generate the signature */
25747
26629
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25783,7 +26665,11 @@ export interface operations {
25783
26665
  parameters: {
25784
26666
  query?: never;
25785
26667
  header: {
25786
- /** @description Signature of the webhook payload */
26668
+ /**
26669
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26670
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26671
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26672
+ */
25787
26673
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25788
26674
  /** @description Algorithm used to generate the signature */
25789
26675
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
@@ -25825,7 +26711,11 @@ export interface operations {
25825
26711
  parameters: {
25826
26712
  query?: never;
25827
26713
  header: {
25828
- /** @description Signature of the webhook payload */
26714
+ /**
26715
+ * @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
26716
+ * `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
26717
+ * `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
26718
+ */
25829
26719
  "X-Lago-Signature": components["parameters"]["webhook_signature"];
25830
26720
  /** @description Algorithm used to generate the signature */
25831
26721
  "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];