lago-javascript-client 0.56.0-beta → 1.1.0

package/esm/openapi/client.d.ts

@@ -1816,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1837,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1884,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -2374,6 +2380,66 @@ export interface GroupsPaginated {
     groups: GroupObject[];
     meta: PaginationMeta;
 }
+/** Minimum commitment for this plan. */
+export type MinimumCommitmentInput = {
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of unique code used to identify the taxes.
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+} | null;
+export type MinimumCommitmentObject = {
+    /**
+     * Unique identifier of the minimum commitment, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The unique code representing the plan to be attached to the customer.
+     * @example "premium"
+     */
+    plan_code?: string;
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * 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`.
+     * @example "monthly"
+     */
+    interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+    /**
+     * The date and time when the minimum commitment 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 minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at?: string;
+    /** All taxes applied to the minimum commitment. */
+    taxes?: TaxObject[];
+} | null;
 export interface MrrObject {
     /**
      * Identifies the month to analyze MRR.
@@ -2976,6 +3042,8 @@ export interface PlanCreateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3075,6 +3143,7 @@ export interface PlanOverridesObject {
      * @example 5
      */
     trial_period?: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /** Additional usage-based charges for this plan. */
     charges?: {
         /**
@@ -3172,6 +3241,8 @@ export interface PlanUpdateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3313,6 +3384,7 @@ export interface PlanObject {
      * @example 0
      */
     draft_invoices_count: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
      * @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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3388,7 +3460,7 @@ export interface SubscriptionUpdateInput {
          * @format date-time
          * @example "2022-10-08T00:00:00Z"
          */
-        ending_at?: string;
+        ending_at: string | null;
         /**
          * The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
          * @format date-time
@@ -4076,7 +4148,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4487,11 +4559,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4675,7 +4747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -4926,6 +4998,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -5067,7 +5177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
              * @example ["active","pending"]
              */
-            status?: ("pending" | "canceled" | "terminated" | "active")[];
+            "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific subscription.

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -647,11 +647,11 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -834,7 +834,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -1056,6 +1056,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v0.56.0-beta",
+  "version": "v1.1.0",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/openapi/client.d.ts

@@ -1816,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1837,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1884,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -2374,6 +2380,66 @@ export interface GroupsPaginated {
     groups: GroupObject[];
     meta: PaginationMeta;
 }
+/** Minimum commitment for this plan. */
+export type MinimumCommitmentInput = {
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * List of unique code used to identify the taxes.
+     * @example ["french_standard_vat"]
+     */
+    tax_codes?: string[];
+} | null;
+export type MinimumCommitmentObject = {
+    /**
+     * Unique identifier of the minimum commitment, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The unique code representing the plan to be attached to the customer.
+     * @example "premium"
+     */
+    plan_code?: string;
+    /**
+     * The amount of the minimum commitment in cents.
+     * @example 100000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example "Minimum Commitment (C1)"
+     */
+    invoice_display_name?: string;
+    /**
+     * 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`.
+     * @example "monthly"
+     */
+    interval?: "weekly" | "monthly" | "quarterly" | "yearly";
+    /**
+     * The date and time when the minimum commitment 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 minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
+     * @format date-time
+     * @example "2022-04-29T08:59:51Z"
+     */
+    updated_at?: string;
+    /** All taxes applied to the minimum commitment. */
+    taxes?: TaxObject[];
+} | null;
 export interface MrrObject {
     /**
      * Identifies the month to analyze MRR.
@@ -2976,6 +3042,8 @@ export interface PlanCreateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3075,6 +3143,7 @@ export interface PlanOverridesObject {
      * @example 5
      */
     trial_period?: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /** Additional usage-based charges for this plan. */
     charges?: {
         /**
@@ -3172,6 +3241,8 @@ export interface PlanUpdateInput {
          * @example ["french_standard_vat"]
          */
         tax_codes?: string[];
+        /** Minimum commitment for this plan. */
+        minimum_commitment?: MinimumCommitmentInput;
         /**
          * Additional usage-based charges for this plan.
          * @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3313,6 +3384,7 @@ export interface PlanObject {
      * @example 0
      */
     draft_invoices_count: number;
+    minimum_commitment?: MinimumCommitmentObject;
     /**
      * Additional usage-based charges for this plan.
      * @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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","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,"invoice_display_name":"Setup","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,"invoice_display_name":"Setup","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":[]}]
@@ -3388,7 +3460,7 @@ export interface SubscriptionUpdateInput {
          * @format date-time
          * @example "2022-10-08T00:00:00Z"
          */
-        ending_at?: string;
+        ending_at: string | null;
         /**
          * The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
          * @format date-time
@@ -4076,7 +4148,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4487,11 +4559,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4675,7 +4747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -4926,6 +4998,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -5067,7 +5177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
              * @example ["active","pending"]
              */
-            status?: ("pending" | "canceled" | "terminated" | "active")[];
+            "status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
         }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint retrieves a specific subscription.

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 1.1.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -651,11 +651,11 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -838,7 +838,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -1060,6 +1060,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *