lago-javascript-client 0.43.0-beta → 0.45.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.
@@ -681,7 +681,7 @@ export class HttpClient {
681
681
  }
682
682
  /**
683
683
  * @title Lago API documentation
684
- * @version 0.41.0-beta
684
+ * @version 0.45.0-beta
685
685
  * @license AGPLv3
686
686
  * @baseUrl https://api.getlago.com/api/v1
687
687
  * @externalDocs https://github.com/getlago
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "types": "./types/mod.d.ts",
5
5
  "name": "lago-javascript-client",
6
6
  "sideEffects": false,
7
- "version": "v0.43.0-beta",
7
+ "version": "v0.45.0-beta",
8
8
  "description": "Lago JavaScript API Client",
9
9
  "repository": {
10
10
  "type": "git",
@@ -685,7 +685,7 @@ class HttpClient {
685
685
  exports.HttpClient = HttpClient;
686
686
  /**
687
687
  * @title Lago API documentation
688
- * @version 0.41.0-beta
688
+ * @version 0.45.0-beta
689
689
  * @license AGPLv3
690
690
  * @baseUrl https://api.getlago.com/api/v1
691
691
  * @externalDocs https://github.com/getlago
@@ -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;
@@ -557,8 +564,8 @@ export interface ChargeObject {
557
564
  * @example "2022-09-14T16:35:31Z"
558
565
  */
559
566
  created_at: string;
560
- /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `package`, `percentage` or `volume`. */
561
- charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
567
+ /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. */
568
+ charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
562
569
  /**
563
570
  * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
564
571
  * @example true
@@ -618,6 +625,33 @@ export interface ChargeProperties {
618
625
  */
619
626
  per_unit_amount: string;
620
627
  }[];
628
+ /** Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. */
629
+ graduated_percentage_ranges?: {
630
+ /**
631
+ * Specifies the lower value of a tier for a `graduated_percentage` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values.
632
+ * @example 0
633
+ */
634
+ from_value: number;
635
+ /**
636
+ * Specifies the highest value of a tier for a `graduated_percentage` charge model.
637
+ * - This value must be higher than the from_value of the same tier.
638
+ * - This value must be null for the last tier.
639
+ * @example 10
640
+ */
641
+ to_value: number | null;
642
+ /**
643
+ * The percentage rate that is applied to the amount of each transaction in the tier for a `graduated_percentage` charge model. It is expressed as a decimal value.
644
+ * @format ^[0-9]+.?[0-9]*$
645
+ * @example "1"
646
+ */
647
+ rate: string;
648
+ /**
649
+ * The flat amount for a whole tier, excluding tax, for a `graduated_percentage` charge model. It is expressed as a decimal value.
650
+ * @format ^[0-9]+.?[0-9]*$
651
+ * @example "10"
652
+ */
653
+ flat_amount: string;
654
+ }[];
621
655
  /**
622
656
  * - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.
623
657
  * - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.
@@ -2578,6 +2612,11 @@ export interface InvoiceOneOffCreateInput {
2578
2612
  * @example "The description of the fee line item in the invoice. By default, the description of the add-on is used."
2579
2613
  */
2580
2614
  description?: string | null;
2615
+ /**
2616
+ * List of unique code used to identify the taxes.
2617
+ * @example ["french_standard_vat"]
2618
+ */
2619
+ tax_codes?: string[];
2581
2620
  }[];
2582
2621
  };
2583
2622
  }
@@ -2835,10 +2874,10 @@ export interface PlanCreateInput {
2835
2874
  */
2836
2875
  code?: string;
2837
2876
  /**
2838
- * 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`, `monthly`, or `weekly`.
2877
+ * 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`, `quarterly`, `monthly`, or `weekly`.
2839
2878
  * @example "monthly"
2840
2879
  */
2841
- interval?: "weekly" | "monthly" | "yearly";
2880
+ interval?: "weekly" | "monthly" | "quarterly" | "yearly";
2842
2881
  /**
2843
2882
  * The description on the plan.
2844
2883
  * @example "Plan for early stage startups."
@@ -2883,10 +2922,10 @@ export interface PlanCreateInput {
2883
2922
  */
2884
2923
  billable_metric_id?: string;
2885
2924
  /**
2886
- * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `package`, `percentage` or `volume`.
2925
+ * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
2887
2926
  * @example "standard"
2888
2927
  */
2889
- charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
2928
+ charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
2890
2929
  /**
2891
2930
  * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
2892
2931
  * @example false
@@ -2944,10 +2983,10 @@ export interface PlanUpdateInput {
2944
2983
  */
2945
2984
  code?: string;
2946
2985
  /**
2947
- * 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`, `monthly`, or `weekly`.
2986
+ * 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`, `quarterly`, `monthly`, or `weekly`.
2948
2987
  * @example "monthly"
2949
2988
  */
2950
- interval?: "weekly" | "monthly" | "yearly";
2989
+ interval?: "weekly" | "monthly" | "quarterly" | "yearly";
2951
2990
  /**
2952
2991
  * The description on the plan.
2953
2992
  * @example "Plan for early stage startups."
@@ -2998,10 +3037,10 @@ export interface PlanUpdateInput {
2998
3037
  */
2999
3038
  billable_metric_id?: string;
3000
3039
  /**
3001
- * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `package`, `percentage` or `volume`.
3040
+ * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
3002
3041
  * @example "standard"
3003
3042
  */
3004
- charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
3043
+ charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
3005
3044
  /**
3006
3045
  * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
3007
3046
  * @example false
@@ -3070,10 +3109,10 @@ export interface PlanObject {
3070
3109
  */
3071
3110
  code: string;
3072
3111
  /**
3073
- * 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`, `monthly` or `weekly`.
3112
+ * 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`, `quarterly`, `monthly` or `weekly`.
3074
3113
  * @example "monthly"
3075
3114
  */
3076
- interval: "weekly" | "monthly" | "yearly";
3115
+ interval: "weekly" | "monthly" | "quarterly" | "yearly";
3077
3116
  /**
3078
3117
  * The description on the plan.
3079
3118
  * @example ""
@@ -3344,6 +3383,11 @@ export interface TaxObject {
3344
3383
  * @example true
3345
3384
  */
3346
3385
  applied_to_organization: boolean;
3386
+ /**
3387
+ * Number of add-ons this tax is applied to.
3388
+ * @example 0
3389
+ */
3390
+ add_ons_count?: number;
3347
3391
  /**
3348
3392
  * Number of charges this tax is applied to.
3349
3393
  * @example 0
@@ -3789,7 +3833,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
3789
3833
  }
3790
3834
  /**
3791
3835
  * @title Lago API documentation
3792
- * @version 0.41.0-beta
3836
+ * @version 0.45.0-beta
3793
3837
  * @license AGPLv3
3794
3838
  * @baseUrl https://api.getlago.com/api/v1
3795
3839
  * @externalDocs https://github.com/getlago