lago-javascript-client 1.9.0 → 1.11.0

package/esm/openapi/client.d.ts

@@ -297,6 +297,19 @@ export interface AppliedCouponsPaginated {
     applied_coupons: AppliedCouponObjectExtended[];
     meta: PaginationMeta;
 }
+export interface AppliedUsageThresholdObject {
+    /**
+     * The amount of usage in cents that has been accumulated over the lifetime of the subscription.
+     * @example 2000
+     */
+    lifetime_usage_amount_cents: number;
+    /**
+     * The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     */
+    created_at: string;
+    usage_threshold: UsageThresholdObject;
+}
 export interface BaseAppliedTax {
     /**
      * Unique identifier of the applied tax, created by Lago.
@@ -1090,17 +1103,17 @@ export interface CreditObject {
          */
         lago_item_id: string;
         /**
-         * The type of credit applied. Possible values are `coupon` or `credit_note`.
+         * The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice).
          * @example "coupon"
          */
-        type: "coupon" | "credit_note";
+        type: "coupon" | "credit_note" | "invoice";
         /**
-         * The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number.
+         * The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number.
          * @example "startup_deal"
          */
         code: string;
         /**
-         * The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note.
+         * The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number.
          * @example "Startup Deal"
          */
         name: string;
@@ -1409,7 +1422,7 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `[card]`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
      * @example ["card","sepa_debit"]
      */
     provider_payment_methods?: string[] | null;
@@ -1424,10 +1437,10 @@ export interface IntegrationCustomer {
     lago_id?: string;
     /**
      * The integration type used for accounting and tax syncs.
-     * Accepted values: `netsuite`.
+     * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite";
+    type?: "netsuite" | "anrok";
     /**
      * Unique code used to identify an integration connection.
      * @example "netsuite-eu-1"
@@ -1657,6 +1670,14 @@ export interface CustomerCreateInput {
          * @example 30
          */
         net_payment_term?: number | null;
+        /**
+         * Specifies how invoices with a zero total amount should be handled:
+         * - `inherit`: (Default) Follows the organization-level configuration.
+         * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+         * - `skip`: Invoices with a total amount of zero are not finalized.
+         * @example "inherit"
+         */
+        finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
         /** 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. */
         billing_configuration?: CustomerBillingConfiguration;
         /** 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. */
@@ -1670,10 +1691,10 @@ export interface CustomerCreateInput {
             id?: string;
             /**
              * The integration type used for accounting and tax syncs.
-             * Accepted values: `netsuite`.
+             * Accepted values: `netsuite, anrok, xero`.
              * @example "netsuite"
              */
-            integration_type?: "netsuite";
+            integration_type?: "netsuite" | "anrok" | "xero";
             /**
              * Unique code used to identify an integration connection.
              * @example "netsuite-eu-1"
@@ -1751,7 +1772,7 @@ export interface CustomerMetadata {
      */
     created_at: string;
 }
-export interface CustomerObject {
+export type CustomerObject = {
     /**
      * 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
      * @format uuid
@@ -1864,13 +1885,22 @@ export interface CustomerObject {
      * @example "2022-04-29T08:59:51Z"
      */
     updated_at?: string;
+    /**
+     * Specifies how invoices with a zero total amount should be handled:
+     * - `inherit`: (Default) Follows the organization-level configuration.
+     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+     * - `skip`: Invoices with a total amount of zero are not finalized.
+     * @example "inherit"
+     */
+    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
     /** 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. */
     billing_configuration?: CustomerBillingConfiguration;
     /** 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. */
     shipping_address?: Address;
-    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
-}
+} & {
+    integration_customers?: IntegrationCustomer[];
+};
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -2115,6 +2145,16 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes, with precision.
+     * @example "1.0001"
+     */
+    precise_amount?: string;
+    /**
+     * The cost of this specific fee, including any applicable taxes, with precision.
+     * @example "1.0212"
+     */
+    precise_total_amount?: string;
     /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
@@ -2122,6 +2162,11 @@ export interface FeeObject {
      * @example 20
      */
     taxes_amount_cents: number;
+    /**
+     * The cost of the tax associated with this specific fee, with precision.
+     * @example "0.20123"
+     */
+    taxes_precise_amount?: string;
     /**
      * The tax rate associated with this specific fee.
      * @example 20
@@ -2626,7 +2671,7 @@ export interface InvoiceMetadataObject {
      */
     created_at?: string;
 }
-export interface InvoiceObject {
+export type InvoiceObject = {
     /**
      * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
@@ -2672,18 +2717,19 @@ export interface InvoiceObject {
      */
     net_payment_term?: number;
     /**
-     * The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`.
+     * The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.
      * @example "subscription"
      */
-    invoice_type: "subscription" | "add_on" | "credit" | "one_off";
+    invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided";
+    status: "draft" | "finalized" | "voided" | "failed";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -2714,7 +2760,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`.
      * - Version 2: is equal to the `fees_amount_cents`.
-     * - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
+     * - Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
      * @example 100
      */
     sub_total_excluding_taxes_amount_cents: number;
@@ -2728,7 +2774,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the `total_amount_cents`.
      * - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`.
-     * - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
+     * - Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
      * @example 120
      */
     sub_total_including_taxes_amount_cents: number;
@@ -2737,6 +2783,11 @@ export interface InvoiceObject {
      * @example 0
      */
     prepaid_credit_amount_cents: number;
+    /**
+     * The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices.
+     * @example 0
+     */
+    progressive_billing_credit_amount_cents: number;
     /**
      * The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.
      * @example 100
@@ -2750,15 +2801,35 @@ export interface InvoiceObject {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+} & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
-}
+    applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
+};
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
     subscriptions?: SubscriptionObject[];
+    error_details?: {
+        /**
+         * Unique identifier assigned to the error_detail within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the error's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string | null;
+        /**
+         * Code that specifies part of the application / connection, where the error originally happened
+         * @example "tax_error"
+         */
+        error_code: string;
+        /**
+         * Key value list of more elaborated error detail, where by the key of error_code an external service error details are stored
+         * @example {"tax_error":"taxDateTooFarInFuture"}
+         */
+        details: object;
+    }[];
 };
 export interface InvoiceOneOffCreateInput {
     invoice: {
@@ -2960,6 +3031,11 @@ export interface OrganizationObject {
     billing_configuration: OrganizationBillingConfiguration;
     /** List of default organization taxes */
     taxes?: TaxObject[];
+    /**
+     * Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+     * @example false
+     */
+    finalize_zero_amount_invoice?: boolean;
 }
 export interface OrganizationUpdateInput {
     organization: {
@@ -3047,6 +3123,11 @@ export interface OrganizationUpdateInput {
         email_settings?: ("invoice.finalized" | "credit_note.created")[];
         /** The custom billing settings for your organization. */
         billing_configuration?: OrganizationBillingConfiguration;
+        /**
+         * Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+         * @example false
+         */
+        finalize_zero_amount_invoice?: boolean;
     };
 }
 export interface OverdueBalanceObject {
@@ -3221,6 +3302,8 @@ export interface PlanCreateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 /** Based plan overrides. */
@@ -3292,6 +3375,8 @@ export interface PlanOverridesObject {
          */
         tax_codes?: string[];
     }[];
+    /** List of usage thresholds applied to the subscription. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlanUpdateInput {
     plan: {
@@ -3419,6 +3504,8 @@ export interface PlanUpdateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 export interface PlanObject {
@@ -3499,6 +3586,8 @@ export interface PlanObject {
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
     taxes?: TaxObject[];
+    /** List of usage thresholds applied to the plan. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlansPaginated {
     plans: PlanObject[];
@@ -3793,6 +3882,64 @@ export interface TaxUpdateInput {
 }
 /** @example "America/Los_Angeles" */
 export type Timezone = "UTC" | "Africa/Algiers" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Monrovia" | "Africa/Nairobi" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/Chihuahua" | "America/Denver" | "America/Godthab" | "America/Guatemala" | "America/Guyana" | "America/Halifax" | "America/Indiana/Indianapolis" | "America/Juneau" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Mazatlan" | "America/Mexico_City" | "America/Monterrey" | "America/Montevideo" | "America/New_York" | "America/Phoenix" | "America/Puerto_Rico" | "America/Regina" | "America/Santiago" | "America/Sao_Paulo" | "America/St_Johns" | "America/Tijuana" | "Asia/Almaty" | "Asia/Baghdad" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Magadan" | "Asia/Muscat" | "Asia/Novosibirsk" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Atlantic/South_Georgia" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Darwin" | "Australia/Hobart" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Madrid" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "GMT+12" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Majuro" | "Pacific/Midway" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Port_Moresby" | "Pacific/Tongatapu";
+export interface UsageThresholdInput {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    id?: string | null;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example true
+     */
+    recurring: boolean;
+}
+export interface UsageThresholdObject {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example true
+     */
+    recurring: boolean;
+    /**
+     * The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    updated_at: string;
+}
 export interface Wallet {
     wallet: WalletObject;
 }
@@ -4440,7 +4587,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.9.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5349,6 +5496,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *
@@ -5420,6 +5577,102 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateOrganization: (data: OrganizationUpdateInput, params?: RequestParams) => Promise<HttpResponse<Organization, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
     };
+    paymentRequests: {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data: {
+            payment_request: {
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                customer_external_id?: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /** A list of Lago IDs for the customer's overdue invoices to start the dunning process */
+                lago_invoice_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_request: {
+                /**
+                 * Unique identifier of the payment request, created by Lago.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_id: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /**
+                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+                 * @example 100
+                 */
+                amount_cents: number;
+                /** The currency of the payment request. */
+                amount_currency: Currency;
+                /**
+                 * The status of the payment associated with the payment request. It can have one of the following values:
+                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+                 * - `succeeded`: the payment of the payment request has been successfully processed.
+                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+                 * @example "succeeded"
+                 */
+                payment_status: "pending" | "succeeded" | "failed";
+                /**
+                 * The date and time when the payment request 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 payment request was initially created.
+                 * @format date-time
+                 * @example "2022-04-29T08:59:51Z"
+                 */
+                created_at: string;
+                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+                customer: any;
+                invoices: any[];
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_requests: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.9.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1088,6 +1088,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/retry`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *
@@ -1156,6 +1172,43 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    paymentRequests = {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/package.json

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

package/script/openapi/client.d.ts

@@ -297,6 +297,19 @@ export interface AppliedCouponsPaginated {
     applied_coupons: AppliedCouponObjectExtended[];
     meta: PaginationMeta;
 }
+export interface AppliedUsageThresholdObject {
+    /**
+     * The amount of usage in cents that has been accumulated over the lifetime of the subscription.
+     * @example 2000
+     */
+    lifetime_usage_amount_cents: number;
+    /**
+     * The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     */
+    created_at: string;
+    usage_threshold: UsageThresholdObject;
+}
 export interface BaseAppliedTax {
     /**
      * Unique identifier of the applied tax, created by Lago.
@@ -1090,17 +1103,17 @@ export interface CreditObject {
          */
         lago_item_id: string;
         /**
-         * The type of credit applied. Possible values are `coupon` or `credit_note`.
+         * The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice).
          * @example "coupon"
          */
-        type: "coupon" | "credit_note";
+        type: "coupon" | "credit_note" | "invoice";
         /**
-         * The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number.
+         * The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number.
          * @example "startup_deal"
          */
         code: string;
         /**
-         * The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note.
+         * The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number.
          * @example "Startup Deal"
          */
         name: string;
@@ -1409,7 +1422,7 @@ export interface CustomerBillingConfiguration {
      */
     document_locale?: string;
     /**
-     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `[card]`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
+     * Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit` and `link`. Note that when `link` is selected, `card` should also be provided in the array.
      * @example ["card","sepa_debit"]
      */
     provider_payment_methods?: string[] | null;
@@ -1424,10 +1437,10 @@ export interface IntegrationCustomer {
     lago_id?: string;
     /**
      * The integration type used for accounting and tax syncs.
-     * Accepted values: `netsuite`.
+     * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite";
+    type?: "netsuite" | "anrok";
     /**
      * Unique code used to identify an integration connection.
      * @example "netsuite-eu-1"
@@ -1657,6 +1670,14 @@ export interface CustomerCreateInput {
          * @example 30
          */
         net_payment_term?: number | null;
+        /**
+         * Specifies how invoices with a zero total amount should be handled:
+         * - `inherit`: (Default) Follows the organization-level configuration.
+         * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+         * - `skip`: Invoices with a total amount of zero are not finalized.
+         * @example "inherit"
+         */
+        finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
         /** 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. */
         billing_configuration?: CustomerBillingConfiguration;
         /** 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. */
@@ -1670,10 +1691,10 @@ export interface CustomerCreateInput {
             id?: string;
             /**
              * The integration type used for accounting and tax syncs.
-             * Accepted values: `netsuite`.
+             * Accepted values: `netsuite, anrok, xero`.
              * @example "netsuite"
              */
-            integration_type?: "netsuite";
+            integration_type?: "netsuite" | "anrok" | "xero";
             /**
              * Unique code used to identify an integration connection.
              * @example "netsuite-eu-1"
@@ -1751,7 +1772,7 @@ export interface CustomerMetadata {
      */
     created_at: string;
 }
-export interface CustomerObject {
+export type CustomerObject = {
     /**
      * 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
      * @format uuid
@@ -1864,13 +1885,22 @@ export interface CustomerObject {
      * @example "2022-04-29T08:59:51Z"
      */
     updated_at?: string;
+    /**
+     * Specifies how invoices with a zero total amount should be handled:
+     * - `inherit`: (Default) Follows the organization-level configuration.
+     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+     * - `skip`: Invoices with a total amount of zero are not finalized.
+     * @example "inherit"
+     */
+    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
     /** 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. */
     billing_configuration?: CustomerBillingConfiguration;
     /** 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. */
     shipping_address?: Address;
-    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
-}
+} & {
+    integration_customers?: IntegrationCustomer[];
+};
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -2115,6 +2145,16 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes, with precision.
+     * @example "1.0001"
+     */
+    precise_amount?: string;
+    /**
+     * The cost of this specific fee, including any applicable taxes, with precision.
+     * @example "1.0212"
+     */
+    precise_total_amount?: string;
     /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
@@ -2122,6 +2162,11 @@ export interface FeeObject {
      * @example 20
      */
     taxes_amount_cents: number;
+    /**
+     * The cost of the tax associated with this specific fee, with precision.
+     * @example "0.20123"
+     */
+    taxes_precise_amount?: string;
     /**
      * The tax rate associated with this specific fee.
      * @example 20
@@ -2626,7 +2671,7 @@ export interface InvoiceMetadataObject {
      */
     created_at?: string;
 }
-export interface InvoiceObject {
+export type InvoiceObject = {
     /**
      * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
@@ -2672,18 +2717,19 @@ export interface InvoiceObject {
      */
     net_payment_term?: number;
     /**
-     * The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`.
+     * The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`.
      * @example "subscription"
      */
-    invoice_type: "subscription" | "add_on" | "credit" | "one_off";
+    invoice_type: "subscription" | "add_on" | "credit" | "one_off" | "progressive_billing";
     /**
      * The status of the invoice. It indicates the current state of the invoice and can have two possible values:
      * - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
      * - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
      * - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
+     * - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.
      * @example "finalized"
      */
-    status: "draft" | "finalized" | "voided";
+    status: "draft" | "finalized" | "voided" | "failed";
     /**
      * The status of the payment associated with the invoice. It can have one of the following values:
      * - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
@@ -2714,7 +2760,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`.
      * - Version 2: is equal to the `fees_amount_cents`.
-     * - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
+     * - Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents`
      * @example 100
      */
     sub_total_excluding_taxes_amount_cents: number;
@@ -2728,7 +2774,7 @@ export interface InvoiceObject {
      * This field depends on the version number. Here are the definitions based on the version:
      * - Version 1: is equal to the `total_amount_cents`.
      * - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`.
-     * - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
+     * - Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents`
      * @example 120
      */
     sub_total_including_taxes_amount_cents: number;
@@ -2737,6 +2783,11 @@ export interface InvoiceObject {
      * @example 0
      */
     prepaid_credit_amount_cents: number;
+    /**
+     * The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices.
+     * @example 0
+     */
+    progressive_billing_credit_amount_cents: number;
     /**
      * The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.
      * @example 100
@@ -2750,15 +2801,35 @@ export interface InvoiceObject {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+} & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
-}
+    applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
+};
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
     subscriptions?: SubscriptionObject[];
+    error_details?: {
+        /**
+         * Unique identifier assigned to the error_detail within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the error's record within the Lago system.
+         * @format uuid
+         * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+         */
+        lago_id: string | null;
+        /**
+         * Code that specifies part of the application / connection, where the error originally happened
+         * @example "tax_error"
+         */
+        error_code: string;
+        /**
+         * Key value list of more elaborated error detail, where by the key of error_code an external service error details are stored
+         * @example {"tax_error":"taxDateTooFarInFuture"}
+         */
+        details: object;
+    }[];
 };
 export interface InvoiceOneOffCreateInput {
     invoice: {
@@ -2960,6 +3031,11 @@ export interface OrganizationObject {
     billing_configuration: OrganizationBillingConfiguration;
     /** List of default organization taxes */
     taxes?: TaxObject[];
+    /**
+     * Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+     * @example false
+     */
+    finalize_zero_amount_invoice?: boolean;
 }
 export interface OrganizationUpdateInput {
     organization: {
@@ -3047,6 +3123,11 @@ export interface OrganizationUpdateInput {
         email_settings?: ("invoice.finalized" | "credit_note.created")[];
         /** The custom billing settings for your organization. */
         billing_configuration?: OrganizationBillingConfiguration;
+        /**
+         * Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+         * @example false
+         */
+        finalize_zero_amount_invoice?: boolean;
     };
 }
 export interface OverdueBalanceObject {
@@ -3221,6 +3302,8 @@ export interface PlanCreateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 /** Based plan overrides. */
@@ -3292,6 +3375,8 @@ export interface PlanOverridesObject {
          */
         tax_codes?: string[];
     }[];
+    /** List of usage thresholds applied to the subscription. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlanUpdateInput {
     plan: {
@@ -3419,6 +3504,8 @@ export interface PlanUpdateInput {
              */
             tax_codes?: string[];
         }[];
+        /** List of usage thresholds to apply to the plan. */
+        usage_thresholds?: UsageThresholdInput[];
     };
 }
 export interface PlanObject {
@@ -3499,6 +3586,8 @@ export interface PlanObject {
     charges?: ChargeObject[];
     /** All taxes applied to the plan. */
     taxes?: TaxObject[];
+    /** List of usage thresholds applied to the plan. */
+    usage_thresholds?: UsageThresholdObject[];
 }
 export interface PlansPaginated {
     plans: PlanObject[];
@@ -3793,6 +3882,64 @@ export interface TaxUpdateInput {
 }
 /** @example "America/Los_Angeles" */
 export type Timezone = "UTC" | "Africa/Algiers" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Monrovia" | "Africa/Nairobi" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/Chihuahua" | "America/Denver" | "America/Godthab" | "America/Guatemala" | "America/Guyana" | "America/Halifax" | "America/Indiana/Indianapolis" | "America/Juneau" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Mazatlan" | "America/Mexico_City" | "America/Monterrey" | "America/Montevideo" | "America/New_York" | "America/Phoenix" | "America/Puerto_Rico" | "America/Regina" | "America/Santiago" | "America/Sao_Paulo" | "America/St_Johns" | "America/Tijuana" | "Asia/Almaty" | "Asia/Baghdad" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Magadan" | "Asia/Muscat" | "Asia/Novosibirsk" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Atlantic/South_Georgia" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Darwin" | "Australia/Hobart" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Madrid" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "GMT+12" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Majuro" | "Pacific/Midway" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Port_Moresby" | "Pacific/Tongatapu";
+export interface UsageThresholdInput {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    id?: string | null;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example true
+     */
+    recurring: boolean;
+}
+export interface UsageThresholdObject {
+    /**
+     * Unique identifier of the usage threshold created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * The display name of the usage threshold.
+     * @example "Threshold 1"
+     */
+    threshold_display_name?: string | null;
+    /**
+     * The amount to reach to trigger a `progressive_billing` invoice.
+     * @example 10000
+     */
+    amount_cents: number;
+    /**
+     * 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.
+     * @example true
+     */
+    recurring: boolean;
+    /**
+     * The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    created_at: string;
+    /**
+     * The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.
+     * @format date-time
+     * @example "2023-06-27T19:43:42Z"
+     */
+    updated_at: string;
+}
 export interface Wallet {
     wallet: WalletObject;
 }
@@ -4440,7 +4587,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.9.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5349,6 +5496,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *
@@ -5420,6 +5577,102 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateOrganization: (data: OrganizationUpdateInput, params?: RequestParams) => Promise<HttpResponse<Organization, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
     };
+    paymentRequests: {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data: {
+            payment_request: {
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                customer_external_id?: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /** A list of Lago IDs for the customer's overdue invoices to start the dunning process */
+                lago_invoice_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_request: {
+                /**
+                 * Unique identifier of the payment request, created by Lago.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_id: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /**
+                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+                 * @example 100
+                 */
+                amount_cents: number;
+                /** The currency of the payment request. */
+                amount_currency: Currency;
+                /**
+                 * The status of the payment associated with the payment request. It can have one of the following values:
+                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+                 * - `succeeded`: the payment of the payment request has been successfully processed.
+                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+                 * @example "succeeded"
+                 */
+                payment_status: "pending" | "succeeded" | "failed";
+                /**
+                 * The date and time when the payment request 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 payment request was initially created.
+                 * @format date-time
+                 * @example "2022-04-29T08:59:51Z"
+                 */
+                created_at: string;
+                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+                customer: any;
+                invoices: any[];
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_requests: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.9.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1092,6 +1092,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrying to generate a failed invoice.
+         *
+         * @tags invoices
+         * @name RetryInvoice
+         * @summary Retry generation of a failed invoice
+         * @request POST:/invoices/{lago_id}/retry
+         * @secure
+         */
+        retryInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/retry`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint generates a checkout link for a specific invoice.
          *
@@ -1160,6 +1176,43 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    paymentRequests = {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.