lago-javascript-client 1.53.0 → 1.55.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 +233 -110
- package/esm/openapi/client.js +11 -10
- package/esm/openapi/webhooks.d.ts +222 -121
- package/package.json +1 -1
- package/script/openapi/client.d.ts +233 -110
- package/script/openapi/client.js +11 -10
- package/script/openapi/webhooks.d.ts +222 -121
|
@@ -264,7 +264,13 @@ export interface paths {
|
|
|
264
264
|
};
|
|
265
265
|
/**
|
|
266
266
|
* List MRR
|
|
267
|
-
* @description This
|
|
267
|
+
* @description Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:
|
|
268
|
+
*
|
|
269
|
+
* - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.
|
|
270
|
+
* - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).
|
|
271
|
+
* - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
|
|
272
|
+
* - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
|
|
273
|
+
* - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
|
|
268
274
|
*/
|
|
269
275
|
get: operations["findAllMrrs"];
|
|
270
276
|
put?: never;
|
|
@@ -485,8 +491,8 @@ export interface paths {
|
|
|
485
491
|
put?: never;
|
|
486
492
|
post?: never;
|
|
487
493
|
/**
|
|
488
|
-
* Delete a privilege
|
|
489
|
-
* @description
|
|
494
|
+
* Delete a privilege
|
|
495
|
+
* @description This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
|
|
490
496
|
*/
|
|
491
497
|
delete: operations["deleteFeaturePrivilege"];
|
|
492
498
|
options?: never;
|
|
@@ -1226,7 +1232,7 @@ export interface paths {
|
|
|
1226
1232
|
get?: never;
|
|
1227
1233
|
/**
|
|
1228
1234
|
* Set the payment method as default
|
|
1229
|
-
* @description
|
|
1235
|
+
* @description This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.
|
|
1230
1236
|
*/
|
|
1231
1237
|
put: operations["paymentMethodSetAsDefault"];
|
|
1232
1238
|
post?: never;
|
|
@@ -1901,7 +1907,7 @@ export interface paths {
|
|
|
1901
1907
|
query?: never;
|
|
1902
1908
|
header?: never;
|
|
1903
1909
|
path: {
|
|
1904
|
-
/** @description
|
|
1910
|
+
/** @description Unique identifier of the payment receipt. */
|
|
1905
1911
|
lago_id: string;
|
|
1906
1912
|
};
|
|
1907
1913
|
cookie?: never;
|
|
@@ -2094,7 +2100,7 @@ export interface paths {
|
|
|
2094
2100
|
head?: never;
|
|
2095
2101
|
/**
|
|
2096
2102
|
* Partial update of an entitlement
|
|
2097
|
-
* @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features
|
|
2103
|
+
* @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
|
|
2098
2104
|
*/
|
|
2099
2105
|
patch: operations["updateEntitlement"];
|
|
2100
2106
|
trace?: never;
|
|
@@ -2731,7 +2737,7 @@ export interface paths {
|
|
|
2731
2737
|
head?: never;
|
|
2732
2738
|
/**
|
|
2733
2739
|
* Update subscription entitlements
|
|
2734
|
-
* @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features
|
|
2740
|
+
* @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
|
|
2735
2741
|
*/
|
|
2736
2742
|
patch: operations["updateSubscriptionEntitlements"];
|
|
2737
2743
|
trace?: never;
|
|
@@ -2753,7 +2759,7 @@ export interface paths {
|
|
|
2753
2759
|
post?: never;
|
|
2754
2760
|
/**
|
|
2755
2761
|
* Remove an entitlement from a subscription
|
|
2756
|
-
* @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
|
|
2762
|
+
* @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
|
|
2757
2763
|
*/
|
|
2758
2764
|
delete: operations["destroySubscriptionEntitlement"];
|
|
2759
2765
|
options?: never;
|
|
@@ -2780,7 +2786,7 @@ export interface paths {
|
|
|
2780
2786
|
post?: never;
|
|
2781
2787
|
/**
|
|
2782
2788
|
* Remove a privilege from a subscription entitlement override
|
|
2783
|
-
* @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
|
|
2789
|
+
* @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
|
|
2784
2790
|
*/
|
|
2785
2791
|
delete: operations["destroySubscriptionEntitlementPrivilege"];
|
|
2786
2792
|
options?: never;
|
|
@@ -4408,8 +4414,8 @@ export interface webhooks {
|
|
|
4408
4414
|
get?: never;
|
|
4409
4415
|
put?: never;
|
|
4410
4416
|
/**
|
|
4411
|
-
*
|
|
4412
|
-
* @description
|
|
4417
|
+
* A new payment request has been created
|
|
4418
|
+
* @description A new payment request has been created
|
|
4413
4419
|
*/
|
|
4414
4420
|
post: operations["paymentRequestCreated"];
|
|
4415
4421
|
delete?: never;
|
|
@@ -4448,8 +4454,8 @@ export interface webhooks {
|
|
|
4448
4454
|
get?: never;
|
|
4449
4455
|
put?: never;
|
|
4450
4456
|
/**
|
|
4451
|
-
* The payment status of
|
|
4452
|
-
* @description The payment status of
|
|
4457
|
+
* The payment status of a payment request has been updated
|
|
4458
|
+
* @description The payment status of a payment request has been updated
|
|
4453
4459
|
*/
|
|
4454
4460
|
post: operations["paymentRequestPaymentStatusUpdated"];
|
|
4455
4461
|
delete?: never;
|
|
@@ -4888,7 +4894,7 @@ export interface components {
|
|
|
4888
4894
|
* @example USD
|
|
4889
4895
|
* @enum {string}
|
|
4890
4896
|
*/
|
|
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";
|
|
4897
|
+
Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
|
|
4892
4898
|
/**
|
|
4893
4899
|
* @example US
|
|
4894
4900
|
* @enum {string|null}
|
|
@@ -5541,8 +5547,8 @@ export interface components {
|
|
|
5541
5547
|
*/
|
|
5542
5548
|
user_email?: string | null;
|
|
5543
5549
|
/**
|
|
5544
|
-
* @description This field stores the
|
|
5545
|
-
* @example
|
|
5550
|
+
* @description This field stores the activity action that was performed on the activity_object.
|
|
5551
|
+
* @example billable_metric.created
|
|
5546
5552
|
*/
|
|
5547
5553
|
activity_type: string;
|
|
5548
5554
|
/**
|
|
@@ -5591,12 +5597,6 @@ export interface components {
|
|
|
5591
5597
|
* @example BillableMetric
|
|
5592
5598
|
*/
|
|
5593
5599
|
resource_type: string;
|
|
5594
|
-
/**
|
|
5595
|
-
* Format: uuid
|
|
5596
|
-
* @description Unique identifier for the organization associated with the activity log.
|
|
5597
|
-
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
5598
|
-
*/
|
|
5599
|
-
organization_id: string;
|
|
5600
5600
|
/**
|
|
5601
5601
|
* Format: date-time
|
|
5602
5602
|
* @description The logged date of the activity, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application
|
|
@@ -5765,10 +5765,14 @@ export interface components {
|
|
|
5765
5765
|
*/
|
|
5766
5766
|
logged_at: string;
|
|
5767
5767
|
/**
|
|
5768
|
-
*
|
|
5769
|
-
* @example {
|
|
5768
|
+
* @description The parameters of the request, keyed by their top-level name. Nested values are returned JSON-encoded.
|
|
5769
|
+
* @example {
|
|
5770
|
+
* "billable_metric": "{\"name\":\"Storage\",\"code\":\"storage\"}"
|
|
5771
|
+
* }
|
|
5770
5772
|
*/
|
|
5771
|
-
request_body:
|
|
5773
|
+
request_body: {
|
|
5774
|
+
[key: string]: unknown;
|
|
5775
|
+
};
|
|
5772
5776
|
/**
|
|
5773
5777
|
* @description This field represents the API origin of the requested URL
|
|
5774
5778
|
* @example https://app.lago.dev/
|
|
@@ -5792,10 +5796,14 @@ export interface components {
|
|
|
5792
5796
|
*/
|
|
5793
5797
|
request_id: string;
|
|
5794
5798
|
/**
|
|
5795
|
-
*
|
|
5796
|
-
* @example {
|
|
5799
|
+
* @description The body Lago returned for the request, keyed by its top-level name. Nested values are returned JSON-encoded. Null when the response had no body.
|
|
5800
|
+
* @example {
|
|
5801
|
+
* "billable_metric": "{\"lago_id\":\"b9155544-e261-4e92-b54e-f65d7609294c\"}"
|
|
5802
|
+
* }
|
|
5797
5803
|
*/
|
|
5798
|
-
request_response?:
|
|
5804
|
+
request_response?: {
|
|
5805
|
+
[key: string]: unknown;
|
|
5806
|
+
} | null;
|
|
5799
5807
|
};
|
|
5800
5808
|
ApiLogsPaginated: {
|
|
5801
5809
|
api_logs: components["schemas"]["ApiLogObject"][];
|
|
@@ -6001,7 +6009,7 @@ export interface components {
|
|
|
6001
6009
|
* @example USD
|
|
6002
6010
|
* @enum {string|null}
|
|
6003
6011
|
*/
|
|
6004
|
-
CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
|
|
6012
|
+
CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
|
|
6005
6013
|
AppliedCouponObject: {
|
|
6006
6014
|
/**
|
|
6007
6015
|
* Format: uuid
|
|
@@ -6025,6 +6033,11 @@ export interface components {
|
|
|
6025
6033
|
* @example Startup Deal
|
|
6026
6034
|
*/
|
|
6027
6035
|
coupon_name: string;
|
|
6036
|
+
/**
|
|
6037
|
+
* @description The description of the parent coupon.
|
|
6038
|
+
* @example I am a coupon description
|
|
6039
|
+
*/
|
|
6040
|
+
coupon_description?: string | null;
|
|
6028
6041
|
/**
|
|
6029
6042
|
* @description The status of the parent coupon. Can be either `active` or `terminated`.
|
|
6030
6043
|
* @example active
|
|
@@ -6286,10 +6299,10 @@ export interface components {
|
|
|
6286
6299
|
*/
|
|
6287
6300
|
created_at: string;
|
|
6288
6301
|
/**
|
|
6289
|
-
* @description Expression used to calculate the event units. The expression is
|
|
6302
|
+
* @description Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
|
|
6290
6303
|
* @example round((ended_at - started_at) * units)
|
|
6291
6304
|
*/
|
|
6292
|
-
expression?: string;
|
|
6305
|
+
expression?: string | null;
|
|
6293
6306
|
/**
|
|
6294
6307
|
* @description Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
|
|
6295
6308
|
* @example gb
|
|
@@ -6349,8 +6362,8 @@ export interface components {
|
|
|
6349
6362
|
*/
|
|
6350
6363
|
recurring?: boolean;
|
|
6351
6364
|
/**
|
|
6352
|
-
* @description Expression used to calculate the event units. The expression is
|
|
6353
|
-
* Accepted
|
|
6365
|
+
* @description Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
|
|
6366
|
+
* Accepted functions are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
|
|
6354
6367
|
* Round is accepting an optional second parameter to specify the number of decimal.
|
|
6355
6368
|
* @example round((ended_at - started_at) * units)
|
|
6356
6369
|
*/
|
|
@@ -6393,8 +6406,8 @@ export interface components {
|
|
|
6393
6406
|
};
|
|
6394
6407
|
BillableMetricEvaluateExpressionInput: {
|
|
6395
6408
|
/**
|
|
6396
|
-
* @description Expression used to calculate the event units. The expression is
|
|
6397
|
-
* Accepted
|
|
6409
|
+
* @description Expression used to calculate the event units. The expression is evaluated for each event and the result is then used to calculate the total aggregated units.
|
|
6410
|
+
* Accepted functions are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
|
|
6398
6411
|
* Round is accepting an optional second parameter to specify the number of decimal.
|
|
6399
6412
|
* @example round((ended_at - started_at) * units)
|
|
6400
6413
|
*/
|
|
@@ -8876,7 +8889,7 @@ export interface components {
|
|
|
8876
8889
|
/** @description List of invoice IDs associated with the payment. */
|
|
8877
8890
|
invoice_ids: string[];
|
|
8878
8891
|
/** @description List of invoice numbers associated with the payment. */
|
|
8879
|
-
invoice_numbers
|
|
8892
|
+
invoice_numbers: string[];
|
|
8880
8893
|
/**
|
|
8881
8894
|
* Format: uuid
|
|
8882
8895
|
* @description The unique identifier of the paid resource, created by Lago.
|
|
@@ -8917,15 +8930,15 @@ export interface components {
|
|
|
8917
8930
|
*/
|
|
8918
8931
|
type: "manual" | "provider";
|
|
8919
8932
|
/**
|
|
8920
|
-
* @description Reference for the payment.
|
|
8933
|
+
* @description Reference for the payment. Set on manual payments only; it is always `null` for payments collected through a payment provider.
|
|
8921
8934
|
* @example ref1
|
|
8922
8935
|
*/
|
|
8923
|
-
reference: string;
|
|
8936
|
+
reference: string | null;
|
|
8924
8937
|
/**
|
|
8925
|
-
* @description Code of the payment provider
|
|
8938
|
+
* @description Code of the payment provider. It is `null` for manual payments, which are not attached to a payment provider.
|
|
8926
8939
|
* @example stripe_prod
|
|
8927
8940
|
*/
|
|
8928
|
-
payment_provider_code: string;
|
|
8941
|
+
payment_provider_code: string | null;
|
|
8929
8942
|
/**
|
|
8930
8943
|
* @description The type of payment provider
|
|
8931
8944
|
* @example stripe
|
|
@@ -8940,16 +8953,10 @@ export interface components {
|
|
|
8940
8953
|
*/
|
|
8941
8954
|
provider_payment_id: string | null;
|
|
8942
8955
|
/**
|
|
8943
|
-
* @description Unique identifier of the customer within the payment provider
|
|
8956
|
+
* @description Unique identifier of the customer within the payment provider. It is `null` for manual payments.
|
|
8944
8957
|
* @example cus_5eb0285bcf941bc6ba
|
|
8945
8958
|
*/
|
|
8946
|
-
provider_customer_id: string;
|
|
8947
|
-
/**
|
|
8948
|
-
* Format: uuid
|
|
8949
|
-
* @description The unique identifier of the payment method used for this payment.
|
|
8950
|
-
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
8951
|
-
*/
|
|
8952
|
-
payment_method_id?: string | null;
|
|
8959
|
+
provider_customer_id: string | null;
|
|
8953
8960
|
/**
|
|
8954
8961
|
* @description The next action to be taken by the customer to complete the payment. Should usually be empty, except when receiving the `payment.requires_action` webhook.
|
|
8955
8962
|
* @example {
|
|
@@ -8983,10 +8990,10 @@ export interface components {
|
|
|
8983
8990
|
lago_id: string;
|
|
8984
8991
|
/**
|
|
8985
8992
|
* Format: email
|
|
8986
|
-
* @description The
|
|
8993
|
+
* @description The email address used for sending dunning notifications. It defaults to the customer's own email address, and is `null` when the customer has none.
|
|
8987
8994
|
* @example dinesh@piedpiper.test
|
|
8988
8995
|
*/
|
|
8989
|
-
email: string;
|
|
8996
|
+
email: string | null;
|
|
8990
8997
|
/**
|
|
8991
8998
|
* @description The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
|
|
8992
8999
|
* @example 100
|
|
@@ -9481,7 +9488,7 @@ export interface components {
|
|
|
9481
9488
|
*/
|
|
9482
9489
|
code?: string | null;
|
|
9483
9490
|
/**
|
|
9484
|
-
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
|
|
9491
|
+
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
|
|
9485
9492
|
* @example 50
|
|
9486
9493
|
*/
|
|
9487
9494
|
priority?: number;
|
|
@@ -9620,7 +9627,7 @@ export interface components {
|
|
|
9620
9627
|
invoice_custom_section_codes?: string[];
|
|
9621
9628
|
};
|
|
9622
9629
|
WalletCreateInput: {
|
|
9623
|
-
wallet
|
|
9630
|
+
wallet: {
|
|
9624
9631
|
/**
|
|
9625
9632
|
* @description The name of the wallet.
|
|
9626
9633
|
* @example Prepaid
|
|
@@ -9632,7 +9639,7 @@ export interface components {
|
|
|
9632
9639
|
*/
|
|
9633
9640
|
code?: string | null;
|
|
9634
9641
|
/**
|
|
9635
|
-
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
|
|
9642
|
+
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
|
|
9636
9643
|
* @example 50
|
|
9637
9644
|
*/
|
|
9638
9645
|
priority?: number;
|
|
@@ -9701,6 +9708,11 @@ export interface components {
|
|
|
9701
9708
|
* @example Tokens for models 'high-fidelity-boost'
|
|
9702
9709
|
*/
|
|
9703
9710
|
transaction_name?: string | null;
|
|
9711
|
+
/**
|
|
9712
|
+
* @description The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
|
|
9713
|
+
* @example 50
|
|
9714
|
+
*/
|
|
9715
|
+
transaction_priority?: number;
|
|
9704
9716
|
/**
|
|
9705
9717
|
* @description The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
|
|
9706
9718
|
* @example PO-123
|
|
@@ -9858,7 +9870,7 @@ export interface components {
|
|
|
9858
9870
|
*/
|
|
9859
9871
|
code?: string | null;
|
|
9860
9872
|
/**
|
|
9861
|
-
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
|
|
9873
|
+
* @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
|
|
9862
9874
|
* @example 50
|
|
9863
9875
|
*/
|
|
9864
9876
|
priority?: number;
|
|
@@ -9873,6 +9885,16 @@ export interface components {
|
|
|
9873
9885
|
* @example false
|
|
9874
9886
|
*/
|
|
9875
9887
|
invoice_requires_successful_payment?: boolean;
|
|
9888
|
+
/**
|
|
9889
|
+
* @description Minimum amount of cents that can be top-up with a single paid transaction.
|
|
9890
|
+
* @example 100
|
|
9891
|
+
*/
|
|
9892
|
+
paid_top_up_min_amount_cents?: number | null;
|
|
9893
|
+
/**
|
|
9894
|
+
* @description Maximum amount of cents that can be top-up with a single paid transaction.
|
|
9895
|
+
* @example 1000
|
|
9896
|
+
*/
|
|
9897
|
+
paid_top_up_max_amount_cents?: number | null;
|
|
9876
9898
|
/**
|
|
9877
9899
|
* @description The code of the billing entity associated with the wallet.
|
|
9878
9900
|
* @example default
|
|
@@ -10666,18 +10688,18 @@ export interface components {
|
|
|
10666
10688
|
* @description Code of the payment provider associated with this payment method.
|
|
10667
10689
|
* @example stripe_prod
|
|
10668
10690
|
*/
|
|
10669
|
-
payment_provider_code
|
|
10691
|
+
payment_provider_code: string | null;
|
|
10670
10692
|
/**
|
|
10671
10693
|
* @description Human-readable name of the payment provider.
|
|
10672
10694
|
* @example Stripe
|
|
10673
10695
|
*/
|
|
10674
|
-
payment_provider_name
|
|
10696
|
+
payment_provider_name: string | null;
|
|
10675
10697
|
/**
|
|
10676
|
-
* @description The type of the payment provider.
|
|
10698
|
+
* @description The type of the payment provider. It is `null` when the payment method is no longer attached to a payment provider.
|
|
10677
10699
|
* @example stripe
|
|
10678
|
-
* @enum {string}
|
|
10700
|
+
* @enum {string|null}
|
|
10679
10701
|
*/
|
|
10680
|
-
payment_provider_type: "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
|
|
10702
|
+
payment_provider_type: null | "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
|
|
10681
10703
|
/**
|
|
10682
10704
|
* @description Unique identifier of the payment method within the payment provider.
|
|
10683
10705
|
* @example pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ
|
|
@@ -10721,12 +10743,12 @@ export interface components {
|
|
|
10721
10743
|
code: string;
|
|
10722
10744
|
/**
|
|
10723
10745
|
* Format: date-time
|
|
10724
|
-
* @description
|
|
10746
|
+
* @description The date and time at which the event occurred, in ISO 8601 format with millisecond precision and expressed in Coordinated Universal Time (UTC). When no timestamp is sent on the event, it is set to the time of event reception.
|
|
10725
10747
|
* @example 2022-04-29T08:59:51.123Z
|
|
10726
10748
|
*/
|
|
10727
10749
|
timestamp: string;
|
|
10728
10750
|
/**
|
|
10729
|
-
* @description The precise total amount that was sent in the event payload. This
|
|
10751
|
+
* @description The precise total amount that was sent in the event payload. This field is used by the `dynamic` pricing model.
|
|
10730
10752
|
* @example 1234.56
|
|
10731
10753
|
*/
|
|
10732
10754
|
precise_total_amount_cents?: string | null;
|
|
@@ -10752,7 +10774,7 @@ export interface components {
|
|
|
10752
10774
|
*/
|
|
10753
10775
|
lago_subscription_id: string | null;
|
|
10754
10776
|
/**
|
|
10755
|
-
* @description The unique identifier of the subscription within your application
|
|
10777
|
+
* @description The unique identifier of the subscription within your application, as sent on the event. It is the value Lago uses to attach the event to a subscription.
|
|
10756
10778
|
* @example sub_1234567890
|
|
10757
10779
|
*/
|
|
10758
10780
|
external_subscription_id: string;
|
|
@@ -10791,7 +10813,7 @@ export interface components {
|
|
|
10791
10813
|
/**
|
|
10792
10814
|
* @description This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
|
|
10793
10815
|
* If this timestamp is not provided, the API will automatically set it to the time of event reception.
|
|
10794
|
-
* You can also provide
|
|
10816
|
+
* You can also provide milliseconds precision by appending decimals to the timestamp.
|
|
10795
10817
|
* @example 1651240791.123
|
|
10796
10818
|
*/
|
|
10797
10819
|
timestamp?: number | string;
|
|
@@ -10856,6 +10878,11 @@ export interface components {
|
|
|
10856
10878
|
* @example sub_1234567890
|
|
10857
10879
|
*/
|
|
10858
10880
|
external_subscription_id: string;
|
|
10881
|
+
/**
|
|
10882
|
+
* @description The precise total amount in cents with precision used by the `dynamic` pricing model to compute the estimated usage amount. Defaults to `0` when omitted.
|
|
10883
|
+
* @example 1234.56
|
|
10884
|
+
*/
|
|
10885
|
+
precise_total_amount_cents?: string | null;
|
|
10859
10886
|
/** @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
10887
|
properties?: {
|
|
10861
10888
|
/**
|
|
@@ -12574,6 +12601,16 @@ export interface components {
|
|
|
12574
12601
|
* @example LAG-1234-001-002
|
|
12575
12602
|
*/
|
|
12576
12603
|
number: string;
|
|
12604
|
+
/**
|
|
12605
|
+
* @description The PDF file of the payment receipt. It is `null` while no PDF has been generated.
|
|
12606
|
+
* @example https://getlago.com/payment_receipt/file
|
|
12607
|
+
*/
|
|
12608
|
+
file_url?: string | null;
|
|
12609
|
+
/**
|
|
12610
|
+
* @description The e-invoicing XML file of the payment receipt. It is `null` while no XML file has been generated.
|
|
12611
|
+
* @example https://getlago.com/payment_receipt/xml
|
|
12612
|
+
*/
|
|
12613
|
+
xml_url?: string | null;
|
|
12577
12614
|
payment: components["schemas"]["PaymentObject"];
|
|
12578
12615
|
};
|
|
12579
12616
|
PaymentReceiptsPaginated: {
|
|
@@ -12592,10 +12629,10 @@ export interface components {
|
|
|
12592
12629
|
external_customer_id: string;
|
|
12593
12630
|
/**
|
|
12594
12631
|
* Format: email
|
|
12595
|
-
* @description The
|
|
12632
|
+
* @description The email address used for sending dunning notifications. When omitted, the customer's own email address is used.
|
|
12596
12633
|
* @example dinesh@piedpiper.test
|
|
12597
12634
|
*/
|
|
12598
|
-
email
|
|
12635
|
+
email?: string;
|
|
12599
12636
|
/** @description A list of Lago IDs for the customer's overdue invoices to start the dunning process */
|
|
12600
12637
|
lago_invoice_ids: string[];
|
|
12601
12638
|
/** @description Optional payment method to use for processing the payment request. */
|
|
@@ -12654,7 +12691,7 @@ export interface components {
|
|
|
12654
12691
|
* @description Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
|
|
12655
12692
|
* @example Minimum Commitment (C1)
|
|
12656
12693
|
*/
|
|
12657
|
-
invoice_display_name?: string;
|
|
12694
|
+
invoice_display_name?: string | null;
|
|
12658
12695
|
/**
|
|
12659
12696
|
* @description The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly` or `weekly`.
|
|
12660
12697
|
* @example monthly
|
|
@@ -13053,7 +13090,7 @@ export interface components {
|
|
|
13053
13090
|
* @description Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
|
|
13054
13091
|
* @example Setup fee
|
|
13055
13092
|
*/
|
|
13056
|
-
invoice_display_name: string;
|
|
13093
|
+
invoice_display_name: string | null;
|
|
13057
13094
|
/**
|
|
13058
13095
|
* @description Unique code used to identify the add-on.
|
|
13059
13096
|
* @example setup_fee
|
|
@@ -13108,6 +13145,23 @@ export interface components {
|
|
|
13108
13145
|
/** @description List of taxes applied to the fixed charge. */
|
|
13109
13146
|
taxes?: components["schemas"]["TaxObject"][];
|
|
13110
13147
|
};
|
|
13148
|
+
ApplicableUsageThreshold: {
|
|
13149
|
+
/**
|
|
13150
|
+
* @description The display name of the usage threshold.
|
|
13151
|
+
* @example Threshold 1
|
|
13152
|
+
*/
|
|
13153
|
+
threshold_display_name: string | null;
|
|
13154
|
+
/**
|
|
13155
|
+
* @description The amount to reach to trigger a `progressive_billing` invoice.
|
|
13156
|
+
* @example 10000
|
|
13157
|
+
*/
|
|
13158
|
+
amount_cents: number;
|
|
13159
|
+
/**
|
|
13160
|
+
* @description This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
|
|
13161
|
+
* @example true
|
|
13162
|
+
*/
|
|
13163
|
+
recurring: boolean;
|
|
13164
|
+
};
|
|
13111
13165
|
PlanEntitlementPrivilegeObject: components["schemas"]["FeaturePrivilegeObject"] & {
|
|
13112
13166
|
/**
|
|
13113
13167
|
* @description Value assigned to this privilege in the entitlement. Type depends on the privilege's value_type.
|
|
@@ -13190,7 +13244,7 @@ export interface components {
|
|
|
13190
13244
|
* @description Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.
|
|
13191
13245
|
* @example Startup plan
|
|
13192
13246
|
*/
|
|
13193
|
-
invoice_display_name?: string;
|
|
13247
|
+
invoice_display_name?: string | null;
|
|
13194
13248
|
/**
|
|
13195
13249
|
* Format: date-time
|
|
13196
13250
|
* @description The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created.
|
|
@@ -13210,9 +13264,9 @@ export interface components {
|
|
|
13210
13264
|
interval: "weekly" | "monthly" | "quarterly" | "semiannual" | "yearly";
|
|
13211
13265
|
/**
|
|
13212
13266
|
* @description The description on the plan.
|
|
13213
|
-
* @example
|
|
13267
|
+
* @example Plan for early stage startups.
|
|
13214
13268
|
*/
|
|
13215
|
-
description?: string;
|
|
13269
|
+
description?: string | null;
|
|
13216
13270
|
/**
|
|
13217
13271
|
* @description The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.
|
|
13218
13272
|
* @example 10000
|
|
@@ -13227,7 +13281,7 @@ export interface components {
|
|
|
13227
13281
|
* @description The duration in days during which the base cost of the plan is offered for free.
|
|
13228
13282
|
* @example 5
|
|
13229
13283
|
*/
|
|
13230
|
-
trial_period?: number;
|
|
13284
|
+
trial_period?: number | null;
|
|
13231
13285
|
/**
|
|
13232
13286
|
* @description This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.
|
|
13233
13287
|
* @example true
|
|
@@ -13243,6 +13297,17 @@ export interface components {
|
|
|
13243
13297
|
* @example null
|
|
13244
13298
|
*/
|
|
13245
13299
|
bill_fixed_charges_monthly?: boolean | null;
|
|
13300
|
+
/**
|
|
13301
|
+
* Format: uuid
|
|
13302
|
+
* @description Unique identifier of the parent plan, created by Lago. It is set on plans that override a parent plan for a single subscription, and `null` on standard plans.
|
|
13303
|
+
* @example null
|
|
13304
|
+
*/
|
|
13305
|
+
parent_id?: string | null;
|
|
13306
|
+
/**
|
|
13307
|
+
* @description This field is set to `true` when the plan is scheduled for deletion but still attached to subscriptions that have to be billed first.
|
|
13308
|
+
* @example false
|
|
13309
|
+
*/
|
|
13310
|
+
pending_deletion?: boolean;
|
|
13246
13311
|
minimum_commitment?: components["schemas"]["MinimumCommitmentObject"];
|
|
13247
13312
|
/**
|
|
13248
13313
|
* @description Additional usage-based charges for this plan.
|
|
@@ -13495,6 +13560,8 @@ export interface components {
|
|
|
13495
13560
|
taxes?: components["schemas"]["TaxObject"][];
|
|
13496
13561
|
/** @description List of usage thresholds applied to the plan. */
|
|
13497
13562
|
usage_thresholds?: components["schemas"]["UsageThresholdObject"][];
|
|
13563
|
+
/** @description List of usage thresholds that actually apply to the plan. For an overriding plan these are inherited from its parent plan; for a standard plan they match `usage_thresholds`. */
|
|
13564
|
+
applicable_usage_thresholds?: components["schemas"]["ApplicableUsageThreshold"][];
|
|
13498
13565
|
/** @description List of all feature entitlements and their privileges available for this plan. */
|
|
13499
13566
|
entitlements?: components["schemas"]["PlanEntitlement"][];
|
|
13500
13567
|
metadata?: components["schemas"]["MetadataObject"];
|
|
@@ -13807,6 +13874,7 @@ export interface components {
|
|
|
13807
13874
|
* "amount": "500"
|
|
13808
13875
|
* },
|
|
13809
13876
|
* "units": 1,
|
|
13877
|
+
* "apply_units_immediately": false,
|
|
13810
13878
|
* "tax_codes": [
|
|
13811
13879
|
* "french_standard_vat"
|
|
13812
13880
|
* ]
|
|
@@ -13909,6 +13977,12 @@ export interface components {
|
|
|
13909
13977
|
properties?: components["schemas"]["FixedChargeProperties"];
|
|
13910
13978
|
/** @description List of taxes applied to the fixed charge. */
|
|
13911
13979
|
tax_codes?: components["schemas"]["TaxCodes"];
|
|
13980
|
+
/**
|
|
13981
|
+
* @description When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.
|
|
13982
|
+
* @default false
|
|
13983
|
+
* @example false
|
|
13984
|
+
*/
|
|
13985
|
+
apply_units_immediately: boolean;
|
|
13912
13986
|
}[];
|
|
13913
13987
|
/** @description List of usage thresholds to apply to the plan. */
|
|
13914
13988
|
usage_thresholds?: components["schemas"]["UsageThresholdInput"][];
|
|
@@ -15053,23 +15127,6 @@ export interface components {
|
|
|
15053
15127
|
activation_rules?: components["schemas"]["SubscriptionActivationRuleInput"][];
|
|
15054
15128
|
};
|
|
15055
15129
|
};
|
|
15056
|
-
ApplicableUsageThreshold: {
|
|
15057
|
-
/**
|
|
15058
|
-
* @description The display name of the usage threshold.
|
|
15059
|
-
* @example Threshold 1
|
|
15060
|
-
*/
|
|
15061
|
-
threshold_display_name: string | null;
|
|
15062
|
-
/**
|
|
15063
|
-
* @description The amount to reach to trigger a `progressive_billing` invoice.
|
|
15064
|
-
* @example 10000
|
|
15065
|
-
*/
|
|
15066
|
-
amount_cents: number;
|
|
15067
|
-
/**
|
|
15068
|
-
* @description This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount.
|
|
15069
|
-
* @example true
|
|
15070
|
-
*/
|
|
15071
|
-
recurring: boolean;
|
|
15072
|
-
};
|
|
15073
15130
|
SubscriptionObjectExtended: components["schemas"]["SubscriptionObject"] & {
|
|
15074
15131
|
plan?: components["schemas"]["PlanObject"];
|
|
15075
15132
|
/** @description List of usage thresholds applicable to this subscription. */
|
|
@@ -15348,15 +15405,15 @@ export interface components {
|
|
|
15348
15405
|
};
|
|
15349
15406
|
SubscriptionEntitlementPrivilegeObject: components["schemas"]["FeaturePrivilegeObject"] & {
|
|
15350
15407
|
/**
|
|
15351
|
-
* @description Applicable value
|
|
15408
|
+
* @description Applicable value for this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.
|
|
15352
15409
|
* @example 10
|
|
15353
15410
|
*/
|
|
15354
15411
|
value: number | boolean | string;
|
|
15355
15412
|
/**
|
|
15356
|
-
* @description Value assigned to this privilege in the plan. Type depends on the privilege's value_type.
|
|
15413
|
+
* @description Value assigned to this privilege in the plan. Type depends on the privilege's value_type. Null when the privilege only exists as a subscription override.
|
|
15357
15414
|
* @example 10
|
|
15358
15415
|
*/
|
|
15359
|
-
plan_value: number | boolean | string;
|
|
15416
|
+
plan_value: number | boolean | string | null;
|
|
15360
15417
|
/**
|
|
15361
15418
|
* @description Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.
|
|
15362
15419
|
* @example 10
|
|
@@ -15439,9 +15496,6 @@ export interface components {
|
|
|
15439
15496
|
SubscriptionEntitlements: {
|
|
15440
15497
|
entitlements: components["schemas"]["SubscriptionEntitlementObject"][];
|
|
15441
15498
|
};
|
|
15442
|
-
SubscriptionEntitlement: {
|
|
15443
|
-
entitlement: components["schemas"]["SubscriptionEntitlementObject"];
|
|
15444
|
-
};
|
|
15445
15499
|
SubscriptionChargeOverride: {
|
|
15446
15500
|
charge: components["schemas"]["ChargeOverridableInput"];
|
|
15447
15501
|
};
|
|
@@ -15519,6 +15573,17 @@ export interface components {
|
|
|
15519
15573
|
* @example 5.0
|
|
15520
15574
|
*/
|
|
15521
15575
|
voided_credits?: string | null;
|
|
15576
|
+
/**
|
|
15577
|
+
* Format: uuid
|
|
15578
|
+
* @description Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount.
|
|
15579
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
15580
|
+
*/
|
|
15581
|
+
voided_transaction_id?: string | null;
|
|
15582
|
+
/**
|
|
15583
|
+
* @description The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
|
|
15584
|
+
* @example 50
|
|
15585
|
+
*/
|
|
15586
|
+
priority?: number;
|
|
15522
15587
|
/**
|
|
15523
15588
|
* @description A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
|
|
15524
15589
|
* @example false
|
|
@@ -15571,6 +15636,11 @@ export interface components {
|
|
|
15571
15636
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
15572
15637
|
*/
|
|
15573
15638
|
lago_wallet_id: string;
|
|
15639
|
+
/**
|
|
15640
|
+
* @description The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one.
|
|
15641
|
+
* @example default
|
|
15642
|
+
*/
|
|
15643
|
+
billing_entity_code?: string;
|
|
15574
15644
|
/**
|
|
15575
15645
|
* Format: uuid
|
|
15576
15646
|
* @description Unique identifier assigned to the invoice associated with this wallet transaction. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
|
|
@@ -15806,7 +15876,7 @@ export interface components {
|
|
|
15806
15876
|
WebhookEndpointObject: {
|
|
15807
15877
|
/**
|
|
15808
15878
|
* Format: uuid
|
|
15809
|
-
* @description Unique identifier assigned to the
|
|
15879
|
+
* @description Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
|
|
15810
15880
|
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
15811
15881
|
*/
|
|
15812
15882
|
lago_id: string;
|
|
@@ -15859,11 +15929,12 @@ export interface components {
|
|
|
15859
15929
|
*/
|
|
15860
15930
|
webhook_url: string;
|
|
15861
15931
|
/**
|
|
15862
|
-
* @description The
|
|
15932
|
+
* @description The algorithm used to sign the webhook payload. Defaults to `jwt` when no value is passed.
|
|
15933
|
+
* @default jwt
|
|
15863
15934
|
* @example hmac
|
|
15864
15935
|
* @enum {string|null}
|
|
15865
15936
|
*/
|
|
15866
|
-
signature_algo
|
|
15937
|
+
signature_algo: "jwt" | "hmac" | null;
|
|
15867
15938
|
/**
|
|
15868
15939
|
* @description The name of the webhook.
|
|
15869
15940
|
* @example EC2-production
|
|
@@ -15888,9 +15959,9 @@ export interface components {
|
|
|
15888
15959
|
* @description The URL of the webhook endpoint.
|
|
15889
15960
|
* @example https://foo.bar
|
|
15890
15961
|
*/
|
|
15891
|
-
webhook_url
|
|
15962
|
+
webhook_url?: string;
|
|
15892
15963
|
/**
|
|
15893
|
-
* @description The
|
|
15964
|
+
* @description The algorithm used to sign the webhook payload. When the field is omitted, the current value is kept.
|
|
15894
15965
|
* @example hmac
|
|
15895
15966
|
* @enum {string|null}
|
|
15896
15967
|
*/
|
|
@@ -16412,6 +16483,9 @@ export interface components {
|
|
|
16412
16483
|
[key: string]: unknown;
|
|
16413
16484
|
};
|
|
16414
16485
|
};
|
|
16486
|
+
SubscriptionEntitlement: {
|
|
16487
|
+
entitlement: components["schemas"]["SubscriptionEntitlementObject"];
|
|
16488
|
+
};
|
|
16415
16489
|
};
|
|
16416
16490
|
responses: {
|
|
16417
16491
|
/** @description Unauthorized error */
|
|
@@ -16478,12 +16552,16 @@ export interface components {
|
|
|
16478
16552
|
external_customer_id: string;
|
|
16479
16553
|
/** @description External subscription ID */
|
|
16480
16554
|
external_subscription_id: string;
|
|
16555
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
16556
|
+
billing_entity_code: string;
|
|
16481
16557
|
/** @description Show data only for given number of months. */
|
|
16482
16558
|
months: number;
|
|
16483
16559
|
/** @description Filter by the invoice purchase order number. The match is exact but case-insensitive. */
|
|
16484
16560
|
purchase_order_number: string;
|
|
16485
16561
|
/** @description The customer external unique identifier (provided by your own application) */
|
|
16486
16562
|
external_customer_id_path: string;
|
|
16563
|
+
/** @description Filter the results by currency, expressed as an ISO 4217 code. */
|
|
16564
|
+
currency: string;
|
|
16487
16565
|
/** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
|
|
16488
16566
|
payment_status: "pending" | "failed" | "succeeded";
|
|
16489
16567
|
/** @description A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. */
|
|
@@ -16494,8 +16572,6 @@ export interface components {
|
|
|
16494
16572
|
lago_order_form_id: string;
|
|
16495
16573
|
/** @description Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the order's record within the Lago system. */
|
|
16496
16574
|
lago_order_id: string;
|
|
16497
|
-
/** @description Filter the results by currency, expressed as an ISO 4217 code. */
|
|
16498
|
-
currency: string;
|
|
16499
16575
|
/** @description Code of the existing plan. */
|
|
16500
16576
|
plan_code: string;
|
|
16501
16577
|
/** @description Code of the existing charge. */
|
|
@@ -16873,8 +16949,10 @@ export interface operations {
|
|
|
16873
16949
|
"http_statuses[]"?: (("succeeded" | "failed") | number)[];
|
|
16874
16950
|
/** @description Filter results by API version */
|
|
16875
16951
|
api_version?: string;
|
|
16876
|
-
/** @description Filter results by the path of the request */
|
|
16877
|
-
request_paths?: string;
|
|
16952
|
+
/** @description Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly. */
|
|
16953
|
+
"request_paths[]"?: string[];
|
|
16954
|
+
/** @description Filter results by the client that issued the request, as reported by its user agent. */
|
|
16955
|
+
"clients[]"?: string[];
|
|
16878
16956
|
};
|
|
16879
16957
|
header?: never;
|
|
16880
16958
|
path?: never;
|
|
@@ -16926,6 +17004,8 @@ export interface operations {
|
|
|
16926
17004
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
16927
17005
|
/** @description The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. */
|
|
16928
17006
|
external_customer_id?: string;
|
|
17007
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
17008
|
+
billing_entity_code?: components["parameters"]["billing_entity_code"];
|
|
16929
17009
|
/** @description Show data only for given number of months. */
|
|
16930
17010
|
months?: components["parameters"]["months"];
|
|
16931
17011
|
};
|
|
@@ -16953,6 +17033,8 @@ export interface operations {
|
|
|
16953
17033
|
query?: {
|
|
16954
17034
|
/** @description The currency of revenue analytics. Format must be ISO 4217. */
|
|
16955
17035
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
17036
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
17037
|
+
billing_entity_code?: components["parameters"]["billing_entity_code"];
|
|
16956
17038
|
/** @description Show data only for given number of months. */
|
|
16957
17039
|
months?: components["parameters"]["months"];
|
|
16958
17040
|
};
|
|
@@ -16979,6 +17061,8 @@ export interface operations {
|
|
|
16979
17061
|
query?: {
|
|
16980
17062
|
/** @description The currency of invoiced usage analytics. Format must be ISO 4217. */
|
|
16981
17063
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
17064
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
17065
|
+
billing_entity_code?: components["parameters"]["billing_entity_code"];
|
|
16982
17066
|
/** @description Show data only for given number of months. */
|
|
16983
17067
|
months?: components["parameters"]["months"];
|
|
16984
17068
|
};
|
|
@@ -17003,16 +17087,10 @@ export interface operations {
|
|
|
17003
17087
|
findAllMrrs: {
|
|
17004
17088
|
parameters: {
|
|
17005
17089
|
query?: {
|
|
17006
|
-
/**
|
|
17007
|
-
* @description Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:
|
|
17008
|
-
*
|
|
17009
|
-
* - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.
|
|
17010
|
-
* - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).
|
|
17011
|
-
* - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
|
|
17012
|
-
* - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).
|
|
17013
|
-
* - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
|
|
17014
|
-
*/
|
|
17090
|
+
/** @description The currency of MRR analytics. Format must be ISO 4217. */
|
|
17015
17091
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
17092
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
17093
|
+
billing_entity_code?: components["parameters"]["billing_entity_code"];
|
|
17016
17094
|
/** @description Show data only for given number of months. */
|
|
17017
17095
|
months?: components["parameters"]["months"];
|
|
17018
17096
|
};
|
|
@@ -17042,6 +17120,8 @@ export interface operations {
|
|
|
17042
17120
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
17043
17121
|
/** @description The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. */
|
|
17044
17122
|
external_customer_id?: string;
|
|
17123
|
+
/** @description Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole organization. */
|
|
17124
|
+
billing_entity_code?: components["parameters"]["billing_entity_code"];
|
|
17045
17125
|
/** @description Show data only for given number of months. */
|
|
17046
17126
|
months?: components["parameters"]["months"];
|
|
17047
17127
|
};
|
|
@@ -17067,7 +17147,7 @@ export interface operations {
|
|
|
17067
17147
|
findAllUsages: {
|
|
17068
17148
|
parameters: {
|
|
17069
17149
|
query?: {
|
|
17070
|
-
/** @description The time granularity of usage analytics. Possible values are 'daily', 'weekly'
|
|
17150
|
+
/** @description The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'. */
|
|
17071
17151
|
time_granularity?: "daily" | "weekly" | "monthly";
|
|
17072
17152
|
/** @description The currency of usage analytics. Format must be ISO 4217. */
|
|
17073
17153
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
@@ -18304,6 +18384,8 @@ export interface operations {
|
|
|
18304
18384
|
page?: components["parameters"]["page"];
|
|
18305
18385
|
/** @description Number of records per page. */
|
|
18306
18386
|
per_page?: components["parameters"]["per_page"];
|
|
18387
|
+
/** @description Filter the results by currency, expressed as an ISO 4217 code. */
|
|
18388
|
+
currency?: components["parameters"]["currency"];
|
|
18307
18389
|
/** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
|
|
18308
18390
|
payment_status?: components["parameters"]["payment_status"];
|
|
18309
18391
|
/** @description Filter payment requests by billing entity codes. */
|
|
@@ -18409,6 +18491,8 @@ export interface operations {
|
|
|
18409
18491
|
page?: components["parameters"]["page"];
|
|
18410
18492
|
/** @description Number of records per page. */
|
|
18411
18493
|
per_page?: components["parameters"]["per_page"];
|
|
18494
|
+
/** @description Filter the results by currency, expressed as an ISO 4217 code. */
|
|
18495
|
+
currency?: components["parameters"]["currency"];
|
|
18412
18496
|
/** @description Filter wallets by billing entity codes. */
|
|
18413
18497
|
"billing_entity_codes[]"?: string[];
|
|
18414
18498
|
};
|
|
@@ -18681,7 +18765,12 @@ export interface operations {
|
|
|
18681
18765
|
};
|
|
18682
18766
|
getCustomerWalletAlerts: {
|
|
18683
18767
|
parameters: {
|
|
18684
|
-
query?:
|
|
18768
|
+
query?: {
|
|
18769
|
+
/** @description Page number. */
|
|
18770
|
+
page?: components["parameters"]["page"];
|
|
18771
|
+
/** @description Number of records per page. */
|
|
18772
|
+
per_page?: components["parameters"]["per_page"];
|
|
18773
|
+
};
|
|
18685
18774
|
header?: never;
|
|
18686
18775
|
path: {
|
|
18687
18776
|
/** @description The customer external unique identifier (provided by your own application) */
|
|
@@ -19060,7 +19149,7 @@ export interface operations {
|
|
|
19060
19149
|
};
|
|
19061
19150
|
requestBody?: never;
|
|
19062
19151
|
responses: {
|
|
19063
|
-
/** @description
|
|
19152
|
+
/** @description Payment method set as default */
|
|
19064
19153
|
200: {
|
|
19065
19154
|
headers: {
|
|
19066
19155
|
[name: string]: unknown;
|
|
@@ -19111,7 +19200,7 @@ export interface operations {
|
|
|
19111
19200
|
external_subscription_id?: components["parameters"]["external_subscription_id"];
|
|
19112
19201
|
/** @description Filter events by its code. */
|
|
19113
19202
|
code?: string;
|
|
19114
|
-
/** @description Requires `external_subscription_id` to be set
|
|
19203
|
+
/** @description Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the subscription started at datetime. */
|
|
19115
19204
|
timestamp_from_started_at?: boolean;
|
|
19116
19205
|
/** @description Filter events by timestamp starting from a specific date. */
|
|
19117
19206
|
timestamp_from?: string;
|
|
@@ -20190,7 +20279,7 @@ export interface operations {
|
|
|
20190
20279
|
query?: never;
|
|
20191
20280
|
header?: never;
|
|
20192
20281
|
path: {
|
|
20193
|
-
/** @description
|
|
20282
|
+
/** @description Unique identifier of the payment receipt. */
|
|
20194
20283
|
lago_id: string;
|
|
20195
20284
|
};
|
|
20196
20285
|
cookie?: never;
|
|
@@ -21738,6 +21827,10 @@ export interface operations {
|
|
|
21738
21827
|
query?: {
|
|
21739
21828
|
/** @description Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`. */
|
|
21740
21829
|
subscription_status?: components["parameters"]["subscription_status"];
|
|
21830
|
+
/** @description Page number. */
|
|
21831
|
+
page?: components["parameters"]["page"];
|
|
21832
|
+
/** @description Number of records per page. */
|
|
21833
|
+
per_page?: components["parameters"]["per_page"];
|
|
21741
21834
|
};
|
|
21742
21835
|
header?: never;
|
|
21743
21836
|
path: {
|
|
@@ -21999,13 +22092,13 @@ export interface operations {
|
|
|
21999
22092
|
};
|
|
22000
22093
|
requestBody?: never;
|
|
22001
22094
|
responses: {
|
|
22002
|
-
/** @description
|
|
22095
|
+
/** @description Remaining subscription entitlements */
|
|
22003
22096
|
200: {
|
|
22004
22097
|
headers: {
|
|
22005
22098
|
[name: string]: unknown;
|
|
22006
22099
|
};
|
|
22007
22100
|
content: {
|
|
22008
|
-
"application/json": components["schemas"]["
|
|
22101
|
+
"application/json": components["schemas"]["SubscriptionEntitlements"];
|
|
22009
22102
|
};
|
|
22010
22103
|
};
|
|
22011
22104
|
401: components["responses"]["Unauthorized"];
|
|
@@ -22031,13 +22124,13 @@ export interface operations {
|
|
|
22031
22124
|
};
|
|
22032
22125
|
requestBody?: never;
|
|
22033
22126
|
responses: {
|
|
22034
|
-
/** @description
|
|
22127
|
+
/** @description Remaining subscription entitlements */
|
|
22035
22128
|
200: {
|
|
22036
22129
|
headers: {
|
|
22037
22130
|
[name: string]: unknown;
|
|
22038
22131
|
};
|
|
22039
22132
|
content: {
|
|
22040
|
-
"application/json": components["schemas"]["
|
|
22133
|
+
"application/json": components["schemas"]["SubscriptionEntitlements"];
|
|
22041
22134
|
};
|
|
22042
22135
|
};
|
|
22043
22136
|
400: components["responses"]["BadRequest"];
|
|
@@ -23005,6 +23098,8 @@ export interface operations {
|
|
|
23005
23098
|
transaction_status?: string;
|
|
23006
23099
|
/** @description The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance). */
|
|
23007
23100
|
transaction_type?: string;
|
|
23101
|
+
/** @description Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`. */
|
|
23102
|
+
"metadata[key]"?: string;
|
|
23008
23103
|
};
|
|
23009
23104
|
header?: never;
|
|
23010
23105
|
path: {
|
|
@@ -24016,6 +24111,12 @@ export interface operations {
|
|
|
24016
24111
|
webhook_type: "credit_note.refund_failure";
|
|
24017
24112
|
/** @enum {string} */
|
|
24018
24113
|
object_type: "credit_note_payment_provider_refund_error";
|
|
24114
|
+
/**
|
|
24115
|
+
* Format: uuid
|
|
24116
|
+
* @description Unique identifier of the organization, created by Lago.
|
|
24117
|
+
* @example 1a901a90-1a90-1a90-1a90-1a901a901a90
|
|
24118
|
+
*/
|
|
24119
|
+
organization_id: string;
|
|
24019
24120
|
credit_note_payment_provider_refund_error: components["schemas"]["CreditNotePaymentProviderRefundError"];
|
|
24020
24121
|
};
|
|
24021
24122
|
};
|