lago-javascript-client 1.49.0 → 1.50.0

package/esm/openapi/client.d.ts

@@ -361,7 +361,7 @@ export interface TaxObject {
      */
     rate: number;
     /**
-     * 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.
+     * **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.
      * @deprecated
      * @example true
      */
@@ -406,7 +406,7 @@ export interface InvoiceCustomSectionObject {
      */
     display_name?: string;
     /**
-     * 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.
+     * **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.
      * @deprecated
      * @example true
      */
@@ -3817,7 +3817,7 @@ export interface AppliedInvoiceCustomSectionObject {
      */
     created_at: string;
     /**
-     * Unique identifier of the invoice custom section that was applied.
+     * **Deprecated.** Unique identifier of the invoice custom section that was applied.
      * @deprecated
      * @format uuid
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
@@ -3839,6 +3839,54 @@ export interface PaymentMethodReference {
      */
     payment_method_id?: string;
 }
+export interface SubscriptionActivationRuleObject {
+    /**
+     * Unique identifier assigned to the activation rule within the Lago application. This ID is exclusively created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * 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"
+     */
+    type: "payment";
+    /**
+     * 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;
+    /**
+     * 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"
+     */
+    status: "inactive" | "pending" | "satisfied" | "declined" | "failed" | "expired" | "not_applicable";
+    /**
+     * 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.
+     * @format date-time
+     * @example "2022-08-10T00:00:00Z"
+     */
+    expires_at?: string | null;
+    /**
+     * The creation date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    created_at: string;
+    /**
+     * The last update date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    updated_at: string;
+}
 export interface SubscriptionObject {
     /**
      * Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system
@@ -3895,12 +3943,13 @@ export interface SubscriptionObject {
     /**
      * 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"
      */
-    status: "active" | "canceled" | "pending" | "terminated";
+    status: "active" | "canceled" | "incomplete" | "pending" | "terminated";
     /**
      * 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.
      * @format date-time
@@ -4007,6 +4056,22 @@ export interface SubscriptionObject {
      * @example true
      */
     consolidate_invoice?: boolean;
+    /**
+     * 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"
+     */
+    cancellation_reason?: "payment_failed" | "timeout";
+    /**
+     * 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`.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    activated_at?: string | null;
+    /** 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?: SubscriptionActivationRuleObject[];
 }
 export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
@@ -5261,8 +5326,7 @@ export interface PaymentMethod {
 }
 export interface EventObject {
     /**
-     * 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
-     * @format uuid
+     * 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;
@@ -6354,8 +6418,8 @@ export interface MinimumCommitmentObject {
 export type ChargeModelEnum = "dynamic" | "graduated" | "graduated_percentage" | "package" | "percentage" | "standard" | "volume";
 export interface ChargeProperties {
     /**
+     * **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.
-     * **DEPRECATED** Replaced by `pricing_group_keys`.
      * @deprecated
      * @example ["agent_name"]
      */
@@ -7847,6 +7911,18 @@ export interface PlanOverridesObject {
     /** Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. */
     metadata?: MetadataInput;
 }
+export interface SubscriptionActivationRuleInput {
+    /**
+     * 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"
+     */
+    type: "payment";
+    /**
+     * 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;
+}
 export interface SubscriptionCreateInput {
     /**
      * 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.
@@ -7927,6 +8003,8 @@ export interface SubscriptionCreateInput {
          * @example true
          */
         consolidate_invoice?: boolean;
+        /** 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?: SubscriptionActivationRuleInput[];
     };
 }
 export interface ApplicableUsageThreshold {
@@ -7997,6 +8075,8 @@ export interface SubscriptionUpdateInput {
          * @example "default"
          */
         billing_entity_code?: string;
+        /** 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?: SubscriptionActivationRuleInput[];
     };
 }
 export interface Subscription {
@@ -8279,7 +8359,7 @@ export interface TaxBaseInput {
      */
     description?: string | null;
     /**
-     * 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.
+     * **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.
      * @deprecated
      * @example true
      */
@@ -8570,6 +8650,16 @@ export type WalletTransactionFundingsPaginated = WalletTransactionFundings & {
 export type WalletTransactionsPaginated = WalletTransactions & {
     meta: PaginationMeta;
 };
+export interface WebhookPublicKeyObject {
+    /**
+     * Base64-encoded public key used to verify webhook signatures.
+     * @example "MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE="
+     */
+    public_key: string;
+}
+export interface WebhookPublicKey {
+    webhook: WebhookPublicKeyObject;
+}
 export interface WebhookEndpointObject {
     /**
      * Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
@@ -8825,6 +8915,18 @@ export interface CreditNotePaymentProviderRefundError {
     payment_provider_code?: string;
     provider_error?: string | Record<string, any>;
 }
+export interface OverdueBalancePerCurrencyObject {
+    /**
+     * The amount of the overdue balance for this currency, expressed in cents.
+     * @example 120
+     */
+    amount_cents: number;
+    /**
+     * The currency of the overdue balance.
+     * @example "EUR"
+     */
+    currency: Currency;
+}
 export interface DunningCampaignFinishedObject {
     /**
      * The customer external unique identifier (provided by your own application).
@@ -8846,6 +8948,8 @@ export interface DunningCampaignFinishedObject {
      * @example "EUR"
      */
     overdue_balance_currency: Currency;
+    /** Overdue balance broken down per currency. */
+    overdue_balances?: OverdueBalancePerCurrencyObject[];
 }
 export interface EventErrorsObject {
     /**
@@ -8877,7 +8981,10 @@ export interface EventsErrorsObject {
      * @example ["transaction_1234567890"]
      */
     invalid_filter_values: string[];
-    /** @deprecated */
+    /**
+     * **Deprecated.** List of event transaction_id with a missing group key.
+     * @deprecated
+     */
     missing_group_key: string[];
 }
 export interface FeeTaxProviderErrorObject {
@@ -9135,7 +9242,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.49.0
+ * @version 1.50.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -10617,20 +10724,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             group?: Record<string, string>;
             /**
-             * Filter usage to a specific charge by its Lago ID (UUID).
+             * **Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).
              * @deprecated
              * @format uuid
              * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
              */
             filter_by_charge_id?: string;
             /**
-             * Filter usage to a specific charge by its code.
+             * **Deprecated.** Filter usage to a specific charge by its code.
              * @deprecated
              * @example "storage"
              */
             filter_by_charge_code?: string;
             /**
-             * Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
+             * **Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.
              * @deprecated
              * @example {"cloud":"aws"}
              */
@@ -11297,6 +11404,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * Unique identifier assigned to the customer in your application.
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -11755,6 +11867,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * The customer external unique identifier (provided by your own application)
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -12351,6 +12468,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
+            /**
+             * Filter the results by currency, expressed as an ISO 4217 code.
+             * @example "EUR"
+             */
+            currency?: string;
             /**
              * The customer external unique identifier (provided by your own application).
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
@@ -12551,9 +12673,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name FetchPublicKey
          * @summary Retrieve webhook public key
          * @request GET:/webhooks/public_key
+         * @deprecated
          * @secure
          */
         fetchPublicKey: (params?: RequestParams) => Promise<HttpResponse<string, ApiErrorUnauthorized>>;
+        /**
+         * @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.
+         *
+         * @tags webhooks
+         * @name FetchJsonPublicKey
+         * @summary Retrieve webhook public key (JSON)
+         * @request GET:/webhooks/json_public_key
+         * @secure
+         */
+        fetchJsonPublicKey: (params?: RequestParams) => Promise<HttpResponse<WebhookPublicKey, ApiErrorUnauthorized>>;
     };
     webhookEndpoints: {
         /**

package/esm/openapi/client.js

@@ -128,6 +128,14 @@ export class HttpClient {
                     if (r.ok) {
                         r.data = data;
                     }
+                    else if (responseFormat === "text") {
+                        try {
+                            r.error = JSON.parse(data);
+                        }
+                        catch {
+                            r.error = data;
+                        }
+                    }
                     else {
                         r.error = data;
                     }
@@ -148,7 +156,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.49.0
+ * @version 1.50.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -3518,12 +3526,30 @@ export class Api extends HttpClient {
          * @name FetchPublicKey
          * @summary Retrieve webhook public key
          * @request GET:/webhooks/public_key
+         * @deprecated
          * @secure
          */
         fetchPublicKey: (params = {}) => this.request({
             path: `/webhooks/public_key`,
             method: "GET",
             secure: true,
+            format: "text",
+            ...params,
+        }),
+        /**
+         * @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.
+         *
+         * @tags webhooks
+         * @name FetchJsonPublicKey
+         * @summary Retrieve webhook public key (JSON)
+         * @request GET:/webhooks/json_public_key
+         * @secure
+         */
+        fetchJsonPublicKey: (params = {}) => this.request({
+            path: `/webhooks/json_public_key`,
+            method: "GET",
+            secure: true,
+            format: "json",
             ...params,
         }),
     };