lago-javascript-client 1.52.1 → 1.53.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.
- package/esm/openapi/client.d.ts +541 -325
- package/esm/openapi/client.js +21 -5
- package/esm/openapi/webhooks.d.ts +1256 -421
- package/package.json +1 -1
- package/script/openapi/client.d.ts +541 -325
- package/script/openapi/client.js +21 -5
- package/script/openapi/webhooks.d.ts +1256 -421
|
@@ -32,7 +32,7 @@ export interface paths {
|
|
|
32
32
|
query?: never;
|
|
33
33
|
header?: never;
|
|
34
34
|
path: {
|
|
35
|
-
/** @description The
|
|
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;
|
|
@@ -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
|
|
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
|
-
|
|
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.
|
|
@@ -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
|
-
* @
|
|
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;
|
|
@@ -4786,9 +4891,9 @@ export interface components {
|
|
|
4786
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" | "SZL" | "THB" | "TJS" | "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
|
-
|
|
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
|
|
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"]["
|
|
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"]["
|
|
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
|
-
|
|
5249
|
-
|
|
5250
|
-
|
|
5251
|
-
|
|
5252
|
-
|
|
5253
|
-
|
|
5254
|
-
|
|
5255
|
-
|
|
5256
|
-
|
|
5257
|
-
|
|
5258
|
-
|
|
5259
|
-
|
|
5260
|
-
|
|
5261
|
-
|
|
5262
|
-
|
|
5263
|
-
|
|
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
|
|
5277
|
-
* @example
|
|
5399
|
+
* @description The prefix used in document numbers for this billing entity
|
|
5400
|
+
* @example ABC-123
|
|
5278
5401
|
*/
|
|
5279
|
-
|
|
5402
|
+
document_number_prefix?: string | null;
|
|
5280
5403
|
/**
|
|
5281
|
-
* @description
|
|
5282
|
-
* @example
|
|
5404
|
+
* @description Whether to finalize invoices with zero amount for this billing entity
|
|
5405
|
+
* @example true
|
|
5283
5406
|
*/
|
|
5284
|
-
|
|
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
|
|
5438
|
+
* @description The net payment term (in days) for this billing entity
|
|
5287
5439
|
* @example 0
|
|
5288
5440
|
*/
|
|
5289
|
-
|
|
5441
|
+
net_payment_term?: number;
|
|
5290
5442
|
/**
|
|
5291
|
-
* @description
|
|
5292
|
-
* @
|
|
5293
|
-
* @enum {string}
|
|
5443
|
+
* @description The first line of the billing address
|
|
5444
|
+
* @example 5230 Penfield Ave
|
|
5294
5445
|
*/
|
|
5295
|
-
|
|
5446
|
+
address_line1?: string | null;
|
|
5296
5447
|
/**
|
|
5297
|
-
* @description The
|
|
5298
|
-
* @
|
|
5299
|
-
* @enum {string}
|
|
5448
|
+
* @description The second line of the billing address
|
|
5449
|
+
* @example Suite 100
|
|
5300
5450
|
*/
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
|
|
5310
|
-
|
|
5311
|
-
|
|
5312
|
-
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
|
|
5316
|
-
|
|
5317
|
-
|
|
5318
|
-
|
|
5319
|
-
|
|
5320
|
-
|
|
5321
|
-
|
|
5322
|
-
|
|
5323
|
-
|
|
5324
|
-
|
|
5325
|
-
|
|
5326
|
-
|
|
5327
|
-
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
|
|
5331
|
-
|
|
5332
|
-
|
|
5333
|
-
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5337
|
-
|
|
5338
|
-
|
|
5339
|
-
|
|
5340
|
-
|
|
5341
|
-
|
|
5342
|
-
|
|
5343
|
-
|
|
5344
|
-
|
|
5345
|
-
|
|
5346
|
-
|
|
5347
|
-
|
|
5348
|
-
|
|
5349
|
-
|
|
5350
|
-
|
|
5351
|
-
|
|
5352
|
-
|
|
5353
|
-
|
|
5354
|
-
|
|
5355
|
-
|
|
5356
|
-
|
|
5357
|
-
|
|
5358
|
-
|
|
5359
|
-
|
|
5360
|
-
|
|
5361
|
-
|
|
5362
|
-
|
|
5363
|
-
|
|
5364
|
-
|
|
5365
|
-
|
|
5366
|
-
|
|
5367
|
-
|
|
5368
|
-
|
|
5369
|
-
|
|
5370
|
-
|
|
5371
|
-
|
|
5372
|
-
|
|
5373
|
-
|
|
5374
|
-
|
|
5375
|
-
|
|
5376
|
-
|
|
5377
|
-
|
|
5378
|
-
|
|
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
|
|
@@ -6983,6 +7145,12 @@ export interface components {
|
|
|
6983
7145
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
6984
7146
|
*/
|
|
6985
7147
|
lago_true_up_parent_fee_id?: string | null;
|
|
7148
|
+
/**
|
|
7149
|
+
* Format: uuid
|
|
7150
|
+
* @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.
|
|
7151
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
7152
|
+
*/
|
|
7153
|
+
lago_original_fee_id?: string | null;
|
|
6986
7154
|
/**
|
|
6987
7155
|
* Format: uuid
|
|
6988
7156
|
* @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 +7325,13 @@ export interface components {
|
|
|
7157
7325
|
/** @description Item attached to the fee */
|
|
7158
7326
|
item: {
|
|
7159
7327
|
/**
|
|
7160
|
-
* @description The fee type. Possible values are `
|
|
7328
|
+
* @description The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.
|
|
7161
7329
|
* @example subscription
|
|
7162
7330
|
* @enum {string}
|
|
7163
7331
|
*/
|
|
7164
7332
|
type: "charge" | "fixed_charge" | "add_on" | "subscription" | "credit" | "commitment";
|
|
7165
7333
|
/**
|
|
7166
|
-
* @description The code of the fee item. It can be the code of the `
|
|
7334
|
+
* @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
7335
|
* @example startup
|
|
7168
7336
|
*/
|
|
7169
7337
|
code: string;
|
|
@@ -7171,7 +7339,7 @@ export interface components {
|
|
|
7171
7339
|
* @description The name of the fee item. The value depends on the type of the fee item:
|
|
7172
7340
|
*
|
|
7173
7341
|
* - If the fee item is a `charge`, it is the billable metric name.
|
|
7174
|
-
* - If the fee item is
|
|
7342
|
+
* - If the fee item is an `add_on`, it is the add-on name.
|
|
7175
7343
|
* - If the fee item is a `credit`, it is the wallet transaction name if set, or `"credit"` if not.
|
|
7176
7344
|
* - If the fee item is a `fixed_charge`, it is the fixed charge add-on name.
|
|
7177
7345
|
* - For all the other fee items, it is the subscription plan name.
|
|
@@ -7182,7 +7350,7 @@ export interface components {
|
|
|
7182
7350
|
* @description The description of the fee item. The value depends on the type of the fee item:
|
|
7183
7351
|
*
|
|
7184
7352
|
* - If the fee item is a `charge`, it is the billable metric description.
|
|
7185
|
-
* - If the fee item is
|
|
7353
|
+
* - If the fee item is an `add_on`, it is the add-on description.
|
|
7186
7354
|
* - If the fee item is a `credit`, it is always `"credit"`.
|
|
7187
7355
|
* - If the fee item is a `fixed_charge`, it is the fixed charge add-on description.
|
|
7188
7356
|
* - For all the other fee items, it is the subscription plan description.
|
|
@@ -7193,7 +7361,7 @@ export interface components {
|
|
|
7193
7361
|
* @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
7362
|
*
|
|
7195
7363
|
* - 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
|
|
7364
|
+
* - 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
7365
|
* - If the fee item is a `credit`, we'll fallback to the wallet transaction name if set, or `credit` if not.
|
|
7198
7366
|
* - 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
7367
|
* - For all the other fee items, we'll fallback to the `invoice_display_name` of the subscription plan.
|
|
@@ -7211,7 +7379,7 @@ export interface components {
|
|
|
7211
7379
|
} | null;
|
|
7212
7380
|
/**
|
|
7213
7381
|
* Format: uuid
|
|
7214
|
-
* @description Unique identifier of the fee item, created by Lago. It can be the identifier of the `
|
|
7382
|
+
* @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
7383
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
7216
7384
|
*/
|
|
7217
7385
|
lago_item_id: string;
|
|
@@ -7262,11 +7430,6 @@ export interface components {
|
|
|
7262
7430
|
/** @example 100 */
|
|
7263
7431
|
base_amount_cents?: number;
|
|
7264
7432
|
} & 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
7433
|
/**
|
|
7271
7434
|
* @example America/Los_Angeles
|
|
7272
7435
|
* @enum {string|null}
|
|
@@ -7295,11 +7458,11 @@ export interface components {
|
|
|
7295
7458
|
subscription_invoice_issuing_date_adjustment: "align_with_finalization_date" | "keep_anchor" | null;
|
|
7296
7459
|
/**
|
|
7297
7460
|
* @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`.
|
|
7461
|
+
* Accepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`.
|
|
7299
7462
|
* @example stripe
|
|
7300
7463
|
* @enum {string}
|
|
7301
7464
|
*/
|
|
7302
|
-
payment_provider?: "stripe" | "adyen" | "gocardless";
|
|
7465
|
+
payment_provider?: "stripe" | "adyen" | "cashfree" | "flutterwave" | "gocardless" | "moneyhash";
|
|
7303
7466
|
/**
|
|
7304
7467
|
* @description Unique code used to identify a payment provider connection.
|
|
7305
7468
|
* @example stripe-eu-1
|
|
@@ -7411,7 +7574,7 @@ export interface components {
|
|
|
7411
7574
|
*/
|
|
7412
7575
|
lago_id: string;
|
|
7413
7576
|
/**
|
|
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
|
|
7577
|
+
* @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
7578
|
* @example 1
|
|
7416
7579
|
*/
|
|
7417
7580
|
sequential_id: number;
|
|
@@ -7540,6 +7703,11 @@ export interface components {
|
|
|
7540
7703
|
* @example 30
|
|
7541
7704
|
*/
|
|
7542
7705
|
net_payment_term?: number | null;
|
|
7706
|
+
/**
|
|
7707
|
+
* @description The customer ID within the Salesforce system
|
|
7708
|
+
* @example 0015p00001JQx1QAAT
|
|
7709
|
+
*/
|
|
7710
|
+
external_salesforce_id?: string | null;
|
|
7543
7711
|
/**
|
|
7544
7712
|
* Format: date-time
|
|
7545
7713
|
* @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 +7747,8 @@ export interface components {
|
|
|
7579
7747
|
*/
|
|
7580
7748
|
lago_id: string;
|
|
7581
7749
|
/**
|
|
7582
|
-
* @description The integration type used for accounting and
|
|
7583
|
-
* Accepted values: `netsuite
|
|
7750
|
+
* @description The integration type used for accounting, tax and CRM syncs.
|
|
7751
|
+
* Accepted values: `netsuite`, `anrok`, `xero`, `hubspot`, `salesforce`.
|
|
7584
7752
|
* @example netsuite
|
|
7585
7753
|
* @enum {string}
|
|
7586
7754
|
*/
|
|
@@ -7733,11 +7901,21 @@ export interface components {
|
|
|
7733
7901
|
* @example 120
|
|
7734
7902
|
*/
|
|
7735
7903
|
total_amount_cents: number;
|
|
7904
|
+
/**
|
|
7905
|
+
* @description The total amount of the credit note, expressed in cents, with precision.
|
|
7906
|
+
* @example 120.0001
|
|
7907
|
+
*/
|
|
7908
|
+
precise_total_amount_cents?: string | null;
|
|
7736
7909
|
/**
|
|
7737
7910
|
* @description The tax amount of the credit note, expressed in cents.
|
|
7738
7911
|
* @example 20
|
|
7739
7912
|
*/
|
|
7740
7913
|
taxes_amount_cents: number;
|
|
7914
|
+
/**
|
|
7915
|
+
* @description The tax amount of the credit note, expressed in cents, with precision.
|
|
7916
|
+
* @example 20.0001
|
|
7917
|
+
*/
|
|
7918
|
+
precise_taxes_amount_cents?: string | null;
|
|
7741
7919
|
/**
|
|
7742
7920
|
* @description The tax rate associated with this specific credit note.
|
|
7743
7921
|
* @example 20
|
|
@@ -7764,7 +7942,7 @@ export interface components {
|
|
|
7764
7942
|
*/
|
|
7765
7943
|
refund_amount_cents: number;
|
|
7766
7944
|
/**
|
|
7767
|
-
* @description The
|
|
7945
|
+
* @description The offset amount (deducted from the invoice balance) of the credit note, expressed in cents.
|
|
7768
7946
|
* @example 0
|
|
7769
7947
|
*/
|
|
7770
7948
|
offset_amount_cents: number;
|
|
@@ -7786,10 +7964,15 @@ export interface components {
|
|
|
7786
7964
|
*/
|
|
7787
7965
|
updated_at: string;
|
|
7788
7966
|
/**
|
|
7789
|
-
* @description The PDF file of the credit note.
|
|
7967
|
+
* @description The PDF file of the credit note. It is `null` while no PDF has been generated.
|
|
7790
7968
|
* @example https://getlago.com/credit_note/file
|
|
7791
7969
|
*/
|
|
7792
7970
|
file_url?: string | null;
|
|
7971
|
+
/**
|
|
7972
|
+
* @description The e-invoicing XML file of the credit note. It is `null` while no XML file has been generated.
|
|
7973
|
+
* @example https://getlago.com/credit_note/xml
|
|
7974
|
+
*/
|
|
7975
|
+
xml_url?: string | null;
|
|
7793
7976
|
/** @description Array of credit note's items. */
|
|
7794
7977
|
items?: components["schemas"]["CreditNoteItemObject"][];
|
|
7795
7978
|
applied_taxes?: components["schemas"]["CreditNoteAppliedTaxObject"][];
|
|
@@ -7837,17 +8020,17 @@ export interface components {
|
|
|
7837
8020
|
*/
|
|
7838
8021
|
description?: string;
|
|
7839
8022
|
/**
|
|
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
|
|
8023
|
+
* @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
8024
|
* @example 100
|
|
7842
8025
|
*/
|
|
7843
8026
|
credit_amount_cents?: number | null;
|
|
7844
8027
|
/**
|
|
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
|
|
8028
|
+
* @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
8029
|
* @example 500
|
|
7847
8030
|
*/
|
|
7848
8031
|
refund_amount_cents?: number | null;
|
|
7849
8032
|
/**
|
|
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
|
|
8033
|
+
* @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
8034
|
* @example 200
|
|
7852
8035
|
*/
|
|
7853
8036
|
offset_amount_cents?: number | null;
|
|
@@ -8103,9 +8286,9 @@ export interface components {
|
|
|
8103
8286
|
metadata?: components["schemas"]["CustomerMetadata"][];
|
|
8104
8287
|
/** @description List of customer taxes */
|
|
8105
8288
|
taxes?: components["schemas"]["TaxObject"][];
|
|
8106
|
-
/** @description The customer
|
|
8289
|
+
/** @description The customer's invoice custom sections used for generating invoices. */
|
|
8107
8290
|
applicable_invoice_custom_sections?: components["schemas"]["InvoiceCustomSectionObject"][];
|
|
8108
|
-
/** @description List of errors with details that might have been raised while processing
|
|
8291
|
+
/** @description List of errors with details that might have been raised while processing background actions for the customer */
|
|
8109
8292
|
error_details?: components["schemas"]["ErrorDetailObject"][];
|
|
8110
8293
|
};
|
|
8111
8294
|
CustomersPaginated: {
|
|
@@ -8186,10 +8369,12 @@ export interface components {
|
|
|
8186
8369
|
* @description The type of the account. It can have one of the following values:
|
|
8187
8370
|
* - `customer`: the account is a customer, default value.
|
|
8188
8371
|
* - `partner`: the account is a partner.
|
|
8372
|
+
*
|
|
8373
|
+
* This field is only applied when revenue share is enabled on your organization; otherwise it is ignored.
|
|
8189
8374
|
* @example customer
|
|
8190
|
-
* @enum {string
|
|
8375
|
+
* @enum {string}
|
|
8191
8376
|
*/
|
|
8192
|
-
account_type?: "customer" | "partner"
|
|
8377
|
+
account_type?: "customer" | "partner";
|
|
8193
8378
|
/**
|
|
8194
8379
|
* @description The type of the customer. It can have one of the following values:
|
|
8195
8380
|
* - `company`: the customer is a company.
|
|
@@ -8230,6 +8415,11 @@ export interface components {
|
|
|
8230
8415
|
* @example 30
|
|
8231
8416
|
*/
|
|
8232
8417
|
net_payment_term?: number | null;
|
|
8418
|
+
/**
|
|
8419
|
+
* @description The customer ID within the Salesforce system
|
|
8420
|
+
* @example 0015p00001JQx1QAAT
|
|
8421
|
+
*/
|
|
8422
|
+
external_salesforce_id?: string | null;
|
|
8233
8423
|
/**
|
|
8234
8424
|
* @description Specifies how invoices with a zero total amount should be handled:
|
|
8235
8425
|
* - `inherit`: (Default) Follows the organization-level configuration.
|
|
@@ -8249,12 +8439,12 @@ export interface components {
|
|
|
8249
8439
|
*/
|
|
8250
8440
|
id?: string;
|
|
8251
8441
|
/**
|
|
8252
|
-
* @description The integration type used for accounting and
|
|
8253
|
-
* Accepted values: `netsuite
|
|
8442
|
+
* @description The integration type used for accounting, tax and CRM syncs.
|
|
8443
|
+
* Accepted values: `netsuite`, `anrok`, `avalara`, `xero`, `hubspot`, `salesforce`.
|
|
8254
8444
|
* @example netsuite
|
|
8255
8445
|
* @enum {string}
|
|
8256
8446
|
*/
|
|
8257
|
-
integration_type?: "netsuite" | "anrok" | "xero";
|
|
8447
|
+
integration_type?: "netsuite" | "anrok" | "avalara" | "xero" | "hubspot" | "salesforce";
|
|
8258
8448
|
/**
|
|
8259
8449
|
* @description Unique code used to identify an integration connection.
|
|
8260
8450
|
* @example netsuite-eu-1
|
|
@@ -8275,6 +8465,11 @@ export interface components {
|
|
|
8275
8465
|
* @example 2
|
|
8276
8466
|
*/
|
|
8277
8467
|
subsidiary_id?: string;
|
|
8468
|
+
/**
|
|
8469
|
+
* @description This optional field is needed only when working with `hubspot` connection.
|
|
8470
|
+
* @example contacts
|
|
8471
|
+
*/
|
|
8472
|
+
targeted_object?: string | null;
|
|
8278
8473
|
}[];
|
|
8279
8474
|
/** @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
8475
|
metadata?: {
|
|
@@ -8298,7 +8493,7 @@ export interface components {
|
|
|
8298
8493
|
* @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
8494
|
* @example true
|
|
8300
8495
|
*/
|
|
8301
|
-
display_in_invoice
|
|
8496
|
+
display_in_invoice?: boolean;
|
|
8302
8497
|
}[];
|
|
8303
8498
|
/**
|
|
8304
8499
|
* @description Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default
|
|
@@ -8352,16 +8547,16 @@ export interface components {
|
|
|
8352
8547
|
issuing_date: string;
|
|
8353
8548
|
/**
|
|
8354
8549
|
* Format: date-time
|
|
8355
|
-
* @description The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
|
|
8550
|
+
* @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
8551
|
* @example 2022-09-14T16:35:31Z
|
|
8357
8552
|
*/
|
|
8358
|
-
payment_dispute_lost_at?: string;
|
|
8553
|
+
payment_dispute_lost_at?: string | null;
|
|
8359
8554
|
/**
|
|
8360
8555
|
* Format: date
|
|
8361
8556
|
* @description The payment due date for the invoice, specified in the ISO 8601 date format.
|
|
8362
8557
|
* @example 2022-04-30
|
|
8363
8558
|
*/
|
|
8364
|
-
payment_due_date?: string;
|
|
8559
|
+
payment_due_date?: string | null;
|
|
8365
8560
|
/**
|
|
8366
8561
|
* @description Specifies if the payment is considered as overdue.
|
|
8367
8562
|
* @example true
|
|
@@ -8373,11 +8568,11 @@ export interface components {
|
|
|
8373
8568
|
*/
|
|
8374
8569
|
net_payment_term?: number;
|
|
8375
8570
|
/**
|
|
8376
|
-
* @description The type of invoice issued. Possible values are `subscription`, `
|
|
8571
|
+
* @description The type of invoice issued. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.
|
|
8377
8572
|
* @example subscription
|
|
8378
8573
|
* @enum {string}
|
|
8379
8574
|
*/
|
|
8380
|
-
invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
|
|
8575
|
+
invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
|
|
8381
8576
|
/**
|
|
8382
8577
|
* @description The status of the invoice. It indicates the current state of the invoice and can have following values:
|
|
8383
8578
|
* - `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 +8662,21 @@ export interface components {
|
|
|
8467
8662
|
* @example 100
|
|
8468
8663
|
*/
|
|
8469
8664
|
total_amount_cents: number;
|
|
8665
|
+
/**
|
|
8666
|
+
* @description The amount already paid on the invoice, expressed in cents.
|
|
8667
|
+
* @example 40
|
|
8668
|
+
*/
|
|
8669
|
+
total_paid_amount_cents?: number;
|
|
8670
|
+
/**
|
|
8671
|
+
* @description The amount of the invoice settled by finalized credit notes, expressed in cents.
|
|
8672
|
+
* @example 10
|
|
8673
|
+
*/
|
|
8674
|
+
total_offsetted_credit_note_amount_cents?: number;
|
|
8675
|
+
/**
|
|
8676
|
+
* @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.
|
|
8677
|
+
* @example 50
|
|
8678
|
+
*/
|
|
8679
|
+
total_due_amount_cents?: number;
|
|
8470
8680
|
/** @example 3 */
|
|
8471
8681
|
version_number: number;
|
|
8472
8682
|
/**
|
|
@@ -8476,10 +8686,16 @@ export interface components {
|
|
|
8476
8686
|
self_billed?: boolean;
|
|
8477
8687
|
/**
|
|
8478
8688
|
* 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
|
|
8689
|
+
* @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
8690
|
* @example https://getlago.com/invoice/file
|
|
8481
8691
|
*/
|
|
8482
|
-
file_url?: string;
|
|
8692
|
+
file_url?: string | null;
|
|
8693
|
+
/**
|
|
8694
|
+
* Format: uri
|
|
8695
|
+
* @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.
|
|
8696
|
+
* @example https://getlago.com/invoice/xml
|
|
8697
|
+
*/
|
|
8698
|
+
xml_url?: string | null;
|
|
8483
8699
|
/**
|
|
8484
8700
|
* Format: uri
|
|
8485
8701
|
* @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 +8714,12 @@ export interface components {
|
|
|
8498
8714
|
* @example 2022-04-29T08:59:51Z
|
|
8499
8715
|
*/
|
|
8500
8716
|
updated_at: string;
|
|
8717
|
+
/**
|
|
8718
|
+
* Format: date-time
|
|
8719
|
+
* @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.
|
|
8720
|
+
* @example 2022-04-29T08:59:51Z
|
|
8721
|
+
*/
|
|
8722
|
+
voided_at?: string | null;
|
|
8501
8723
|
};
|
|
8502
8724
|
InvoiceMetadataObject: {
|
|
8503
8725
|
/**
|
|
@@ -9675,7 +9897,7 @@ export interface components {
|
|
|
9675
9897
|
* @example interval
|
|
9676
9898
|
* @enum {string}
|
|
9677
9899
|
*/
|
|
9678
|
-
trigger
|
|
9900
|
+
trigger: "interval" | "threshold";
|
|
9679
9901
|
/**
|
|
9680
9902
|
* @description The method used for recurring top-up. Possible values are `fixed` or `target`.
|
|
9681
9903
|
* @example target
|
|
@@ -9802,6 +10024,8 @@ export interface components {
|
|
|
9802
10024
|
AlertThresholdObject: components["schemas"]["AlertThresholdBaseObject"] & {
|
|
9803
10025
|
/**
|
|
9804
10026
|
* @description A value that should trigger this alert, formatted as a BigDecimal.
|
|
10027
|
+
*
|
|
10028
|
+
* 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
10029
|
* @example 99.0
|
|
9806
10030
|
*/
|
|
9807
10031
|
value: string;
|
|
@@ -9880,6 +10104,8 @@ export interface components {
|
|
|
9880
10104
|
AlertThresholdInput: components["schemas"]["AlertThresholdBaseObject"] & {
|
|
9881
10105
|
/**
|
|
9882
10106
|
* @description A value that should trigger this alert. This can be an integer or a string formatted as a BigDecimal.
|
|
10107
|
+
*
|
|
10108
|
+
* 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
10109
|
* @example 99
|
|
9884
10110
|
*/
|
|
9885
10111
|
value: number | string;
|
|
@@ -9980,22 +10206,22 @@ export interface components {
|
|
|
9980
10206
|
* @description The number of units consumed for a specific charge filter related to a charge item.
|
|
9981
10207
|
* @example 0.9
|
|
9982
10208
|
*/
|
|
9983
|
-
units
|
|
10209
|
+
units: string;
|
|
9984
10210
|
/**
|
|
9985
10211
|
* @description The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
|
|
9986
10212
|
* @example 1.0
|
|
9987
10213
|
*/
|
|
9988
|
-
total_aggregated_units
|
|
10214
|
+
total_aggregated_units: string;
|
|
9989
10215
|
/**
|
|
9990
10216
|
* @description The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
|
|
9991
10217
|
* @example 1000
|
|
9992
10218
|
*/
|
|
9993
|
-
amount_cents
|
|
10219
|
+
amount_cents: number;
|
|
9994
10220
|
/**
|
|
9995
10221
|
* @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
10222
|
* @example 10
|
|
9997
10223
|
*/
|
|
9998
|
-
events_count
|
|
10224
|
+
events_count: number;
|
|
9999
10225
|
/**
|
|
10000
10226
|
* @description Specifies the name that will be displayed on an invoice.
|
|
10001
10227
|
* @example AWS eu-east-1
|
|
@@ -10010,7 +10236,7 @@ export interface components {
|
|
|
10010
10236
|
* ]
|
|
10011
10237
|
* }
|
|
10012
10238
|
*/
|
|
10013
|
-
values
|
|
10239
|
+
values: {
|
|
10014
10240
|
[key: string]: string[];
|
|
10015
10241
|
};
|
|
10016
10242
|
presentation_breakdowns?: components["schemas"]["PresentationBreakdownsObject"];
|
|
@@ -10021,25 +10247,25 @@ export interface components {
|
|
|
10021
10247
|
* @description The amount in cents, tax excluded, consumed for a specific group related to a charge item.
|
|
10022
10248
|
* @example 1000
|
|
10023
10249
|
*/
|
|
10024
|
-
amount_cents
|
|
10250
|
+
amount_cents: number;
|
|
10025
10251
|
/**
|
|
10026
10252
|
* @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
10253
|
* @example 10
|
|
10028
10254
|
*/
|
|
10029
|
-
events_count
|
|
10255
|
+
events_count: number;
|
|
10030
10256
|
/**
|
|
10031
10257
|
* @description The number of units consumed for a specific group related to a charge item.
|
|
10032
10258
|
* @example 0.9
|
|
10033
10259
|
*/
|
|
10034
|
-
units
|
|
10260
|
+
units: string;
|
|
10035
10261
|
/**
|
|
10036
10262
|
* @description The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
|
|
10037
10263
|
* @example 1.0
|
|
10038
10264
|
*/
|
|
10039
|
-
total_aggregated_units
|
|
10265
|
+
total_aggregated_units: string;
|
|
10040
10266
|
pricing_unit_details?: components["schemas"]["UsagePricingUnitDetailsObject"];
|
|
10041
10267
|
/** @description Key value list of event properties aggregated by the charge model */
|
|
10042
|
-
grouped_by
|
|
10268
|
+
grouped_by: {
|
|
10043
10269
|
[key: string]: string;
|
|
10044
10270
|
};
|
|
10045
10271
|
filters?: components["schemas"]["CustomerChargeFiltersUsageObject"];
|
|
@@ -10178,27 +10404,27 @@ export interface components {
|
|
|
10178
10404
|
* @description The number of units consumed for a specific charge filter related to a charge item.
|
|
10179
10405
|
* @example 0.9
|
|
10180
10406
|
*/
|
|
10181
|
-
units
|
|
10407
|
+
units: string;
|
|
10182
10408
|
/**
|
|
10183
10409
|
* @description The projected number of units that can be consumed for a specific charge filter related to a charge item.
|
|
10184
10410
|
* @example 1.8
|
|
10185
10411
|
*/
|
|
10186
|
-
projected_units
|
|
10412
|
+
projected_units: string;
|
|
10187
10413
|
/**
|
|
10188
10414
|
* @description The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
|
|
10189
10415
|
* @example 1000
|
|
10190
10416
|
*/
|
|
10191
|
-
amount_cents
|
|
10417
|
+
amount_cents: number;
|
|
10192
10418
|
/**
|
|
10193
10419
|
* @description The projected amount in cents, tax excluded, that can be consumed for a specific charge filter related to a charge item.
|
|
10194
10420
|
* @example 2000
|
|
10195
10421
|
*/
|
|
10196
|
-
projected_amount_cents
|
|
10422
|
+
projected_amount_cents: number;
|
|
10197
10423
|
/**
|
|
10198
10424
|
* @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
10425
|
* @example 10
|
|
10200
10426
|
*/
|
|
10201
|
-
events_count
|
|
10427
|
+
events_count: number;
|
|
10202
10428
|
/**
|
|
10203
10429
|
* @description Specifies the name that will be displayed on an invoice.
|
|
10204
10430
|
* @example AWS eu-east-1
|
|
@@ -10213,7 +10439,7 @@ export interface components {
|
|
|
10213
10439
|
* ]
|
|
10214
10440
|
* }
|
|
10215
10441
|
*/
|
|
10216
|
-
values
|
|
10442
|
+
values: {
|
|
10217
10443
|
[key: string]: string[];
|
|
10218
10444
|
};
|
|
10219
10445
|
presentation_breakdowns?: components["schemas"]["PresentationBreakdownsObject"];
|
|
@@ -10225,30 +10451,30 @@ export interface components {
|
|
|
10225
10451
|
* @description The amount in cents, tax excluded, consumed for a specific group related to a charge item.
|
|
10226
10452
|
* @example 1000
|
|
10227
10453
|
*/
|
|
10228
|
-
amount_cents
|
|
10454
|
+
amount_cents: number;
|
|
10229
10455
|
/**
|
|
10230
10456
|
* @description The projected amount in cents, tax excluded, that can be consumed for a specific group related to a charge item.
|
|
10231
10457
|
* @example 2000
|
|
10232
10458
|
*/
|
|
10233
|
-
projected_amount_cents
|
|
10459
|
+
projected_amount_cents: number;
|
|
10234
10460
|
/**
|
|
10235
10461
|
* @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
10462
|
* @example 10
|
|
10237
10463
|
*/
|
|
10238
|
-
events_count
|
|
10464
|
+
events_count: number;
|
|
10239
10465
|
/**
|
|
10240
10466
|
* @description The number of units consumed for a specific group related to a charge item.
|
|
10241
10467
|
* @example 0.9
|
|
10242
10468
|
*/
|
|
10243
|
-
units
|
|
10469
|
+
units: string;
|
|
10244
10470
|
/**
|
|
10245
10471
|
* @description The projected number of units that can be consumed for a specific group related to a charge item.
|
|
10246
10472
|
* @example 1.8
|
|
10247
10473
|
*/
|
|
10248
|
-
projected_units
|
|
10474
|
+
projected_units: string;
|
|
10249
10475
|
pricing_unit_details?: components["schemas"]["UsagePricingUnitDetailsObject"];
|
|
10250
10476
|
/** @description Key value list of event properties aggregated by the charge model */
|
|
10251
|
-
grouped_by
|
|
10477
|
+
grouped_by: {
|
|
10252
10478
|
[key: string]: string;
|
|
10253
10479
|
};
|
|
10254
10480
|
filters?: components["schemas"]["CustomerProjectedChargeFiltersUsageObject"];
|
|
@@ -10580,9 +10806,19 @@ export interface components {
|
|
|
10580
10806
|
* "gb": 10
|
|
10581
10807
|
* }
|
|
10582
10808
|
*/
|
|
10583
|
-
properties?: {
|
|
10809
|
+
properties?: ({
|
|
10810
|
+
/**
|
|
10811
|
+
* @description The code of the wallet targeted by this event for prepaid credits deduction.
|
|
10812
|
+
* When provided, credits are drawn from this specific wallet instead of following the standard wallet selection logic.
|
|
10813
|
+
* If the code does not match an existing wallet, no credits will be applied for the event.
|
|
10814
|
+
* This field is only taken into account when the targeted charge has `accepts_target_wallet` set to `true`.
|
|
10815
|
+
* This field requires a premium integration.
|
|
10816
|
+
* @example main_wallet
|
|
10817
|
+
*/
|
|
10818
|
+
target_wallet_code?: string | null;
|
|
10819
|
+
} & {
|
|
10584
10820
|
[key: string]: string | number;
|
|
10585
|
-
} | null;
|
|
10821
|
+
}) | null;
|
|
10586
10822
|
};
|
|
10587
10823
|
EventInput: {
|
|
10588
10824
|
event: components["schemas"]["EventInputObject"];
|
|
@@ -10620,8 +10856,20 @@ export interface components {
|
|
|
10620
10856
|
* @example sub_1234567890
|
|
10621
10857
|
*/
|
|
10622
10858
|
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?:
|
|
10859
|
+
/** @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. */
|
|
10860
|
+
properties?: {
|
|
10861
|
+
/**
|
|
10862
|
+
* @description The code of the wallet targeted by this event for prepaid credits deduction.
|
|
10863
|
+
* When provided, credits are drawn from this specific wallet instead of following the standard wallet selection logic.
|
|
10864
|
+
* If the code does not match an existing wallet, no credits will be applied for the event.
|
|
10865
|
+
* This field is only taken into account when the targeted charge has `accepts_target_wallet` set to `true`.
|
|
10866
|
+
* This field requires a premium integration.
|
|
10867
|
+
* @example main_wallet
|
|
10868
|
+
*/
|
|
10869
|
+
target_wallet_code?: string | null;
|
|
10870
|
+
} & {
|
|
10871
|
+
[key: string]: unknown;
|
|
10872
|
+
};
|
|
10625
10873
|
};
|
|
10626
10874
|
};
|
|
10627
10875
|
Fees: {
|
|
@@ -10877,6 +11125,12 @@ export interface components {
|
|
|
10877
11125
|
* @example EUR
|
|
10878
11126
|
*/
|
|
10879
11127
|
currency?: components["schemas"]["Currency"];
|
|
11128
|
+
/**
|
|
11129
|
+
* @description If true, the invoice will be created but not sent to the payment provider.
|
|
11130
|
+
* @default false
|
|
11131
|
+
* @example true
|
|
11132
|
+
*/
|
|
11133
|
+
skip_psp: boolean | null;
|
|
10880
11134
|
/**
|
|
10881
11135
|
* @description The purchase order number to associate with the invoice.
|
|
10882
11136
|
* @example PO-123
|
|
@@ -10899,13 +11153,13 @@ export interface components {
|
|
|
10899
11153
|
*/
|
|
10900
11154
|
unit_amount_cents?: number | null;
|
|
10901
11155
|
/**
|
|
10902
|
-
* @description The quantity of units associated with the fee. By default, only 1 unit is added to the invoice.
|
|
11156
|
+
* @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
11157
|
* @example 2.5
|
|
10904
11158
|
*/
|
|
10905
|
-
units?: string | null;
|
|
11159
|
+
units?: string | number | null;
|
|
10906
11160
|
/**
|
|
10907
|
-
* @description
|
|
10908
|
-
* @example
|
|
11161
|
+
* @description The description of the fee line item in the invoice. By default, the description of the add-on is used.
|
|
11162
|
+
* @example Onboarding session, June 2024
|
|
10909
11163
|
*/
|
|
10910
11164
|
description?: string | null;
|
|
10911
11165
|
/**
|
|
@@ -10921,12 +11175,6 @@ export interface components {
|
|
|
10921
11175
|
*/
|
|
10922
11176
|
to_datetime?: string;
|
|
10923
11177
|
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
11178
|
}[];
|
|
10931
11179
|
invoice_custom_section?: components["schemas"]["InvoiceCustomSectionInput"];
|
|
10932
11180
|
/** @description Optional payment method to use for processing the invoice payment. */
|
|
@@ -12055,111 +12303,6 @@ export interface components {
|
|
|
12055
12303
|
*/
|
|
12056
12304
|
document_locale?: string;
|
|
12057
12305
|
};
|
|
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
12306
|
OrganizationObject: {
|
|
12164
12307
|
/**
|
|
12165
12308
|
* Format: uuid
|
|
@@ -12172,6 +12315,11 @@ export interface components {
|
|
|
12172
12315
|
* @example Name1
|
|
12173
12316
|
*/
|
|
12174
12317
|
name: string;
|
|
12318
|
+
/**
|
|
12319
|
+
* @description A concise and unique identifier for your organization, formed by combining the organization's `name` and `id`.
|
|
12320
|
+
* @example NAME1-1234
|
|
12321
|
+
*/
|
|
12322
|
+
slug?: string;
|
|
12175
12323
|
/**
|
|
12176
12324
|
* Format: date-time
|
|
12177
12325
|
* @description The date of creation of your organization, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
@@ -12273,6 +12421,14 @@ export interface components {
|
|
|
12273
12421
|
* @example America/New_York
|
|
12274
12422
|
*/
|
|
12275
12423
|
timezone?: components["schemas"]["Timezone"];
|
|
12424
|
+
/**
|
|
12425
|
+
* @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`.
|
|
12426
|
+
* @example [
|
|
12427
|
+
* "invoice.finalized",
|
|
12428
|
+
* "credit_note.created"
|
|
12429
|
+
* ]
|
|
12430
|
+
*/
|
|
12431
|
+
email_settings: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
|
|
12276
12432
|
billing_configuration: components["schemas"]["OrganizationBillingConfiguration"];
|
|
12277
12433
|
/** @description List of default organization taxes */
|
|
12278
12434
|
taxes?: components["schemas"]["TaxObject"][];
|
|
@@ -12290,6 +12446,116 @@ export interface components {
|
|
|
12290
12446
|
Organization: {
|
|
12291
12447
|
organization: components["schemas"]["OrganizationObject"];
|
|
12292
12448
|
};
|
|
12449
|
+
OrganizationUpdateInput: {
|
|
12450
|
+
organization: {
|
|
12451
|
+
/**
|
|
12452
|
+
* @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.
|
|
12453
|
+
* @example https://webhook.brex.com
|
|
12454
|
+
*/
|
|
12455
|
+
webhook_url?: string | null;
|
|
12456
|
+
/**
|
|
12457
|
+
* @description The country of your organization.
|
|
12458
|
+
* @example US
|
|
12459
|
+
*/
|
|
12460
|
+
country?: components["schemas"]["CountryOrNull"];
|
|
12461
|
+
/**
|
|
12462
|
+
* @description The default currency of an organization.
|
|
12463
|
+
* @example USD
|
|
12464
|
+
*/
|
|
12465
|
+
default_currency?: components["schemas"]["Currency"];
|
|
12466
|
+
/**
|
|
12467
|
+
* @description The first line of your organization's billing address.
|
|
12468
|
+
* @example 100 Brex Street
|
|
12469
|
+
*/
|
|
12470
|
+
address_line1?: string | null;
|
|
12471
|
+
/**
|
|
12472
|
+
* @description The second line of your organization's billing address.
|
|
12473
|
+
* @example null
|
|
12474
|
+
*/
|
|
12475
|
+
address_line2?: string | null;
|
|
12476
|
+
/**
|
|
12477
|
+
* @description The state of your organization's billing address.
|
|
12478
|
+
* @example NYC
|
|
12479
|
+
*/
|
|
12480
|
+
state?: string | null;
|
|
12481
|
+
/**
|
|
12482
|
+
* @description The zipcode of your organization's billing address.
|
|
12483
|
+
* @example 10000
|
|
12484
|
+
*/
|
|
12485
|
+
zipcode?: string | null;
|
|
12486
|
+
/**
|
|
12487
|
+
* Format: email
|
|
12488
|
+
* @description The email address of your organization used to bill your customers.
|
|
12489
|
+
* @example brex@brex.com
|
|
12490
|
+
*/
|
|
12491
|
+
email?: string | null;
|
|
12492
|
+
/**
|
|
12493
|
+
* @description The city of your organization's billing address.
|
|
12494
|
+
* @example New York
|
|
12495
|
+
*/
|
|
12496
|
+
city?: string | null;
|
|
12497
|
+
/**
|
|
12498
|
+
* @description The legal name of your organization.
|
|
12499
|
+
* @example null
|
|
12500
|
+
*/
|
|
12501
|
+
legal_name?: string | null;
|
|
12502
|
+
/**
|
|
12503
|
+
* @description The legal number of your organization.
|
|
12504
|
+
* @example null
|
|
12505
|
+
*/
|
|
12506
|
+
legal_number?: string | null;
|
|
12507
|
+
/**
|
|
12508
|
+
* @description This parameter configures the method of incrementing invoice numbers for your customers.
|
|
12509
|
+
*
|
|
12510
|
+
* - `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.
|
|
12511
|
+
* - `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.
|
|
12512
|
+
*
|
|
12513
|
+
* The default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
|
|
12514
|
+
* @example per_customer
|
|
12515
|
+
* @enum {string}
|
|
12516
|
+
*/
|
|
12517
|
+
document_numbering?: "per_customer" | "per_organization";
|
|
12518
|
+
/**
|
|
12519
|
+
* @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.
|
|
12520
|
+
* @example ORG-1234
|
|
12521
|
+
*/
|
|
12522
|
+
document_number_prefix?: string;
|
|
12523
|
+
/**
|
|
12524
|
+
* @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.
|
|
12525
|
+
* @example 30
|
|
12526
|
+
*/
|
|
12527
|
+
net_payment_term?: number;
|
|
12528
|
+
/**
|
|
12529
|
+
* @description The tax identification number of your organization.
|
|
12530
|
+
* @example US123456789
|
|
12531
|
+
*/
|
|
12532
|
+
tax_identification_number?: string | null;
|
|
12533
|
+
/**
|
|
12534
|
+
* @description Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
|
|
12535
|
+
* @example America/New_York
|
|
12536
|
+
*/
|
|
12537
|
+
timezone?: components["schemas"]["Timezone"];
|
|
12538
|
+
/**
|
|
12539
|
+
* @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`.
|
|
12540
|
+
* @example [
|
|
12541
|
+
* "invoice.finalized",
|
|
12542
|
+
* "credit_note.created"
|
|
12543
|
+
* ]
|
|
12544
|
+
*/
|
|
12545
|
+
email_settings?: ("invoice.finalized" | "credit_note.created" | "payment_receipt.created")[];
|
|
12546
|
+
billing_configuration?: components["schemas"]["OrganizationBillingConfiguration"];
|
|
12547
|
+
/**
|
|
12548
|
+
* @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.
|
|
12549
|
+
* @example false
|
|
12550
|
+
*/
|
|
12551
|
+
finalize_zero_amount_invoice?: boolean;
|
|
12552
|
+
/**
|
|
12553
|
+
* @description A concise and unique identifier for your organization, used as a prefix in customer slugs.
|
|
12554
|
+
* @example NAME1-1234
|
|
12555
|
+
*/
|
|
12556
|
+
slug?: string;
|
|
12557
|
+
};
|
|
12558
|
+
};
|
|
12293
12559
|
PaymentReceiptObject: {
|
|
12294
12560
|
/**
|
|
12295
12561
|
* Format: uuid
|
|
@@ -12700,6 +12966,8 @@ export interface components {
|
|
|
12700
12966
|
} | null;
|
|
12701
12967
|
/**
|
|
12702
12968
|
* @description Specifies whether the charge accepts a target wallet for prepaid credits deduction.
|
|
12969
|
+
* When `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.
|
|
12970
|
+
* This field requires a premium integration.
|
|
12703
12971
|
* @example false
|
|
12704
12972
|
*/
|
|
12705
12973
|
accepts_target_wallet?: boolean | null;
|
|
@@ -14139,6 +14407,16 @@ export interface components {
|
|
|
14139
14407
|
* @example false
|
|
14140
14408
|
*/
|
|
14141
14409
|
prorated?: boolean;
|
|
14410
|
+
/**
|
|
14411
|
+
* @description Specifies whether the charge accepts a target wallet for prepaid credits deduction.
|
|
14412
|
+
* When set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.
|
|
14413
|
+
* If no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.
|
|
14414
|
+
* If the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.
|
|
14415
|
+
*
|
|
14416
|
+
* This field requires a premium integration.
|
|
14417
|
+
* @example false
|
|
14418
|
+
*/
|
|
14419
|
+
accepts_target_wallet?: boolean | null;
|
|
14142
14420
|
};
|
|
14143
14421
|
ChargeCreateInput: {
|
|
14144
14422
|
charge: components["schemas"]["ChargeInput"] & unknown & {
|
|
@@ -14974,7 +15252,7 @@ export interface components {
|
|
|
14974
15252
|
* @example billable_metric_current_usage_amount
|
|
14975
15253
|
* @enum {string}
|
|
14976
15254
|
*/
|
|
14977
|
-
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
|
|
15255
|
+
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
|
|
14978
15256
|
/**
|
|
14979
15257
|
* @description Unique code used to identify the alert.
|
|
14980
15258
|
* @example storage_threshold_alert
|
|
@@ -15022,7 +15300,7 @@ export interface components {
|
|
|
15022
15300
|
* @example billable_metric_current_usage_amount
|
|
15023
15301
|
* @enum {string}
|
|
15024
15302
|
*/
|
|
15025
|
-
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
|
|
15303
|
+
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
|
|
15026
15304
|
/**
|
|
15027
15305
|
* @description Unique code used to identify the alert.
|
|
15028
15306
|
* @example storage_threshold_alert
|
|
@@ -15043,7 +15321,7 @@ export interface components {
|
|
|
15043
15321
|
* @example billable_metric_current_usage_amount
|
|
15044
15322
|
* @enum {string}
|
|
15045
15323
|
*/
|
|
15046
|
-
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
|
|
15324
|
+
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount" | "billable_metric_lifetime_usage_units";
|
|
15047
15325
|
/**
|
|
15048
15326
|
* @description Unique code used to identify the alert.
|
|
15049
15327
|
* @example storage_threshold_alert
|
|
@@ -15191,7 +15469,7 @@ export interface components {
|
|
|
15191
15469
|
*/
|
|
15192
15470
|
rate?: string;
|
|
15193
15471
|
/**
|
|
15194
|
-
* @description Internal description of the
|
|
15472
|
+
* @description Internal description of the tax
|
|
15195
15473
|
* @example French standard VAT
|
|
15196
15474
|
*/
|
|
15197
15475
|
description?: string | null;
|
|
@@ -15677,7 +15955,7 @@ export interface components {
|
|
|
15677
15955
|
* @example billable_metric_current_usage_amount
|
|
15678
15956
|
* @enum {string}
|
|
15679
15957
|
*/
|
|
15680
|
-
alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
|
|
15958
|
+
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
15959
|
/**
|
|
15682
15960
|
* @description Unique code used to identify the alert triggered.
|
|
15683
15961
|
* @example storage_threshold_alert
|
|
@@ -15707,7 +15985,7 @@ export interface components {
|
|
|
15707
15985
|
/** @description Array of thresholds crossed. All the recurring threshold values are present. */
|
|
15708
15986
|
crossed_thresholds: components["schemas"]["AlertThresholdObject"][];
|
|
15709
15987
|
};
|
|
15710
|
-
|
|
15988
|
+
CustomerIntegrationErrorObject: {
|
|
15711
15989
|
/**
|
|
15712
15990
|
* Format: uuid
|
|
15713
15991
|
* @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 +16412,6 @@ export interface components {
|
|
|
16134
16412
|
[key: string]: unknown;
|
|
16135
16413
|
};
|
|
16136
16414
|
};
|
|
16137
|
-
CustomerPaymentProvidernErrorObject: components["schemas"]["CustomerPaymentProviderErrorObject"];
|
|
16138
16415
|
};
|
|
16139
16416
|
responses: {
|
|
16140
16417
|
/** @description Unauthorized error */
|
|
@@ -16235,7 +16512,11 @@ export interface components {
|
|
|
16235
16512
|
subscription_status: "pending" | "active" | "terminated" | "canceled";
|
|
16236
16513
|
/** @description External ID of the existing subscription. */
|
|
16237
16514
|
subscription_external_id_path: string;
|
|
16238
|
-
/**
|
|
16515
|
+
/**
|
|
16516
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
16517
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
16518
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
16519
|
+
*/
|
|
16239
16520
|
webhook_signature: string;
|
|
16240
16521
|
/** @description Algorithm used to generate the signature */
|
|
16241
16522
|
webhook_signature_algorithm: "jwt" | "hmac";
|
|
@@ -16292,7 +16573,9 @@ export interface operations {
|
|
|
16292
16573
|
[name: string]: unknown;
|
|
16293
16574
|
};
|
|
16294
16575
|
content: {
|
|
16295
|
-
"application/json":
|
|
16576
|
+
"application/json": {
|
|
16577
|
+
billing_entity: components["schemas"]["BillingEntityObject"];
|
|
16578
|
+
};
|
|
16296
16579
|
};
|
|
16297
16580
|
};
|
|
16298
16581
|
400: components["responses"]["BadRequest"];
|
|
@@ -16306,7 +16589,7 @@ export interface operations {
|
|
|
16306
16589
|
query?: never;
|
|
16307
16590
|
header?: never;
|
|
16308
16591
|
path: {
|
|
16309
|
-
/** @description The
|
|
16592
|
+
/** @description The unique code of the billing entity */
|
|
16310
16593
|
code: string;
|
|
16311
16594
|
};
|
|
16312
16595
|
cookie?: never;
|
|
@@ -16334,13 +16617,13 @@ export interface operations {
|
|
|
16334
16617
|
query?: never;
|
|
16335
16618
|
header?: never;
|
|
16336
16619
|
path: {
|
|
16337
|
-
/** @description The
|
|
16620
|
+
/** @description The unique code of the billing entity */
|
|
16338
16621
|
code: string;
|
|
16339
16622
|
};
|
|
16340
16623
|
cookie?: never;
|
|
16341
16624
|
};
|
|
16342
16625
|
/** @description The billing entity update payload */
|
|
16343
|
-
requestBody
|
|
16626
|
+
requestBody: {
|
|
16344
16627
|
content: {
|
|
16345
16628
|
"application/json": components["schemas"]["BillingEntityUpdateInput"];
|
|
16346
16629
|
};
|
|
@@ -16352,7 +16635,9 @@ export interface operations {
|
|
|
16352
16635
|
[name: string]: unknown;
|
|
16353
16636
|
};
|
|
16354
16637
|
content: {
|
|
16355
|
-
"application/json":
|
|
16638
|
+
"application/json": {
|
|
16639
|
+
billing_entity: components["schemas"]["BillingEntityObjectExtended"];
|
|
16640
|
+
};
|
|
16356
16641
|
};
|
|
16357
16642
|
};
|
|
16358
16643
|
400: components["responses"]["BadRequest"];
|
|
@@ -17369,9 +17654,9 @@ export interface operations {
|
|
|
17369
17654
|
currency?: string;
|
|
17370
17655
|
/** @description Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`. */
|
|
17371
17656
|
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`
|
|
17657
|
+
/** @description Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`. */
|
|
17373
17658
|
credit_status?: "available" | "consumed" | "voided";
|
|
17374
|
-
/** @description Filter credit notes by refund status. Possible values are `pending`, `succeeded`
|
|
17659
|
+
/** @description Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`. */
|
|
17375
17660
|
refund_status?: "pending" | "succeeded" | "failed";
|
|
17376
17661
|
/** @description Filter credit notes by their related invoice number. */
|
|
17377
17662
|
invoice_number?: string;
|
|
@@ -17381,6 +17666,8 @@ export interface operations {
|
|
|
17381
17666
|
amount_from?: number;
|
|
17382
17667
|
/** @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
17668
|
amount_to?: number;
|
|
17669
|
+
/** @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. */
|
|
17670
|
+
"types[]"?: ("credit" | "refund" | "offset")[];
|
|
17384
17671
|
/** @description Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`. */
|
|
17385
17672
|
self_billed?: boolean;
|
|
17386
17673
|
/** @description Filter credit notes by billing entity codes. */
|
|
@@ -17687,6 +17974,8 @@ export interface operations {
|
|
|
17687
17974
|
page?: components["parameters"]["page"];
|
|
17688
17975
|
/** @description Number of records per page. */
|
|
17689
17976
|
per_page?: components["parameters"]["per_page"];
|
|
17977
|
+
/** @description Filter customers by external ID. */
|
|
17978
|
+
external_id?: string;
|
|
17690
17979
|
/** @description Filter customers by account type. */
|
|
17691
17980
|
"account_type[]"?: ("customer" | "partner")[];
|
|
17692
17981
|
/** @description Filter customers by billing entity codes. */
|
|
@@ -18082,6 +18371,8 @@ export interface operations {
|
|
|
18082
18371
|
page?: components["parameters"]["page"];
|
|
18083
18372
|
/** @description Number of records per page. */
|
|
18084
18373
|
per_page?: components["parameters"]["per_page"];
|
|
18374
|
+
/** @description The subscription external unique identifier (provided by your own application). */
|
|
18375
|
+
external_id?: string;
|
|
18085
18376
|
/** @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
18377
|
plan_code?: string;
|
|
18087
18378
|
/** @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`. */
|
|
@@ -19034,29 +19325,29 @@ export interface operations {
|
|
|
19034
19325
|
external_subscription_id?: components["parameters"]["external_subscription_id"];
|
|
19035
19326
|
/** @description Filter results by event transaction ID */
|
|
19036
19327
|
event_transaction_id?: string;
|
|
19037
|
-
/** @description Filter results by fee
|
|
19328
|
+
/** @description Filter results by the fee's currency. */
|
|
19038
19329
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
19039
|
-
/** @description The fee type. Possible values are `
|
|
19040
|
-
fee_type?: "charge" | "add_on" | "subscription" | "credit" | "commitment";
|
|
19330
|
+
/** @description The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`. */
|
|
19331
|
+
fee_type?: "charge" | "fixed_charge" | "add_on" | "subscription" | "credit" | "commitment";
|
|
19041
19332
|
/** @description Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types. */
|
|
19042
19333
|
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`. */
|
|
19334
|
+
/** @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
19335
|
payment_status?: "pending" | "succeeded" | "failed" | "refunded";
|
|
19045
|
-
/** @description Filter results created after
|
|
19336
|
+
/** @description Filter results created at or after this date and time in UTC. */
|
|
19046
19337
|
created_at_from?: string;
|
|
19047
|
-
/** @description Filter results created before
|
|
19338
|
+
/** @description Filter results created at or before this date and time in UTC. */
|
|
19048
19339
|
created_at_to?: string;
|
|
19049
|
-
/** @description Filter results with payment success after
|
|
19340
|
+
/** @description Filter results with a payment success at or after this date and time in UTC. */
|
|
19050
19341
|
succeeded_at_from?: string;
|
|
19051
|
-
/** @description Filter results with payment success
|
|
19342
|
+
/** @description Filter results with a payment success at or before this date and time in UTC. */
|
|
19052
19343
|
succeeded_at_to?: string;
|
|
19053
|
-
/** @description Filter results with payment failure after
|
|
19344
|
+
/** @description Filter results with a payment failure at or after this date and time in UTC. */
|
|
19054
19345
|
failed_at_from?: string;
|
|
19055
|
-
/** @description Filter results with payment failure
|
|
19346
|
+
/** @description Filter results with a payment failure at or before this date and time in UTC. */
|
|
19056
19347
|
failed_at_to?: string;
|
|
19057
|
-
/** @description Filter results with payment refund after
|
|
19348
|
+
/** @description Filter results with a payment refund at or after this date and time in UTC. */
|
|
19058
19349
|
refunded_at_from?: string;
|
|
19059
|
-
/** @description Filter results with payment refund
|
|
19350
|
+
/** @description Filter results with a payment refund at or before this date and time in UTC. */
|
|
19060
19351
|
refunded_at_to?: string;
|
|
19061
19352
|
};
|
|
19062
19353
|
header?: never;
|
|
@@ -19191,6 +19482,10 @@ export interface operations {
|
|
|
19191
19482
|
currency?: string;
|
|
19192
19483
|
/** @description Filter invoices with a payment dispute lost. Possible values are `true` or `false`. */
|
|
19193
19484
|
payment_dispute_lost?: boolean;
|
|
19485
|
+
/** @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. */
|
|
19486
|
+
partially_paid?: boolean;
|
|
19487
|
+
/** @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. */
|
|
19488
|
+
"settlements[]"?: ("payment" | "credit_note")[];
|
|
19194
19489
|
/** @description Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`. */
|
|
19195
19490
|
invoice_type?: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
|
|
19196
19491
|
/** @description Filter invoices by self billed. Possible values are `true` or `false`. */
|
|
@@ -19302,6 +19597,7 @@ export interface operations {
|
|
|
19302
19597
|
400: components["responses"]["BadRequest"];
|
|
19303
19598
|
401: components["responses"]["Unauthorized"];
|
|
19304
19599
|
404: components["responses"]["NotFound"];
|
|
19600
|
+
405: components["responses"]["NotAllowed"];
|
|
19305
19601
|
422: components["responses"]["UnprocessableEntity"];
|
|
19306
19602
|
};
|
|
19307
19603
|
};
|
|
@@ -19812,6 +20108,27 @@ export interface operations {
|
|
|
19812
20108
|
422: components["responses"]["UnprocessableEntity"];
|
|
19813
20109
|
};
|
|
19814
20110
|
};
|
|
20111
|
+
findOrganization: {
|
|
20112
|
+
parameters: {
|
|
20113
|
+
query?: never;
|
|
20114
|
+
header?: never;
|
|
20115
|
+
path?: never;
|
|
20116
|
+
cookie?: never;
|
|
20117
|
+
};
|
|
20118
|
+
requestBody?: never;
|
|
20119
|
+
responses: {
|
|
20120
|
+
/** @description Organization */
|
|
20121
|
+
200: {
|
|
20122
|
+
headers: {
|
|
20123
|
+
[name: string]: unknown;
|
|
20124
|
+
};
|
|
20125
|
+
content: {
|
|
20126
|
+
"application/json": components["schemas"]["Organization"];
|
|
20127
|
+
};
|
|
20128
|
+
};
|
|
20129
|
+
401: components["responses"]["Unauthorized"];
|
|
20130
|
+
};
|
|
20131
|
+
};
|
|
19815
20132
|
updateOrganization: {
|
|
19816
20133
|
parameters: {
|
|
19817
20134
|
query?: never;
|
|
@@ -21181,8 +21498,12 @@ export interface operations {
|
|
|
21181
21498
|
currency?: components["parameters"]["currency"];
|
|
21182
21499
|
/** @description The customer external unique identifier (provided by your own application) */
|
|
21183
21500
|
external_customer_id?: string;
|
|
21501
|
+
/** @description Filter subscriptions by their external unique identifier (provided by your own application). */
|
|
21502
|
+
external_id?: string;
|
|
21184
21503
|
/** @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
21504
|
plan_code?: string;
|
|
21505
|
+
/** @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. */
|
|
21506
|
+
overridden?: boolean;
|
|
21186
21507
|
/** @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
21508
|
"status[]"?: ("active" | "canceled" | "pending" | "terminated")[];
|
|
21188
21509
|
/** @description Filter subscriptions by billing entity codes. */
|
|
@@ -22267,15 +22588,15 @@ export interface operations {
|
|
|
22267
22588
|
};
|
|
22268
22589
|
findAllWallets: {
|
|
22269
22590
|
parameters: {
|
|
22270
|
-
query
|
|
22591
|
+
query?: {
|
|
22271
22592
|
/** @description Page number. */
|
|
22272
22593
|
page?: components["parameters"]["page"];
|
|
22273
22594
|
/** @description Number of records per page. */
|
|
22274
22595
|
per_page?: components["parameters"]["per_page"];
|
|
22275
22596
|
/** @description Filter the results by currency, expressed as an ISO 4217 code. */
|
|
22276
22597
|
currency?: components["parameters"]["currency"];
|
|
22277
|
-
/** @description
|
|
22278
|
-
external_customer_id
|
|
22598
|
+
/** @description Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization are returned. */
|
|
22599
|
+
external_customer_id?: string;
|
|
22279
22600
|
/** @description Filter wallets by billing entity codes. */
|
|
22280
22601
|
"billing_entity_codes[]"?: string[];
|
|
22281
22602
|
};
|
|
@@ -22891,7 +23212,11 @@ export interface operations {
|
|
|
22891
23212
|
parameters: {
|
|
22892
23213
|
query?: never;
|
|
22893
23214
|
header: {
|
|
22894
|
-
/**
|
|
23215
|
+
/**
|
|
23216
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23217
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23218
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23219
|
+
*/
|
|
22895
23220
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
22896
23221
|
/** @description Algorithm used to generate the signature */
|
|
22897
23222
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -22933,7 +23258,11 @@ export interface operations {
|
|
|
22933
23258
|
parameters: {
|
|
22934
23259
|
query?: never;
|
|
22935
23260
|
header: {
|
|
22936
|
-
/**
|
|
23261
|
+
/**
|
|
23262
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23263
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23264
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23265
|
+
*/
|
|
22937
23266
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
22938
23267
|
/** @description Algorithm used to generate the signature */
|
|
22939
23268
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -22975,7 +23304,11 @@ export interface operations {
|
|
|
22975
23304
|
parameters: {
|
|
22976
23305
|
query?: never;
|
|
22977
23306
|
header: {
|
|
22978
|
-
/**
|
|
23307
|
+
/**
|
|
23308
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23309
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23310
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23311
|
+
*/
|
|
22979
23312
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
22980
23313
|
/** @description Algorithm used to generate the signature */
|
|
22981
23314
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23017,7 +23350,11 @@ export interface operations {
|
|
|
23017
23350
|
parameters: {
|
|
23018
23351
|
query?: never;
|
|
23019
23352
|
header: {
|
|
23020
|
-
/**
|
|
23353
|
+
/**
|
|
23354
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23355
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23356
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23357
|
+
*/
|
|
23021
23358
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23022
23359
|
/** @description Algorithm used to generate the signature */
|
|
23023
23360
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23059,7 +23396,11 @@ export interface operations {
|
|
|
23059
23396
|
parameters: {
|
|
23060
23397
|
query?: never;
|
|
23061
23398
|
header: {
|
|
23062
|
-
/**
|
|
23399
|
+
/**
|
|
23400
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23401
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23402
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23403
|
+
*/
|
|
23063
23404
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23064
23405
|
/** @description Algorithm used to generate the signature */
|
|
23065
23406
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23101,7 +23442,11 @@ export interface operations {
|
|
|
23101
23442
|
parameters: {
|
|
23102
23443
|
query?: never;
|
|
23103
23444
|
header: {
|
|
23104
|
-
/**
|
|
23445
|
+
/**
|
|
23446
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23447
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23448
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23449
|
+
*/
|
|
23105
23450
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23106
23451
|
/** @description Algorithm used to generate the signature */
|
|
23107
23452
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23143,7 +23488,11 @@ export interface operations {
|
|
|
23143
23488
|
parameters: {
|
|
23144
23489
|
query?: never;
|
|
23145
23490
|
header: {
|
|
23146
|
-
/**
|
|
23491
|
+
/**
|
|
23492
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23493
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23494
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23495
|
+
*/
|
|
23147
23496
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23148
23497
|
/** @description Algorithm used to generate the signature */
|
|
23149
23498
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23185,7 +23534,11 @@ export interface operations {
|
|
|
23185
23534
|
parameters: {
|
|
23186
23535
|
query?: never;
|
|
23187
23536
|
header: {
|
|
23188
|
-
/**
|
|
23537
|
+
/**
|
|
23538
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23539
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23540
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23541
|
+
*/
|
|
23189
23542
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23190
23543
|
/** @description Algorithm used to generate the signature */
|
|
23191
23544
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23209,7 +23562,7 @@ export interface operations {
|
|
|
23209
23562
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
23210
23563
|
*/
|
|
23211
23564
|
organization_id: string;
|
|
23212
|
-
accounting_provider_customer_error: components["schemas"]["
|
|
23565
|
+
accounting_provider_customer_error: components["schemas"]["CustomerIntegrationErrorObject"];
|
|
23213
23566
|
};
|
|
23214
23567
|
};
|
|
23215
23568
|
};
|
|
@@ -23227,7 +23580,11 @@ export interface operations {
|
|
|
23227
23580
|
parameters: {
|
|
23228
23581
|
query?: never;
|
|
23229
23582
|
header: {
|
|
23230
|
-
/**
|
|
23583
|
+
/**
|
|
23584
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23585
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23586
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23587
|
+
*/
|
|
23231
23588
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23232
23589
|
/** @description Algorithm used to generate the signature */
|
|
23233
23590
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23269,7 +23626,11 @@ export interface operations {
|
|
|
23269
23626
|
parameters: {
|
|
23270
23627
|
query?: never;
|
|
23271
23628
|
header: {
|
|
23272
|
-
/**
|
|
23629
|
+
/**
|
|
23630
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23631
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23632
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23633
|
+
*/
|
|
23273
23634
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23274
23635
|
/** @description Algorithm used to generate the signature */
|
|
23275
23636
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23293,7 +23654,7 @@ export interface operations {
|
|
|
23293
23654
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
23294
23655
|
*/
|
|
23295
23656
|
organization_id: string;
|
|
23296
|
-
crm_provider_customer_error: components["schemas"]["
|
|
23657
|
+
crm_provider_customer_error: components["schemas"]["CustomerIntegrationErrorObject"];
|
|
23297
23658
|
};
|
|
23298
23659
|
};
|
|
23299
23660
|
};
|
|
@@ -23311,7 +23672,11 @@ export interface operations {
|
|
|
23311
23672
|
parameters: {
|
|
23312
23673
|
query?: never;
|
|
23313
23674
|
header: {
|
|
23314
|
-
/**
|
|
23675
|
+
/**
|
|
23676
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23677
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23678
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23679
|
+
*/
|
|
23315
23680
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23316
23681
|
/** @description Algorithm used to generate the signature */
|
|
23317
23682
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23353,7 +23718,11 @@ export interface operations {
|
|
|
23353
23718
|
parameters: {
|
|
23354
23719
|
query?: never;
|
|
23355
23720
|
header: {
|
|
23356
|
-
/**
|
|
23721
|
+
/**
|
|
23722
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23723
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23724
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23725
|
+
*/
|
|
23357
23726
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23358
23727
|
/** @description Algorithm used to generate the signature */
|
|
23359
23728
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23395,7 +23764,11 @@ export interface operations {
|
|
|
23395
23764
|
parameters: {
|
|
23396
23765
|
query?: never;
|
|
23397
23766
|
header: {
|
|
23398
|
-
/**
|
|
23767
|
+
/**
|
|
23768
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23769
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23770
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23771
|
+
*/
|
|
23399
23772
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23400
23773
|
/** @description Algorithm used to generate the signature */
|
|
23401
23774
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23437,7 +23810,11 @@ export interface operations {
|
|
|
23437
23810
|
parameters: {
|
|
23438
23811
|
query?: never;
|
|
23439
23812
|
header: {
|
|
23440
|
-
/**
|
|
23813
|
+
/**
|
|
23814
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23815
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23816
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23817
|
+
*/
|
|
23441
23818
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23442
23819
|
/** @description Algorithm used to generate the signature */
|
|
23443
23820
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23479,7 +23856,11 @@ export interface operations {
|
|
|
23479
23856
|
parameters: {
|
|
23480
23857
|
query?: never;
|
|
23481
23858
|
header: {
|
|
23482
|
-
/**
|
|
23859
|
+
/**
|
|
23860
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23861
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23862
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23863
|
+
*/
|
|
23483
23864
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23484
23865
|
/** @description Algorithm used to generate the signature */
|
|
23485
23866
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23521,7 +23902,11 @@ export interface operations {
|
|
|
23521
23902
|
parameters: {
|
|
23522
23903
|
query?: never;
|
|
23523
23904
|
header: {
|
|
23524
|
-
/**
|
|
23905
|
+
/**
|
|
23906
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23907
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23908
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23909
|
+
*/
|
|
23525
23910
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23526
23911
|
/** @description Algorithm used to generate the signature */
|
|
23527
23912
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23563,7 +23948,11 @@ export interface operations {
|
|
|
23563
23948
|
parameters: {
|
|
23564
23949
|
query?: never;
|
|
23565
23950
|
header: {
|
|
23566
|
-
/**
|
|
23951
|
+
/**
|
|
23952
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23953
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
23954
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
23955
|
+
*/
|
|
23567
23956
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23568
23957
|
/** @description Algorithm used to generate the signature */
|
|
23569
23958
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23605,7 +23994,11 @@ export interface operations {
|
|
|
23605
23994
|
parameters: {
|
|
23606
23995
|
query?: never;
|
|
23607
23996
|
header: {
|
|
23608
|
-
/**
|
|
23997
|
+
/**
|
|
23998
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
23999
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24000
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24001
|
+
*/
|
|
23609
24002
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23610
24003
|
/** @description Algorithm used to generate the signature */
|
|
23611
24004
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23641,7 +24034,11 @@ export interface operations {
|
|
|
23641
24034
|
parameters: {
|
|
23642
24035
|
query?: never;
|
|
23643
24036
|
header: {
|
|
23644
|
-
/**
|
|
24037
|
+
/**
|
|
24038
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24039
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24040
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24041
|
+
*/
|
|
23645
24042
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23646
24043
|
/** @description Algorithm used to generate the signature */
|
|
23647
24044
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23683,7 +24080,11 @@ export interface operations {
|
|
|
23683
24080
|
parameters: {
|
|
23684
24081
|
query?: never;
|
|
23685
24082
|
header: {
|
|
23686
|
-
/**
|
|
24083
|
+
/**
|
|
24084
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24085
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24086
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24087
|
+
*/
|
|
23687
24088
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23688
24089
|
/** @description Algorithm used to generate the signature */
|
|
23689
24090
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23725,7 +24126,11 @@ export interface operations {
|
|
|
23725
24126
|
parameters: {
|
|
23726
24127
|
query?: never;
|
|
23727
24128
|
header: {
|
|
23728
|
-
/**
|
|
24129
|
+
/**
|
|
24130
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24131
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24132
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24133
|
+
*/
|
|
23729
24134
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23730
24135
|
/** @description Algorithm used to generate the signature */
|
|
23731
24136
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23767,7 +24172,11 @@ export interface operations {
|
|
|
23767
24172
|
parameters: {
|
|
23768
24173
|
query?: never;
|
|
23769
24174
|
header: {
|
|
23770
|
-
/**
|
|
24175
|
+
/**
|
|
24176
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24177
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24178
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24179
|
+
*/
|
|
23771
24180
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23772
24181
|
/** @description Algorithm used to generate the signature */
|
|
23773
24182
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23809,7 +24218,11 @@ export interface operations {
|
|
|
23809
24218
|
parameters: {
|
|
23810
24219
|
query?: never;
|
|
23811
24220
|
header: {
|
|
23812
|
-
/**
|
|
24221
|
+
/**
|
|
24222
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24223
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24224
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24225
|
+
*/
|
|
23813
24226
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23814
24227
|
/** @description Algorithm used to generate the signature */
|
|
23815
24228
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23851,7 +24264,11 @@ export interface operations {
|
|
|
23851
24264
|
parameters: {
|
|
23852
24265
|
query?: never;
|
|
23853
24266
|
header: {
|
|
23854
|
-
/**
|
|
24267
|
+
/**
|
|
24268
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24269
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24270
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24271
|
+
*/
|
|
23855
24272
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23856
24273
|
/** @description Algorithm used to generate the signature */
|
|
23857
24274
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23893,7 +24310,11 @@ export interface operations {
|
|
|
23893
24310
|
parameters: {
|
|
23894
24311
|
query?: never;
|
|
23895
24312
|
header: {
|
|
23896
|
-
/**
|
|
24313
|
+
/**
|
|
24314
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24315
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24316
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24317
|
+
*/
|
|
23897
24318
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23898
24319
|
/** @description Algorithm used to generate the signature */
|
|
23899
24320
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23935,7 +24356,11 @@ export interface operations {
|
|
|
23935
24356
|
parameters: {
|
|
23936
24357
|
query?: never;
|
|
23937
24358
|
header: {
|
|
23938
|
-
/**
|
|
24359
|
+
/**
|
|
24360
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24361
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24362
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24363
|
+
*/
|
|
23939
24364
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23940
24365
|
/** @description Algorithm used to generate the signature */
|
|
23941
24366
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -23977,7 +24402,11 @@ export interface operations {
|
|
|
23977
24402
|
parameters: {
|
|
23978
24403
|
query?: never;
|
|
23979
24404
|
header: {
|
|
23980
|
-
/**
|
|
24405
|
+
/**
|
|
24406
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24407
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24408
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24409
|
+
*/
|
|
23981
24410
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
23982
24411
|
/** @description Algorithm used to generate the signature */
|
|
23983
24412
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24019,7 +24448,11 @@ export interface operations {
|
|
|
24019
24448
|
parameters: {
|
|
24020
24449
|
query?: never;
|
|
24021
24450
|
header: {
|
|
24022
|
-
/**
|
|
24451
|
+
/**
|
|
24452
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24453
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24454
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24455
|
+
*/
|
|
24023
24456
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24024
24457
|
/** @description Algorithm used to generate the signature */
|
|
24025
24458
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24061,7 +24494,11 @@ export interface operations {
|
|
|
24061
24494
|
parameters: {
|
|
24062
24495
|
query?: never;
|
|
24063
24496
|
header: {
|
|
24064
|
-
/**
|
|
24497
|
+
/**
|
|
24498
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24499
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24500
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24501
|
+
*/
|
|
24065
24502
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24066
24503
|
/** @description Algorithm used to generate the signature */
|
|
24067
24504
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24103,8 +24540,12 @@ export interface operations {
|
|
|
24103
24540
|
parameters: {
|
|
24104
24541
|
query?: never;
|
|
24105
24542
|
header: {
|
|
24106
|
-
/**
|
|
24107
|
-
|
|
24543
|
+
/**
|
|
24544
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24545
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24546
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24547
|
+
*/
|
|
24548
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24108
24549
|
/** @description Algorithm used to generate the signature */
|
|
24109
24550
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
24110
24551
|
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
@@ -24145,7 +24586,11 @@ export interface operations {
|
|
|
24145
24586
|
parameters: {
|
|
24146
24587
|
query?: never;
|
|
24147
24588
|
header: {
|
|
24148
|
-
/**
|
|
24589
|
+
/**
|
|
24590
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24591
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24592
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24593
|
+
*/
|
|
24149
24594
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24150
24595
|
/** @description Algorithm used to generate the signature */
|
|
24151
24596
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24187,7 +24632,11 @@ export interface operations {
|
|
|
24187
24632
|
parameters: {
|
|
24188
24633
|
query?: never;
|
|
24189
24634
|
header: {
|
|
24190
|
-
/**
|
|
24635
|
+
/**
|
|
24636
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24637
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24638
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24639
|
+
*/
|
|
24191
24640
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24192
24641
|
/** @description Algorithm used to generate the signature */
|
|
24193
24642
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24229,7 +24678,11 @@ export interface operations {
|
|
|
24229
24678
|
parameters: {
|
|
24230
24679
|
query?: never;
|
|
24231
24680
|
header: {
|
|
24232
|
-
/**
|
|
24681
|
+
/**
|
|
24682
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24683
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24684
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24685
|
+
*/
|
|
24233
24686
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24234
24687
|
/** @description Algorithm used to generate the signature */
|
|
24235
24688
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24271,7 +24724,11 @@ export interface operations {
|
|
|
24271
24724
|
parameters: {
|
|
24272
24725
|
query?: never;
|
|
24273
24726
|
header: {
|
|
24274
|
-
/**
|
|
24727
|
+
/**
|
|
24728
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24729
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24730
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24731
|
+
*/
|
|
24275
24732
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24276
24733
|
/** @description Algorithm used to generate the signature */
|
|
24277
24734
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24313,7 +24770,11 @@ export interface operations {
|
|
|
24313
24770
|
parameters: {
|
|
24314
24771
|
query?: never;
|
|
24315
24772
|
header: {
|
|
24316
|
-
/**
|
|
24773
|
+
/**
|
|
24774
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24775
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24776
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24777
|
+
*/
|
|
24317
24778
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24318
24779
|
/** @description Algorithm used to generate the signature */
|
|
24319
24780
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24355,7 +24816,11 @@ export interface operations {
|
|
|
24355
24816
|
parameters: {
|
|
24356
24817
|
query?: never;
|
|
24357
24818
|
header: {
|
|
24358
|
-
/**
|
|
24819
|
+
/**
|
|
24820
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24821
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24822
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24823
|
+
*/
|
|
24359
24824
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24360
24825
|
/** @description Algorithm used to generate the signature */
|
|
24361
24826
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24397,7 +24862,11 @@ export interface operations {
|
|
|
24397
24862
|
parameters: {
|
|
24398
24863
|
query?: never;
|
|
24399
24864
|
header: {
|
|
24400
|
-
/**
|
|
24865
|
+
/**
|
|
24866
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24867
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24868
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24869
|
+
*/
|
|
24401
24870
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24402
24871
|
/** @description Algorithm used to generate the signature */
|
|
24403
24872
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24439,7 +24908,11 @@ export interface operations {
|
|
|
24439
24908
|
parameters: {
|
|
24440
24909
|
query?: never;
|
|
24441
24910
|
header: {
|
|
24442
|
-
/**
|
|
24911
|
+
/**
|
|
24912
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24913
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24914
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24915
|
+
*/
|
|
24443
24916
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24444
24917
|
/** @description Algorithm used to generate the signature */
|
|
24445
24918
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24481,7 +24954,11 @@ export interface operations {
|
|
|
24481
24954
|
parameters: {
|
|
24482
24955
|
query?: never;
|
|
24483
24956
|
header: {
|
|
24484
|
-
/**
|
|
24957
|
+
/**
|
|
24958
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
24959
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
24960
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
24961
|
+
*/
|
|
24485
24962
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24486
24963
|
/** @description Algorithm used to generate the signature */
|
|
24487
24964
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24523,7 +25000,11 @@ export interface operations {
|
|
|
24523
25000
|
parameters: {
|
|
24524
25001
|
query?: never;
|
|
24525
25002
|
header: {
|
|
24526
|
-
/**
|
|
25003
|
+
/**
|
|
25004
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25005
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25006
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25007
|
+
*/
|
|
24527
25008
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24528
25009
|
/** @description Algorithm used to generate the signature */
|
|
24529
25010
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24565,7 +25046,11 @@ export interface operations {
|
|
|
24565
25046
|
parameters: {
|
|
24566
25047
|
query?: never;
|
|
24567
25048
|
header: {
|
|
24568
|
-
/**
|
|
25049
|
+
/**
|
|
25050
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25051
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25052
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25053
|
+
*/
|
|
24569
25054
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24570
25055
|
/** @description Algorithm used to generate the signature */
|
|
24571
25056
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24607,7 +25092,11 @@ export interface operations {
|
|
|
24607
25092
|
parameters: {
|
|
24608
25093
|
query?: never;
|
|
24609
25094
|
header: {
|
|
24610
|
-
/**
|
|
25095
|
+
/**
|
|
25096
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25097
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25098
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25099
|
+
*/
|
|
24611
25100
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24612
25101
|
/** @description Algorithm used to generate the signature */
|
|
24613
25102
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24649,7 +25138,11 @@ export interface operations {
|
|
|
24649
25138
|
parameters: {
|
|
24650
25139
|
query?: never;
|
|
24651
25140
|
header: {
|
|
24652
|
-
/**
|
|
25141
|
+
/**
|
|
25142
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25143
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25144
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25145
|
+
*/
|
|
24653
25146
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24654
25147
|
/** @description Algorithm used to generate the signature */
|
|
24655
25148
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24691,7 +25184,11 @@ export interface operations {
|
|
|
24691
25184
|
parameters: {
|
|
24692
25185
|
query?: never;
|
|
24693
25186
|
header: {
|
|
24694
|
-
/**
|
|
25187
|
+
/**
|
|
25188
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25189
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25190
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25191
|
+
*/
|
|
24695
25192
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24696
25193
|
/** @description Algorithm used to generate the signature */
|
|
24697
25194
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24733,7 +25230,11 @@ export interface operations {
|
|
|
24733
25230
|
parameters: {
|
|
24734
25231
|
query?: never;
|
|
24735
25232
|
header: {
|
|
24736
|
-
/**
|
|
25233
|
+
/**
|
|
25234
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25235
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25236
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25237
|
+
*/
|
|
24737
25238
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24738
25239
|
/** @description Algorithm used to generate the signature */
|
|
24739
25240
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24775,7 +25276,11 @@ export interface operations {
|
|
|
24775
25276
|
parameters: {
|
|
24776
25277
|
query?: never;
|
|
24777
25278
|
header: {
|
|
24778
|
-
/**
|
|
25279
|
+
/**
|
|
25280
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25281
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25282
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25283
|
+
*/
|
|
24779
25284
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24780
25285
|
/** @description Algorithm used to generate the signature */
|
|
24781
25286
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24817,7 +25322,11 @@ export interface operations {
|
|
|
24817
25322
|
parameters: {
|
|
24818
25323
|
query?: never;
|
|
24819
25324
|
header: {
|
|
24820
|
-
/**
|
|
25325
|
+
/**
|
|
25326
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25327
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25328
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25329
|
+
*/
|
|
24821
25330
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24822
25331
|
/** @description Algorithm used to generate the signature */
|
|
24823
25332
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24859,7 +25368,11 @@ export interface operations {
|
|
|
24859
25368
|
parameters: {
|
|
24860
25369
|
query?: never;
|
|
24861
25370
|
header: {
|
|
24862
|
-
/**
|
|
25371
|
+
/**
|
|
25372
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25373
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25374
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25375
|
+
*/
|
|
24863
25376
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24864
25377
|
/** @description Algorithm used to generate the signature */
|
|
24865
25378
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24901,7 +25414,11 @@ export interface operations {
|
|
|
24901
25414
|
parameters: {
|
|
24902
25415
|
query?: never;
|
|
24903
25416
|
header: {
|
|
24904
|
-
/**
|
|
25417
|
+
/**
|
|
25418
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25419
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25420
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25421
|
+
*/
|
|
24905
25422
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24906
25423
|
/** @description Algorithm used to generate the signature */
|
|
24907
25424
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24943,7 +25460,11 @@ export interface operations {
|
|
|
24943
25460
|
parameters: {
|
|
24944
25461
|
query?: never;
|
|
24945
25462
|
header: {
|
|
24946
|
-
/**
|
|
25463
|
+
/**
|
|
25464
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25465
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25466
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25467
|
+
*/
|
|
24947
25468
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24948
25469
|
/** @description Algorithm used to generate the signature */
|
|
24949
25470
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -24981,11 +25502,107 @@ export interface operations {
|
|
|
24981
25502
|
};
|
|
24982
25503
|
};
|
|
24983
25504
|
};
|
|
25505
|
+
paymentReceiptCreated: {
|
|
25506
|
+
parameters: {
|
|
25507
|
+
query?: never;
|
|
25508
|
+
header: {
|
|
25509
|
+
/**
|
|
25510
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25511
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25512
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25513
|
+
*/
|
|
25514
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25515
|
+
/** @description Algorithm used to generate the signature */
|
|
25516
|
+
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
25517
|
+
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
25518
|
+
"X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
|
|
25519
|
+
};
|
|
25520
|
+
path?: never;
|
|
25521
|
+
cookie?: never;
|
|
25522
|
+
};
|
|
25523
|
+
/** @description Details of the new payment receipt */
|
|
25524
|
+
requestBody?: {
|
|
25525
|
+
content: {
|
|
25526
|
+
"application/json": {
|
|
25527
|
+
/** @enum {string} */
|
|
25528
|
+
webhook_type: "payment_receipt.created";
|
|
25529
|
+
/** @enum {string} */
|
|
25530
|
+
object_type: "payment_receipt";
|
|
25531
|
+
/**
|
|
25532
|
+
* Format: uuid
|
|
25533
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
25534
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
25535
|
+
*/
|
|
25536
|
+
organization_id: string;
|
|
25537
|
+
payment_receipt: components["schemas"]["PaymentReceiptObject"];
|
|
25538
|
+
};
|
|
25539
|
+
};
|
|
25540
|
+
};
|
|
25541
|
+
responses: {
|
|
25542
|
+
/** @description Return a 200 status to indicate that the data was received successfully */
|
|
25543
|
+
200: {
|
|
25544
|
+
headers: {
|
|
25545
|
+
[name: string]: unknown;
|
|
25546
|
+
};
|
|
25547
|
+
content?: never;
|
|
25548
|
+
};
|
|
25549
|
+
};
|
|
25550
|
+
};
|
|
25551
|
+
paymentReceiptGenerated: {
|
|
25552
|
+
parameters: {
|
|
25553
|
+
query?: never;
|
|
25554
|
+
header: {
|
|
25555
|
+
/**
|
|
25556
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25557
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25558
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25559
|
+
*/
|
|
25560
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25561
|
+
/** @description Algorithm used to generate the signature */
|
|
25562
|
+
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
25563
|
+
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
25564
|
+
"X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
|
|
25565
|
+
};
|
|
25566
|
+
path?: never;
|
|
25567
|
+
cookie?: never;
|
|
25568
|
+
};
|
|
25569
|
+
/** @description Details of the payment receipt whose PDF has been generated */
|
|
25570
|
+
requestBody?: {
|
|
25571
|
+
content: {
|
|
25572
|
+
"application/json": {
|
|
25573
|
+
/** @enum {string} */
|
|
25574
|
+
webhook_type: "payment_receipt.generated";
|
|
25575
|
+
/** @enum {string} */
|
|
25576
|
+
object_type: "payment_receipt";
|
|
25577
|
+
/**
|
|
25578
|
+
* Format: uuid
|
|
25579
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
25580
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
25581
|
+
*/
|
|
25582
|
+
organization_id: string;
|
|
25583
|
+
payment_receipt: components["schemas"]["PaymentReceiptObject"];
|
|
25584
|
+
};
|
|
25585
|
+
};
|
|
25586
|
+
};
|
|
25587
|
+
responses: {
|
|
25588
|
+
/** @description Return a 200 status to indicate that the data was received successfully */
|
|
25589
|
+
200: {
|
|
25590
|
+
headers: {
|
|
25591
|
+
[name: string]: unknown;
|
|
25592
|
+
};
|
|
25593
|
+
content?: never;
|
|
25594
|
+
};
|
|
25595
|
+
};
|
|
25596
|
+
};
|
|
24984
25597
|
paymentRequestCreated: {
|
|
24985
25598
|
parameters: {
|
|
24986
25599
|
query?: never;
|
|
24987
25600
|
header: {
|
|
24988
|
-
/**
|
|
25601
|
+
/**
|
|
25602
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25603
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25604
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25605
|
+
*/
|
|
24989
25606
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
24990
25607
|
/** @description Algorithm used to generate the signature */
|
|
24991
25608
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25027,7 +25644,11 @@ export interface operations {
|
|
|
25027
25644
|
parameters: {
|
|
25028
25645
|
query?: never;
|
|
25029
25646
|
header: {
|
|
25030
|
-
/**
|
|
25647
|
+
/**
|
|
25648
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25649
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25650
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25651
|
+
*/
|
|
25031
25652
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25032
25653
|
/** @description Algorithm used to generate the signature */
|
|
25033
25654
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25069,7 +25690,11 @@ export interface operations {
|
|
|
25069
25690
|
parameters: {
|
|
25070
25691
|
query?: never;
|
|
25071
25692
|
header: {
|
|
25072
|
-
/**
|
|
25693
|
+
/**
|
|
25694
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25695
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25696
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25697
|
+
*/
|
|
25073
25698
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25074
25699
|
/** @description Algorithm used to generate the signature */
|
|
25075
25700
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25111,7 +25736,11 @@ export interface operations {
|
|
|
25111
25736
|
parameters: {
|
|
25112
25737
|
query?: never;
|
|
25113
25738
|
header: {
|
|
25114
|
-
/**
|
|
25739
|
+
/**
|
|
25740
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25741
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25742
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25743
|
+
*/
|
|
25115
25744
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25116
25745
|
/** @description Algorithm used to generate the signature */
|
|
25117
25746
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25153,7 +25782,11 @@ export interface operations {
|
|
|
25153
25782
|
parameters: {
|
|
25154
25783
|
query?: never;
|
|
25155
25784
|
header: {
|
|
25156
|
-
/**
|
|
25785
|
+
/**
|
|
25786
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25787
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25788
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25789
|
+
*/
|
|
25157
25790
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25158
25791
|
/** @description Algorithm used to generate the signature */
|
|
25159
25792
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25195,7 +25828,11 @@ export interface operations {
|
|
|
25195
25828
|
parameters: {
|
|
25196
25829
|
query?: never;
|
|
25197
25830
|
header: {
|
|
25198
|
-
/**
|
|
25831
|
+
/**
|
|
25832
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25833
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25834
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25835
|
+
*/
|
|
25199
25836
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25200
25837
|
/** @description Algorithm used to generate the signature */
|
|
25201
25838
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25237,7 +25874,11 @@ export interface operations {
|
|
|
25237
25874
|
parameters: {
|
|
25238
25875
|
query?: never;
|
|
25239
25876
|
header: {
|
|
25240
|
-
/**
|
|
25877
|
+
/**
|
|
25878
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25879
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25880
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25881
|
+
*/
|
|
25241
25882
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25242
25883
|
/** @description Algorithm used to generate the signature */
|
|
25243
25884
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25279,7 +25920,11 @@ export interface operations {
|
|
|
25279
25920
|
parameters: {
|
|
25280
25921
|
query?: never;
|
|
25281
25922
|
header: {
|
|
25282
|
-
/**
|
|
25923
|
+
/**
|
|
25924
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25925
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25926
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25927
|
+
*/
|
|
25283
25928
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25284
25929
|
/** @description Algorithm used to generate the signature */
|
|
25285
25930
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25321,7 +25966,11 @@ export interface operations {
|
|
|
25321
25966
|
parameters: {
|
|
25322
25967
|
query?: never;
|
|
25323
25968
|
header: {
|
|
25324
|
-
/**
|
|
25969
|
+
/**
|
|
25970
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
25971
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
25972
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
25973
|
+
*/
|
|
25325
25974
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25326
25975
|
/** @description Algorithm used to generate the signature */
|
|
25327
25976
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25363,7 +26012,11 @@ export interface operations {
|
|
|
25363
26012
|
parameters: {
|
|
25364
26013
|
query?: never;
|
|
25365
26014
|
header: {
|
|
25366
|
-
/**
|
|
26015
|
+
/**
|
|
26016
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26017
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26018
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26019
|
+
*/
|
|
25367
26020
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25368
26021
|
/** @description Algorithm used to generate the signature */
|
|
25369
26022
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25405,7 +26058,11 @@ export interface operations {
|
|
|
25405
26058
|
parameters: {
|
|
25406
26059
|
query?: never;
|
|
25407
26060
|
header: {
|
|
25408
|
-
/**
|
|
26061
|
+
/**
|
|
26062
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26063
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26064
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26065
|
+
*/
|
|
25409
26066
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25410
26067
|
/** @description Algorithm used to generate the signature */
|
|
25411
26068
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25447,7 +26104,11 @@ export interface operations {
|
|
|
25447
26104
|
parameters: {
|
|
25448
26105
|
query?: never;
|
|
25449
26106
|
header: {
|
|
25450
|
-
/**
|
|
26107
|
+
/**
|
|
26108
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26109
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26110
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26111
|
+
*/
|
|
25451
26112
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25452
26113
|
/** @description Algorithm used to generate the signature */
|
|
25453
26114
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25489,7 +26150,11 @@ export interface operations {
|
|
|
25489
26150
|
parameters: {
|
|
25490
26151
|
query?: never;
|
|
25491
26152
|
header: {
|
|
25492
|
-
/**
|
|
26153
|
+
/**
|
|
26154
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26155
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26156
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26157
|
+
*/
|
|
25493
26158
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25494
26159
|
/** @description Algorithm used to generate the signature */
|
|
25495
26160
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25531,7 +26196,11 @@ export interface operations {
|
|
|
25531
26196
|
parameters: {
|
|
25532
26197
|
query?: never;
|
|
25533
26198
|
header: {
|
|
25534
|
-
/**
|
|
26199
|
+
/**
|
|
26200
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26201
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26202
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26203
|
+
*/
|
|
25535
26204
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25536
26205
|
/** @description Algorithm used to generate the signature */
|
|
25537
26206
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25573,7 +26242,11 @@ export interface operations {
|
|
|
25573
26242
|
parameters: {
|
|
25574
26243
|
query?: never;
|
|
25575
26244
|
header: {
|
|
25576
|
-
/**
|
|
26245
|
+
/**
|
|
26246
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26247
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26248
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26249
|
+
*/
|
|
25577
26250
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25578
26251
|
/** @description Algorithm used to generate the signature */
|
|
25579
26252
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25615,7 +26288,11 @@ export interface operations {
|
|
|
25615
26288
|
parameters: {
|
|
25616
26289
|
query?: never;
|
|
25617
26290
|
header: {
|
|
25618
|
-
/**
|
|
26291
|
+
/**
|
|
26292
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26293
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26294
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26295
|
+
*/
|
|
25619
26296
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25620
26297
|
/** @description Algorithm used to generate the signature */
|
|
25621
26298
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25657,7 +26334,11 @@ export interface operations {
|
|
|
25657
26334
|
parameters: {
|
|
25658
26335
|
query?: never;
|
|
25659
26336
|
header: {
|
|
25660
|
-
/**
|
|
26337
|
+
/**
|
|
26338
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26339
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26340
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26341
|
+
*/
|
|
25661
26342
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25662
26343
|
/** @description Algorithm used to generate the signature */
|
|
25663
26344
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25695,11 +26376,153 @@ export interface operations {
|
|
|
25695
26376
|
};
|
|
25696
26377
|
};
|
|
25697
26378
|
};
|
|
26379
|
+
walletCreated: {
|
|
26380
|
+
parameters: {
|
|
26381
|
+
query?: never;
|
|
26382
|
+
header: {
|
|
26383
|
+
/**
|
|
26384
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26385
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26386
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26387
|
+
*/
|
|
26388
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
26389
|
+
/** @description Algorithm used to generate the signature */
|
|
26390
|
+
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
26391
|
+
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
26392
|
+
"X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
|
|
26393
|
+
};
|
|
26394
|
+
path?: never;
|
|
26395
|
+
cookie?: never;
|
|
26396
|
+
};
|
|
26397
|
+
/** @description Details of the new wallet */
|
|
26398
|
+
requestBody?: {
|
|
26399
|
+
content: {
|
|
26400
|
+
"application/json": {
|
|
26401
|
+
/** @enum {string} */
|
|
26402
|
+
webhook_type: "wallet.created";
|
|
26403
|
+
/** @enum {string} */
|
|
26404
|
+
object_type: "wallet";
|
|
26405
|
+
/**
|
|
26406
|
+
* Format: uuid
|
|
26407
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
26408
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
26409
|
+
*/
|
|
26410
|
+
organization_id: string;
|
|
26411
|
+
wallet: components["schemas"]["WalletObject"];
|
|
26412
|
+
};
|
|
26413
|
+
};
|
|
26414
|
+
};
|
|
26415
|
+
responses: {
|
|
26416
|
+
/** @description Return a 200 status to indicate that the data was received successfully */
|
|
26417
|
+
200: {
|
|
26418
|
+
headers: {
|
|
26419
|
+
[name: string]: unknown;
|
|
26420
|
+
};
|
|
26421
|
+
content?: never;
|
|
26422
|
+
};
|
|
26423
|
+
};
|
|
26424
|
+
};
|
|
26425
|
+
walletUpdated: {
|
|
26426
|
+
parameters: {
|
|
26427
|
+
query?: never;
|
|
26428
|
+
header: {
|
|
26429
|
+
/**
|
|
26430
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26431
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26432
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26433
|
+
*/
|
|
26434
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
26435
|
+
/** @description Algorithm used to generate the signature */
|
|
26436
|
+
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
26437
|
+
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
26438
|
+
"X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
|
|
26439
|
+
};
|
|
26440
|
+
path?: never;
|
|
26441
|
+
cookie?: never;
|
|
26442
|
+
};
|
|
26443
|
+
/** @description Details of the updated wallet */
|
|
26444
|
+
requestBody?: {
|
|
26445
|
+
content: {
|
|
26446
|
+
"application/json": {
|
|
26447
|
+
/** @enum {string} */
|
|
26448
|
+
webhook_type: "wallet.updated";
|
|
26449
|
+
/** @enum {string} */
|
|
26450
|
+
object_type: "wallet";
|
|
26451
|
+
/**
|
|
26452
|
+
* Format: uuid
|
|
26453
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
26454
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
26455
|
+
*/
|
|
26456
|
+
organization_id: string;
|
|
26457
|
+
wallet: components["schemas"]["WalletObject"];
|
|
26458
|
+
};
|
|
26459
|
+
};
|
|
26460
|
+
};
|
|
26461
|
+
responses: {
|
|
26462
|
+
/** @description Return a 200 status to indicate that the data was received successfully */
|
|
26463
|
+
200: {
|
|
26464
|
+
headers: {
|
|
26465
|
+
[name: string]: unknown;
|
|
26466
|
+
};
|
|
26467
|
+
content?: never;
|
|
26468
|
+
};
|
|
26469
|
+
};
|
|
26470
|
+
};
|
|
26471
|
+
walletTerminated: {
|
|
26472
|
+
parameters: {
|
|
26473
|
+
query?: never;
|
|
26474
|
+
header: {
|
|
26475
|
+
/**
|
|
26476
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26477
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26478
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26479
|
+
*/
|
|
26480
|
+
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
26481
|
+
/** @description Algorithm used to generate the signature */
|
|
26482
|
+
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
26483
|
+
/** @description Unique id of the webhook. It can be used for idempotency */
|
|
26484
|
+
"X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
|
|
26485
|
+
};
|
|
26486
|
+
path?: never;
|
|
26487
|
+
cookie?: never;
|
|
26488
|
+
};
|
|
26489
|
+
/** @description Details of the terminated wallet */
|
|
26490
|
+
requestBody?: {
|
|
26491
|
+
content: {
|
|
26492
|
+
"application/json": {
|
|
26493
|
+
/** @enum {string} */
|
|
26494
|
+
webhook_type: "wallet.terminated";
|
|
26495
|
+
/** @enum {string} */
|
|
26496
|
+
object_type: "wallet";
|
|
26497
|
+
/**
|
|
26498
|
+
* Format: uuid
|
|
26499
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
26500
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
26501
|
+
*/
|
|
26502
|
+
organization_id: string;
|
|
26503
|
+
wallet: components["schemas"]["WalletObject"];
|
|
26504
|
+
};
|
|
26505
|
+
};
|
|
26506
|
+
};
|
|
26507
|
+
responses: {
|
|
26508
|
+
/** @description Return a 200 status to indicate that the data was received successfully */
|
|
26509
|
+
200: {
|
|
26510
|
+
headers: {
|
|
26511
|
+
[name: string]: unknown;
|
|
26512
|
+
};
|
|
26513
|
+
content?: never;
|
|
26514
|
+
};
|
|
26515
|
+
};
|
|
26516
|
+
};
|
|
25698
26517
|
walletDepletedOngoingBalance: {
|
|
25699
26518
|
parameters: {
|
|
25700
26519
|
query?: never;
|
|
25701
26520
|
header: {
|
|
25702
|
-
/**
|
|
26521
|
+
/**
|
|
26522
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26523
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26524
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26525
|
+
*/
|
|
25703
26526
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25704
26527
|
/** @description Algorithm used to generate the signature */
|
|
25705
26528
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25741,7 +26564,11 @@ export interface operations {
|
|
|
25741
26564
|
parameters: {
|
|
25742
26565
|
query?: never;
|
|
25743
26566
|
header: {
|
|
25744
|
-
/**
|
|
26567
|
+
/**
|
|
26568
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26569
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26570
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26571
|
+
*/
|
|
25745
26572
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25746
26573
|
/** @description Algorithm used to generate the signature */
|
|
25747
26574
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25783,7 +26610,11 @@ export interface operations {
|
|
|
25783
26610
|
parameters: {
|
|
25784
26611
|
query?: never;
|
|
25785
26612
|
header: {
|
|
25786
|
-
/**
|
|
26613
|
+
/**
|
|
26614
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26615
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26616
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26617
|
+
*/
|
|
25787
26618
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25788
26619
|
/** @description Algorithm used to generate the signature */
|
|
25789
26620
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|
|
@@ -25825,7 +26656,11 @@ export interface operations {
|
|
|
25825
26656
|
parameters: {
|
|
25826
26657
|
query?: never;
|
|
25827
26658
|
header: {
|
|
25828
|
-
/**
|
|
26659
|
+
/**
|
|
26660
|
+
* @description Signature of the webhook payload. The format depends on `X-Lago-Signature-Algorithm`:
|
|
26661
|
+
* `hmac` is the Base64 encoding of an HMAC-SHA256 digest of the payload,
|
|
26662
|
+
* `jwt` is an RS256 JSON Web Token (a string starting with `eyJ`).
|
|
26663
|
+
*/
|
|
25829
26664
|
"X-Lago-Signature": components["parameters"]["webhook_signature"];
|
|
25830
26665
|
/** @description Algorithm used to generate the signature */
|
|
25831
26666
|
"X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
|