lago-javascript-client 1.49.0 → 1.50.0

package/esm/openapi/webhooks.d.ts

@@ -2904,6 +2904,7 @@ export interface paths {
         };
         /**
          * Retrieve webhook public key
+         * @deprecated
          * @description This endpoint is used to retrieve the public key used to verify the webhooks signature
          */
         get: operations["fetchPublicKey"];
@@ -2915,6 +2916,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/webhooks/json_public_key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve webhook public key (JSON)
+         * @description This endpoint is used to retrieve the public key used to verify the webhooks signature, wrapped in a JSON object. Prefer this endpoint over the deprecated GET /webhooks/public_key.
+         */
+        get: operations["fetchJsonPublicKey"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/webhook_endpoints": {
         parameters: {
             query?: never;
@@ -3953,6 +3974,46 @@ export interface webhooks {
         patch?: never;
         trace?: never;
     };
+    subscription_incomplete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * A subscription is incomplete and waiting for payment
+         * @description A payment-gated subscription has been created in the `incomplete` state and is waiting for the gating payment to succeed before it is activated.
+         */
+        post: operations["subscriptionIncomplete"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    subscription_canceled: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * A subscription has been canceled
+         * @description A subscription has been canceled before its activation. For payment-gated subscriptions this happens when the gating payment fails or the activation rule expires, in which case the `cancellation_reason` field is set.
+         */
+        post: operations["subscriptionCanceled"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     subscription_started: {
         parameters: {
             query?: never;
@@ -4515,7 +4576,7 @@ export interface components {
             rate: number;
             /**
              * @deprecated
-             * @description This field is deprecated and will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+             * @description **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
              * @example true
              */
             applied_to_organization: boolean;
@@ -4560,7 +4621,7 @@ export interface components {
             display_name?: string;
             /**
              * @deprecated
-             * @description This field is deprecated and will be removed in a future version. When set to true, it applies the invoice custom section to the organization's default billing entity. To apply or remove an invoice custom section from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+             * @description **Deprecated.** This field will be removed in a future version. When set to true, it applies the invoice custom section to the organization's default billing entity. To apply or remove an invoice custom section from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
              * @example true
              */
             applied_to_organization?: boolean;
@@ -8154,7 +8215,7 @@ export interface components {
             /**
              * Format: uuid
              * @deprecated
-             * @description Unique identifier of the invoice custom section that was applied.
+             * @description **Deprecated.** Unique identifier of the invoice custom section that was applied.
              * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
              */
             invoice_custom_section_id?: string;
@@ -8175,6 +8236,56 @@ export interface components {
              */
             payment_method_id?: string;
         };
+        SubscriptionActivationRuleObject: {
+            /**
+             * Format: uuid
+             * @description Unique identifier assigned to the activation rule within the Lago application. This ID is exclusively created by Lago.
+             * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
+             */
+            lago_id: string;
+            /**
+             * @description The type of the activation rule. Only `payment` is currently supported. A `payment` rule gates the subscription activation on a successful payment of the first invoice.
+             * @example payment
+             * @enum {string}
+             */
+            type: "payment";
+            /**
+             * @description The number of hours the subscription stays in the `incomplete` state waiting for the payment to succeed before it is automatically canceled.
+             * @example 48
+             */
+            timeout_hours: number;
+            /**
+             * @description The evaluation status of the activation rule:
+             *     - `inactive`: the rule has not been evaluated yet.
+             *     - `pending`: the rule is applicable and is waiting to be satisfied (e.g. waiting for the payment).
+             *     - `satisfied`: the rule has been satisfied and no longer blocks activation.
+             *     - `declined`: the rule was applicable but was declined.
+             *     - `failed`: the rule could not be satisfied (e.g. the payment failed).
+             *     - `expired`: the rule was not satisfied before its timeout elapsed.
+             *     - `not_applicable`: the rule did not apply to this subscription.
+             * @example pending
+             * @enum {string}
+             */
+            status: "inactive" | "pending" | "satisfied" | "declined" | "failed" | "expired" | "not_applicable";
+            /**
+             * Format: date-time
+             * @description The date and time when the rule expires, after which an unsatisfied rule causes the subscription to be canceled. Represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null until the rule starts being evaluated.
+             * @example 2022-08-10T00:00:00Z
+             */
+            expires_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The creation date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @example 2022-08-08T00:00:00Z
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description The last update date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+             * @example 2022-08-08T00:00:00Z
+             */
+            updated_at: string;
+        };
         SubscriptionObject: {
             /**
              * Format: uuid
@@ -8232,13 +8343,14 @@ export interface components {
             /**
              * @description The status of the subscription, which can have the following values:
              *     - `active`: the subscription is currently active and applied to the customer.
-             *     - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.
+             *     - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer, when a subscription with a pending status is terminated, or when a payment-gated subscription fails to be paid (or its activation rule expires) before activation. When caused by payment gating, the `cancellation_reason` field is set.
+             *     - `incomplete`: the subscription was created with a payment activation rule and is waiting for the gating payment to succeed before it becomes `active`. It is automatically `canceled` if the payment fails or the activation rule expires.
              *     - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
              *     - `terminated`: the subscription is no longer active.
              * @example active
              * @enum {string}
              */
-            status: "active" | "canceled" | "pending" | "terminated";
+            status: "active" | "canceled" | "incomplete" | "pending" | "terminated";
             /**
              * Format: date-time
              * @description The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.
@@ -8347,6 +8459,23 @@ export interface components {
              * @example true
              */
             consolidate_invoice: boolean;
+            /**
+             * @description The reason a payment-gated subscription was canceled before activation. Null unless the subscription was canceled by payment gating.
+             *
+             *     - `payment_failed`: the gating payment failed.
+             *     - `timeout`: the activation rule expired before the payment succeeded.
+             * @example payment_failed
+             * @enum {string|null}
+             */
+            cancellation_reason?: "payment_failed" | "timeout" | null;
+            /**
+             * Format: date-time
+             * @description The date and time when a payment-gated subscription was activated (i.e. moved from `incomplete` to `active` once the gating payment succeeded), represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null while the subscription is still `incomplete`.
+             * @example 2022-08-08T00:00:00Z
+             */
+            activated_at?: string | null;
+            /** @description The activation rules attached to the subscription. A payment activation rule gates activation on a successful first payment, keeping the subscription in the `incomplete` state until the payment succeeds or the rule expires. */
+            activation_rules?: components["schemas"]["SubscriptionActivationRuleObject"][];
         };
         SubscriptionsPaginated: {
             subscriptions: components["schemas"]["SubscriptionObject"][];
@@ -9700,8 +9829,7 @@ export interface components {
         };
         EventObject: {
             /**
-             * Format: uuid
-             * @description Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system
+             * @description Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system. It is an opaque identifier and is not guaranteed to be a UUID; on organizations using the ClickHouse events store it is a composite string.
              * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
              */
             lago_id?: string | null;
@@ -10819,8 +10947,8 @@ export interface components {
         ChargeProperties: {
             /**
              * @deprecated
-             * @description The list of event properties that are used to group the events on the invoice for a `standard` charge model.
-             *     **DEPRECATED** Replaced by `pricing_group_keys`.
+             * @description **Deprecated.** Replaced by `pricing_group_keys`.
+             *     The list of event properties that are used to group the events on the invoice for a `standard` charge model.
              * @example [
              *       "agent_name"
              *     ]
@@ -12874,6 +13002,19 @@ export interface components {
             usage_thresholds?: components["schemas"]["UsageThresholdInput"][];
             metadata?: components["schemas"]["MetadataInput"];
         };
+        SubscriptionActivationRuleInput: {
+            /**
+             * @description The type of the activation rule. Only `payment` is currently supported. A `payment` rule gates the subscription activation on a successful payment of the first invoice.
+             * @example payment
+             * @enum {string}
+             */
+            type: "payment";
+            /**
+             * @description The number of hours the subscription stays in the `incomplete` state waiting for the payment to succeed before it is automatically canceled. Must be a positive integer or zero.
+             * @example 48
+             */
+            timeout_hours?: number;
+        };
         SubscriptionCreateInput: {
             /**
              * @description Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
@@ -12954,6 +13095,8 @@ export interface components {
                  * @example true
                  */
                 consolidate_invoice: boolean;
+                /** @description Optional list of activation rules that gate the subscription activation. When a `payment` rule is provided and the plan is paid in advance (and the subscription is not in a trial), the subscription is created in the `incomplete` state and is only activated once the gating payment succeeds. If the payment fails or the rule's `timeout_hours` elapses, the subscription is canceled. */
+                activation_rules?: components["schemas"]["SubscriptionActivationRuleInput"][];
             };
         };
         ApplicableUsageThreshold: {
@@ -13024,6 +13167,8 @@ export interface components {
                  * @example default
                  */
                 billing_entity_code?: string;
+                /** @description Optional list of activation rules that gate the subscription activation. Activation rules can only be set or modified while the subscription is `pending` (future-dated and not yet activated); the request is rejected for `incomplete`, `active`, or `terminated` subscriptions. */
+                activation_rules?: components["schemas"]["SubscriptionActivationRuleInput"][];
             };
         };
         Subscription: {
@@ -13357,7 +13502,7 @@ export interface components {
             description?: string | null;
             /**
              * @deprecated
-             * @description This field is deprecated and will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
+             * @description **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.
              * @example true
              */
             applied_to_organization?: boolean;
@@ -13665,6 +13810,16 @@ export interface components {
         WalletTransactionsPaginated: components["schemas"]["WalletTransactions"] & {
             meta: components["schemas"]["PaginationMeta"];
         };
+        WebhookPublicKeyObject: {
+            /**
+             * @description Base64-encoded public key used to verify webhook signatures.
+             * @example MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE=
+             */
+            public_key: string;
+        };
+        WebhookPublicKey: {
+            webhook: components["schemas"]["WebhookPublicKeyObject"];
+        };
         WebhookEndpointObject: {
             /**
              * Format: uuid
@@ -13936,6 +14091,18 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        OverdueBalancePerCurrencyObject: {
+            /**
+             * @description The amount of the overdue balance for this currency, expressed in cents.
+             * @example 120
+             */
+            amount_cents: number;
+            /**
+             * @description The currency of the overdue balance.
+             * @example EUR
+             */
+            currency: components["schemas"]["Currency"];
+        };
         DunningCampaignFinishedObject: {
             /**
              * @description The customer external unique identifier (provided by your own application).
@@ -13957,6 +14124,8 @@ export interface components {
              * @example EUR
              */
             overdue_balance_currency: components["schemas"]["Currency"];
+            /** @description Overdue balance broken down per currency. */
+            overdue_balances?: components["schemas"]["OverdueBalancePerCurrencyObject"][];
         };
         EventErrorsObject: {
             /**
@@ -13996,7 +14165,10 @@ export interface components {
              *     ]
              */
             invalid_filter_values: string[];
-            /** @deprecated */
+            /**
+             * @deprecated
+             * @description **Deprecated.** List of event transaction_id with a missing group key.
+             */
             missing_group_key: string[];
         };
         FeeTaxProviderErrorObject: {
@@ -14291,6 +14463,8 @@ export interface components {
         wallet_code: string;
         /** @description 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. */
         lago_invoice_id: string;
+        /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+        currency: string;
         /** @description Code of the existing plan. */
         plan_code: string;
         /** @description Code of the existing charge. */
@@ -16649,17 +16823,17 @@ export interface operations {
                 };
                 /**
                  * @deprecated
-                 * @description Filter usage to a specific charge by its Lago ID (UUID).
+                 * @description **Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).
                  */
                 filter_by_charge_id?: string;
                 /**
                  * @deprecated
-                 * @description Filter usage to a specific charge by its code.
+                 * @description **Deprecated.** Filter usage to a specific charge by its code.
                  */
                 filter_by_charge_code?: string;
                 /**
                  * @deprecated
-                 * @description Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
+                 * @description **Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
                  */
                 filter_by_group?: {
                     [key: string]: string;
@@ -17693,6 +17867,8 @@ export interface operations {
                 page?: components["parameters"]["page"];
                 /** @description Number of records per page. */
                 per_page?: components["parameters"]["per_page"];
+                /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+                currency?: components["parameters"]["currency"];
                 /** @description Unique identifier assigned to the customer in your application. */
                 external_customer_id?: components["parameters"]["external_customer_id"];
                 /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
@@ -18757,6 +18933,8 @@ export interface operations {
                 page?: components["parameters"]["page"];
                 /** @description Number of records per page. */
                 per_page?: components["parameters"]["per_page"];
+                /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+                currency?: components["parameters"]["currency"];
                 /** @description The customer external unique identifier (provided by your own application) */
                 external_customer_id?: string;
                 /** @description The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans. */
@@ -19845,6 +20023,8 @@ export interface operations {
                 page?: components["parameters"]["page"];
                 /** @description Number of records per page. */
                 per_page?: components["parameters"]["per_page"];
+                /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+                currency?: components["parameters"]["currency"];
                 /** @description The customer external unique identifier (provided by your own application). */
                 external_customer_id: string;
                 /** @description Filter wallets by billing entity codes. */
@@ -20300,6 +20480,27 @@ export interface operations {
             401: components["responses"]["Unauthorized"];
         };
     };
+    fetchJsonPublicKey: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Public key */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WebhookPublicKey"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+        };
+    };
     findAllWebhookEndpoints: {
         parameters: {
             query?: {
@@ -22489,6 +22690,90 @@ export interface operations {
             };
         };
     };
+    subscriptionIncomplete: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Signature of the webhook payload */
+                "X-Lago-Signature": components["parameters"]["webhook_signature"];
+                /** @description Algorithm used to generate the signature */
+                "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
+                /** @description Unique id of the webhook. It can be used for idempotency */
+                "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Details of the subscription */
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** @enum {string} */
+                    webhook_type: "subscription.incomplete";
+                    /** @enum {string} */
+                    object_type: "subscription";
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier of the organization, created by Lago.
+                     * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
+                     */
+                    organization_id: string;
+                    subscription: components["schemas"]["SubscriptionWithCustomerObject"];
+                };
+            };
+        };
+        responses: {
+            /** @description Return a 200 status to indicate that the data was received successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    subscriptionCanceled: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Signature of the webhook payload */
+                "X-Lago-Signature": components["parameters"]["webhook_signature"];
+                /** @description Algorithm used to generate the signature */
+                "X-Lago-Signature-Algorithm": components["parameters"]["webhook_signature_algorithm"];
+                /** @description Unique id of the webhook. It can be used for idempotency */
+                "X-Lago-Unique-Key": components["parameters"]["webhook_unique_key"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Details of the subscription */
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** @enum {string} */
+                    webhook_type: "subscription.canceled";
+                    /** @enum {string} */
+                    object_type: "subscription";
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier of the organization, created by Lago.
+                     * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
+                     */
+                    organization_id: string;
+                    subscription: components["schemas"]["SubscriptionWithCustomerObject"];
+                };
+            };
+        };
+        responses: {
+            /** @description Return a 200 status to indicate that the data was received successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     subscriptionStarted: {
         parameters: {
             query?: never;

package/package.json

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