lago-javascript-client 0.41.0-beta → 0.44.0-beta
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.js +0 -34
- package/package.json +1 -1
- package/script/openapi/client.js +0 -34
- package/types/openapi/client.d.ts +117 -72
package/esm/openapi/client.js
CHANGED
|
@@ -1213,40 +1213,6 @@ export class Api extends HttpClient {
|
|
|
1213
1213
|
format: "json",
|
|
1214
1214
|
...params,
|
|
1215
1215
|
}),
|
|
1216
|
-
/**
|
|
1217
|
-
* @description Apply an existing tax to a customer
|
|
1218
|
-
*
|
|
1219
|
-
* @tags customers
|
|
1220
|
-
* @name ApplyTax
|
|
1221
|
-
* @summary Apply a tax
|
|
1222
|
-
* @request POST:/customers/{external_customer_id}/applied_taxes
|
|
1223
|
-
* @secure
|
|
1224
|
-
*/
|
|
1225
|
-
applyTax: (externalCustomerId, data, params = {}) => this.request({
|
|
1226
|
-
path: `/customers/${externalCustomerId}/applied_taxes`,
|
|
1227
|
-
method: "POST",
|
|
1228
|
-
body: data,
|
|
1229
|
-
secure: true,
|
|
1230
|
-
type: ContentType.Json,
|
|
1231
|
-
format: "json",
|
|
1232
|
-
...params,
|
|
1233
|
-
}),
|
|
1234
|
-
/**
|
|
1235
|
-
* @description Delete customer's appplied tax
|
|
1236
|
-
*
|
|
1237
|
-
* @tags customers
|
|
1238
|
-
* @name DeleteAppliedTax
|
|
1239
|
-
* @summary Delete customer's appplied tax
|
|
1240
|
-
* @request DELETE:/customers/{external_customer_id}/applied_taxes/{tax_code}
|
|
1241
|
-
* @secure
|
|
1242
|
-
*/
|
|
1243
|
-
deleteAppliedTax: (externalCustomerId, taxCode, params = {}) => this.request({
|
|
1244
|
-
path: `/customers/${externalCustomerId}/applied_taxes/${taxCode}`,
|
|
1245
|
-
method: "DELETE",
|
|
1246
|
-
secure: true,
|
|
1247
|
-
format: "json",
|
|
1248
|
-
...params,
|
|
1249
|
-
}),
|
|
1250
1216
|
/**
|
|
1251
1217
|
* @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
|
|
1252
1218
|
*
|
package/package.json
CHANGED
package/script/openapi/client.js
CHANGED
|
@@ -1217,40 +1217,6 @@ class Api extends HttpClient {
|
|
|
1217
1217
|
format: "json",
|
|
1218
1218
|
...params,
|
|
1219
1219
|
}),
|
|
1220
|
-
/**
|
|
1221
|
-
* @description Apply an existing tax to a customer
|
|
1222
|
-
*
|
|
1223
|
-
* @tags customers
|
|
1224
|
-
* @name ApplyTax
|
|
1225
|
-
* @summary Apply a tax
|
|
1226
|
-
* @request POST:/customers/{external_customer_id}/applied_taxes
|
|
1227
|
-
* @secure
|
|
1228
|
-
*/
|
|
1229
|
-
applyTax: (externalCustomerId, data, params = {}) => this.request({
|
|
1230
|
-
path: `/customers/${externalCustomerId}/applied_taxes`,
|
|
1231
|
-
method: "POST",
|
|
1232
|
-
body: data,
|
|
1233
|
-
secure: true,
|
|
1234
|
-
type: ContentType.Json,
|
|
1235
|
-
format: "json",
|
|
1236
|
-
...params,
|
|
1237
|
-
}),
|
|
1238
|
-
/**
|
|
1239
|
-
* @description Delete customer's appplied tax
|
|
1240
|
-
*
|
|
1241
|
-
* @tags customers
|
|
1242
|
-
* @name DeleteAppliedTax
|
|
1243
|
-
* @summary Delete customer's appplied tax
|
|
1244
|
-
* @request DELETE:/customers/{external_customer_id}/applied_taxes/{tax_code}
|
|
1245
|
-
* @secure
|
|
1246
|
-
*/
|
|
1247
|
-
deleteAppliedTax: (externalCustomerId, taxCode, params = {}) => this.request({
|
|
1248
|
-
path: `/customers/${externalCustomerId}/applied_taxes/${taxCode}`,
|
|
1249
|
-
method: "DELETE",
|
|
1250
|
-
secure: true,
|
|
1251
|
-
format: "json",
|
|
1252
|
-
...params,
|
|
1253
|
-
}),
|
|
1254
1220
|
/**
|
|
1255
1221
|
* @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
|
|
1256
1222
|
*
|
|
@@ -21,6 +21,11 @@ export interface AddOnBaseInput {
|
|
|
21
21
|
* @example "Implementation fee for new customers."
|
|
22
22
|
*/
|
|
23
23
|
description?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* List of unique code used to identify the taxes.
|
|
26
|
+
* @example ["french_standard_vat"]
|
|
27
|
+
*/
|
|
28
|
+
tax_codes?: string[];
|
|
24
29
|
}
|
|
25
30
|
export interface AddOnCreateInput {
|
|
26
31
|
add_on: AddOnBaseInput;
|
|
@@ -60,6 +65,8 @@ export interface AddOnObject {
|
|
|
60
65
|
* @example "2022-04-29T08:59:51Z"
|
|
61
66
|
*/
|
|
62
67
|
created_at: string;
|
|
68
|
+
/** All taxes applied to the add-on. */
|
|
69
|
+
taxes?: TaxObject[];
|
|
63
70
|
}
|
|
64
71
|
export interface AddOn {
|
|
65
72
|
add_on: AddOnObject;
|
|
@@ -587,6 +594,8 @@ export interface ChargeObject {
|
|
|
587
594
|
properties?: ChargeProperties;
|
|
588
595
|
/** All charge information, sorted by groups. */
|
|
589
596
|
group_properties?: GroupPropertiesObject[];
|
|
597
|
+
/** All taxes applied to the charge. */
|
|
598
|
+
taxes?: TaxObject[];
|
|
590
599
|
}
|
|
591
600
|
export interface ChargeProperties {
|
|
592
601
|
/** Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. */
|
|
@@ -1154,7 +1163,7 @@ export interface CreditObject {
|
|
|
1154
1163
|
* Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation
|
|
1155
1164
|
* @example false
|
|
1156
1165
|
*/
|
|
1157
|
-
|
|
1166
|
+
before_taxes: boolean;
|
|
1158
1167
|
/** The item attached to the credit. */
|
|
1159
1168
|
item: {
|
|
1160
1169
|
/**
|
|
@@ -1552,54 +1561,6 @@ export declare enum Currency {
|
|
|
1552
1561
|
export interface Customer {
|
|
1553
1562
|
customer: CustomerObjectExtended;
|
|
1554
1563
|
}
|
|
1555
|
-
export interface CustomerAppliedTax {
|
|
1556
|
-
applied_tax: CustomerAppliedTaxObject;
|
|
1557
|
-
}
|
|
1558
|
-
export interface CustomerAppliedTaxInput {
|
|
1559
|
-
applied_tax: {
|
|
1560
|
-
/**
|
|
1561
|
-
* Unique code used to identify the tax.
|
|
1562
|
-
* @example "vat_fr"
|
|
1563
|
-
*/
|
|
1564
|
-
tax_code: string;
|
|
1565
|
-
};
|
|
1566
|
-
}
|
|
1567
|
-
export interface CustomerAppliedTaxObject {
|
|
1568
|
-
/**
|
|
1569
|
-
* Unique identifier of the applied tax, created by Lago.
|
|
1570
|
-
* @format uuid
|
|
1571
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1572
|
-
*/
|
|
1573
|
-
lago_id: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* Unique identifier of the customer, created by Lago.
|
|
1576
|
-
* @format uuid
|
|
1577
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1578
|
-
*/
|
|
1579
|
-
lago_customer_id: string;
|
|
1580
|
-
/**
|
|
1581
|
-
* Unique identifier of the tax, created by Lago.
|
|
1582
|
-
* @format uuid
|
|
1583
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1584
|
-
*/
|
|
1585
|
-
lago_tax_id: string;
|
|
1586
|
-
/**
|
|
1587
|
-
* The code of the tax.
|
|
1588
|
-
* @example "example_code"
|
|
1589
|
-
*/
|
|
1590
|
-
tax_code: string;
|
|
1591
|
-
/**
|
|
1592
|
-
* The customer external unique identifier (provided by your own application)
|
|
1593
|
-
* @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
|
|
1594
|
-
*/
|
|
1595
|
-
external_customer_id: string;
|
|
1596
|
-
/**
|
|
1597
|
-
* The date and time when the applied tax 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 applied tax was initially created.
|
|
1598
|
-
* @format date-time
|
|
1599
|
-
* @example "2022-09-14T16:35:31Z"
|
|
1600
|
-
*/
|
|
1601
|
-
created_at: string;
|
|
1602
|
-
}
|
|
1603
1564
|
/** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
|
|
1604
1565
|
export interface CustomerBillingConfiguration {
|
|
1605
1566
|
/**
|
|
@@ -1784,6 +1745,11 @@ export interface CustomerCreateInput {
|
|
|
1784
1745
|
* @example "CA"
|
|
1785
1746
|
*/
|
|
1786
1747
|
state?: string | null;
|
|
1748
|
+
/**
|
|
1749
|
+
* List of unique code used to identify the taxes.
|
|
1750
|
+
* @example ["french_standard_vat"]
|
|
1751
|
+
*/
|
|
1752
|
+
tax_codes?: string[];
|
|
1787
1753
|
/**
|
|
1788
1754
|
* The tax identification number of the customer
|
|
1789
1755
|
* @example "EU123456789"
|
|
@@ -1801,6 +1767,11 @@ export interface CustomerCreateInput {
|
|
|
1801
1767
|
* @example "91364"
|
|
1802
1768
|
*/
|
|
1803
1769
|
zipcode?: string | null;
|
|
1770
|
+
/**
|
|
1771
|
+
* The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
|
|
1772
|
+
* @example 30
|
|
1773
|
+
*/
|
|
1774
|
+
net_payment_term?: number | null;
|
|
1804
1775
|
/** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
|
|
1805
1776
|
billing_configuration?: CustomerBillingConfiguration;
|
|
1806
1777
|
/** 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 */
|
|
@@ -1955,12 +1926,23 @@ export interface CustomerObject {
|
|
|
1955
1926
|
* @example "91364"
|
|
1956
1927
|
*/
|
|
1957
1928
|
zipcode?: string | null;
|
|
1929
|
+
/**
|
|
1930
|
+
* The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
|
|
1931
|
+
* @example 30
|
|
1932
|
+
*/
|
|
1933
|
+
net_payment_term?: number | null;
|
|
1958
1934
|
/**
|
|
1959
1935
|
* 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
|
|
1960
1936
|
* @format date-time
|
|
1961
1937
|
* @example "2022-04-29T08:59:51Z"
|
|
1962
1938
|
*/
|
|
1963
1939
|
created_at: string;
|
|
1940
|
+
/**
|
|
1941
|
+
* The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated
|
|
1942
|
+
* @format date-time
|
|
1943
|
+
* @example "2022-04-29T08:59:51Z"
|
|
1944
|
+
*/
|
|
1945
|
+
updated_at?: string;
|
|
1964
1946
|
/** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
|
|
1965
1947
|
billing_configuration?: CustomerBillingConfiguration;
|
|
1966
1948
|
metadata?: CustomerMetadata[];
|
|
@@ -2420,6 +2402,11 @@ export type InvoiceAppliedTaxObject = BaseAppliedTax & {
|
|
|
2420
2402
|
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
2421
2403
|
*/
|
|
2422
2404
|
lago_invoice_id?: string;
|
|
2405
|
+
/**
|
|
2406
|
+
* Fees total amount on which the tax is applied
|
|
2407
|
+
* @example 20000
|
|
2408
|
+
*/
|
|
2409
|
+
fees_amount_cents?: number;
|
|
2423
2410
|
};
|
|
2424
2411
|
export interface InvoiceMetadataObject {
|
|
2425
2412
|
/**
|
|
@@ -2468,6 +2455,17 @@ export interface InvoiceObject {
|
|
|
2468
2455
|
* @example "2022-04-30"
|
|
2469
2456
|
*/
|
|
2470
2457
|
issuing_date: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* The payment due date for the invoice, specified in the ISO 8601 date format.
|
|
2460
|
+
* @format date
|
|
2461
|
+
* @example "2022-04-30"
|
|
2462
|
+
*/
|
|
2463
|
+
payment_due_date?: string;
|
|
2464
|
+
/**
|
|
2465
|
+
* The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
|
|
2466
|
+
* @example 30
|
|
2467
|
+
*/
|
|
2468
|
+
net_payment_term?: number;
|
|
2471
2469
|
/**
|
|
2472
2470
|
* The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`.
|
|
2473
2471
|
* @example "subscription"
|
|
@@ -2587,6 +2585,11 @@ export interface InvoiceOneOffCreateInput {
|
|
|
2587
2585
|
* @example "The description of the fee line item in the invoice. By default, the description of the add-on is used."
|
|
2588
2586
|
*/
|
|
2589
2587
|
description?: string | null;
|
|
2588
|
+
/**
|
|
2589
|
+
* List of unique code used to identify the taxes.
|
|
2590
|
+
* @example ["french_standard_vat"]
|
|
2591
|
+
*/
|
|
2592
|
+
tax_codes?: string[];
|
|
2590
2593
|
}[];
|
|
2591
2594
|
};
|
|
2592
2595
|
}
|
|
@@ -2713,6 +2716,11 @@ export interface OrganizationObject {
|
|
|
2713
2716
|
* @example null
|
|
2714
2717
|
*/
|
|
2715
2718
|
legal_number?: string | null;
|
|
2719
|
+
/**
|
|
2720
|
+
* The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
|
|
2721
|
+
* @example 30
|
|
2722
|
+
*/
|
|
2723
|
+
net_payment_term?: number;
|
|
2716
2724
|
/**
|
|
2717
2725
|
* The tax identification number of your organization.
|
|
2718
2726
|
* @example "US123456789"
|
|
@@ -2775,6 +2783,11 @@ export interface OrganizationUpdateInput {
|
|
|
2775
2783
|
* @example null
|
|
2776
2784
|
*/
|
|
2777
2785
|
legal_number?: string | null;
|
|
2786
|
+
/**
|
|
2787
|
+
* The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
|
|
2788
|
+
* @example 30
|
|
2789
|
+
*/
|
|
2790
|
+
net_payment_term?: number;
|
|
2778
2791
|
/**
|
|
2779
2792
|
* The tax identification number of your organization.
|
|
2780
2793
|
* @example "US123456789"
|
|
@@ -2865,9 +2878,14 @@ export interface PlanCreateInput {
|
|
|
2865
2878
|
* @example null
|
|
2866
2879
|
*/
|
|
2867
2880
|
bill_charges_monthly?: boolean | null;
|
|
2881
|
+
/**
|
|
2882
|
+
* List of unique code used to identify the taxes.
|
|
2883
|
+
* @example ["french_standard_vat"]
|
|
2884
|
+
*/
|
|
2885
|
+
tax_codes?: string[];
|
|
2868
2886
|
/**
|
|
2869
2887
|
* Additional usage-based charges for this plan.
|
|
2870
|
-
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
2888
|
+
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
2871
2889
|
*/
|
|
2872
2890
|
charges?: {
|
|
2873
2891
|
/**
|
|
@@ -2917,6 +2935,11 @@ export interface PlanCreateInput {
|
|
|
2917
2935
|
/** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
|
|
2918
2936
|
values: ChargeProperties;
|
|
2919
2937
|
}[];
|
|
2938
|
+
/**
|
|
2939
|
+
* List of unique code used to identify the taxes.
|
|
2940
|
+
* @example ["french_standard_vat"]
|
|
2941
|
+
*/
|
|
2942
|
+
tax_codes?: string[];
|
|
2920
2943
|
}[];
|
|
2921
2944
|
};
|
|
2922
2945
|
}
|
|
@@ -2964,9 +2987,14 @@ export interface PlanUpdateInput {
|
|
|
2964
2987
|
* @example null
|
|
2965
2988
|
*/
|
|
2966
2989
|
bill_charges_monthly?: boolean | null;
|
|
2990
|
+
/**
|
|
2991
|
+
* List of unique code used to identify the taxes.
|
|
2992
|
+
* @example ["french_standard_vat"]
|
|
2993
|
+
*/
|
|
2994
|
+
tax_codes?: string[];
|
|
2967
2995
|
/**
|
|
2968
2996
|
* Additional usage-based charges for this plan.
|
|
2969
|
-
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
2997
|
+
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
2970
2998
|
*/
|
|
2971
2999
|
charges?: {
|
|
2972
3000
|
/**
|
|
@@ -3022,6 +3050,11 @@ export interface PlanUpdateInput {
|
|
|
3022
3050
|
/** List of all thresholds utilized for calculating a charge, scoped by groups used as dimensions for a single charge. */
|
|
3023
3051
|
values: ChargeProperties;
|
|
3024
3052
|
}[];
|
|
3053
|
+
/**
|
|
3054
|
+
* List of unique code used to identify the taxes.
|
|
3055
|
+
* @example ["french_standard_vat"]
|
|
3056
|
+
*/
|
|
3057
|
+
tax_codes?: string[];
|
|
3025
3058
|
}[];
|
|
3026
3059
|
};
|
|
3027
3060
|
}
|
|
@@ -3095,6 +3128,8 @@ export interface PlanObject {
|
|
|
3095
3128
|
* @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
3096
3129
|
*/
|
|
3097
3130
|
charges?: ChargeObject[];
|
|
3131
|
+
/** All taxes applied to the plan. */
|
|
3132
|
+
taxes?: TaxObject[];
|
|
3098
3133
|
}
|
|
3099
3134
|
export interface PlansPaginated {
|
|
3100
3135
|
plans: PlanObject[];
|
|
@@ -3322,10 +3357,25 @@ export interface TaxObject {
|
|
|
3322
3357
|
*/
|
|
3323
3358
|
applied_to_organization: boolean;
|
|
3324
3359
|
/**
|
|
3325
|
-
* Number of
|
|
3360
|
+
* Number of add-ons this tax is applied to.
|
|
3361
|
+
* @example 0
|
|
3362
|
+
*/
|
|
3363
|
+
add_ons_count?: number;
|
|
3364
|
+
/**
|
|
3365
|
+
* Number of charges this tax is applied to.
|
|
3366
|
+
* @example 0
|
|
3367
|
+
*/
|
|
3368
|
+
charges_count?: number;
|
|
3369
|
+
/**
|
|
3370
|
+
* Number of customers this tax is applied to (directly or via the organization's default).
|
|
3326
3371
|
* @example 0
|
|
3327
3372
|
*/
|
|
3328
3373
|
customers_count: number;
|
|
3374
|
+
/**
|
|
3375
|
+
* Number of plans this tax is applied to.
|
|
3376
|
+
* @example 0
|
|
3377
|
+
*/
|
|
3378
|
+
plans_count?: number;
|
|
3329
3379
|
/**
|
|
3330
3380
|
* Creation date of the tax.
|
|
3331
3381
|
* @format date-time
|
|
@@ -4171,26 +4221,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4171
4221
|
* @secure
|
|
4172
4222
|
*/
|
|
4173
4223
|
deleteAppliedCoupon: (externalCustomerId: string, appliedCouponId: string, params?: RequestParams) => Promise<HttpResponse<AppliedCoupon, ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
4174
|
-
/**
|
|
4175
|
-
* @description Apply an existing tax to a customer
|
|
4176
|
-
*
|
|
4177
|
-
* @tags customers
|
|
4178
|
-
* @name ApplyTax
|
|
4179
|
-
* @summary Apply a tax
|
|
4180
|
-
* @request POST:/customers/{external_customer_id}/applied_taxes
|
|
4181
|
-
* @secure
|
|
4182
|
-
*/
|
|
4183
|
-
applyTax: (externalCustomerId: string, data: CustomerAppliedTaxInput, params?: RequestParams) => Promise<HttpResponse<CustomerAppliedTax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
|
|
4184
|
-
/**
|
|
4185
|
-
* @description Delete customer's appplied tax
|
|
4186
|
-
*
|
|
4187
|
-
* @tags customers
|
|
4188
|
-
* @name DeleteAppliedTax
|
|
4189
|
-
* @summary Delete customer's appplied tax
|
|
4190
|
-
* @request DELETE:/customers/{external_customer_id}/applied_taxes/{tax_code}
|
|
4191
|
-
* @secure
|
|
4192
|
-
*/
|
|
4193
|
-
deleteAppliedTax: (externalCustomerId: string, taxCode: string, params?: RequestParams) => Promise<HttpResponse<CustomerAppliedTax, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
4194
4224
|
/**
|
|
4195
4225
|
* @description Retrieves an embeddable link for displaying a customer portal. This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
|
|
4196
4226
|
*
|
|
@@ -4852,6 +4882,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4852
4882
|
* @example "https://foo.bar"
|
|
4853
4883
|
*/
|
|
4854
4884
|
webhook_url: string;
|
|
4885
|
+
/**
|
|
4886
|
+
* The signature used for the webhook. If no value is passed,
|
|
4887
|
+
* @example "hmac"
|
|
4888
|
+
*/
|
|
4889
|
+
signature_algo?: "jwt" | "hmac" | null;
|
|
4855
4890
|
};
|
|
4856
4891
|
}, params?: RequestParams) => Promise<HttpResponse<{
|
|
4857
4892
|
webhook_endpoint: {
|
|
@@ -4872,6 +4907,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4872
4907
|
* @example "Prepaid"
|
|
4873
4908
|
*/
|
|
4874
4909
|
webhook_url: string;
|
|
4910
|
+
/**
|
|
4911
|
+
* The signature algo for the webhook.
|
|
4912
|
+
* @example "hmac"
|
|
4913
|
+
*/
|
|
4914
|
+
signature_algo?: "jwt" | "hmac";
|
|
4875
4915
|
/**
|
|
4876
4916
|
* The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
4877
4917
|
* @format date-time
|
|
@@ -4920,6 +4960,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4920
4960
|
* @example "https://foo.bar"
|
|
4921
4961
|
*/
|
|
4922
4962
|
webhook_url: string;
|
|
4963
|
+
/**
|
|
4964
|
+
* The signature used for the webhook. If no value is passed,
|
|
4965
|
+
* @example "hmac"
|
|
4966
|
+
*/
|
|
4967
|
+
signature_algo?: "jwt" | "hmac" | null;
|
|
4923
4968
|
};
|
|
4924
4969
|
}, params?: RequestParams) => Promise<HttpResponse<any, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
|
|
4925
4970
|
/**
|