lark-billing 0.0.8 → 0.1.0

package/dist/cjs/api/resources/usageEvents/client/Client.js

@@ -63,11 +63,14 @@ class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "idempotency_key",
-     *         event_name: "event_name",
-     *         subject_id: "subject_id",
+     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         event_name: "compute_hours",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+     *         timestamp: "2025-10-31T20:29:47Z",
      *         data: {
-     *             "key": "value"
+     *             "compute_hours": 100,
+     *             "instance_type": "t2.micro",
+     *             "region": "us-east-1"
      *         }
      *     })
      */
@@ -122,74 +125,6 @@ class UsageEvents {
             }
         });
     }
-    /**
-     * @param {Lark.CreateUsageEventSummaryRequest} request
-     * @param {UsageEvents.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Lark.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.usageEvents.createUsageEventSummary({
-     *         event_name: "event_name",
-     *         subject_id: "subject_id",
-     *         period: {
-     *             start: "2024-01-15T09:30:00Z",
-     *             end: "2024-01-15T09:30:00Z"
-     *         },
-     *         aggregation_type: "sum"
-     *     })
-     */
-    createUsageEventSummary(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createUsageEventSummary(request, requestOptions));
-    }
-    __createUsageEventSummary(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LarkEnvironment.Default, "usage-events/summary"),
-                method: "POST",
-                headers: _headers,
-                contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Lark.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.LarkError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.LarkError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.LarkTimeoutError("Timeout exceeded when calling POST /usage-events/summary.");
-                case "unknown":
-                    throw new errors.LarkError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventRequest.d.ts

@@ -4,18 +4,31 @@
 /**
  * @example
  *     {
- *         idempotency_key: "idempotency_key",
- *         event_name: "event_name",
- *         subject_id: "subject_id",
+ *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+ *         event_name: "compute_hours",
+ *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+ *         timestamp: "2025-10-31T20:29:47Z",
  *         data: {
- *             "key": "value"
+ *             "compute_hours": 100,
+ *             "instance_type": "t2.micro",
+ *             "region": "us-east-1"
  *         }
  *     }
  */
 export interface CreateUsageEventRequest {
+    /** The idempotency key for the usage event. This ensures that the same event is not processed multiple times. */
     idempotency_key: string;
+    /** The name of the event. This is used by pricing metrics to aggregate usage events. */
     event_name: string;
+    /** The ID of the subject that the usage event is for. */
     subject_id: string;
+    /** The timestamp of the usage event. It is highly recommended to provide a timestamp. If not provided, the current timestamp will be used. */
     timestamp?: string;
-    data: Record<string, unknown>;
+    /** The data of the usage event. This should contain any data that is needed to aggregate the usage event. */
+    data: Record<string, CreateUsageEventRequest.Data.Value>;
+}
+export declare namespace CreateUsageEventRequest {
+    namespace Data {
+        type Value = string | number;
+    }
 }

package/dist/cjs/api/resources/usageEvents/client/requests/index.d.ts

@@ -1,2 +1 @@
 export { type CreateUsageEventRequest } from "./CreateUsageEventRequest.js";
-export { type CreateUsageEventSummaryRequest } from "./CreateUsageEventSummaryRequest.js";

package/dist/cjs/api/types/Aggregation.d.ts

@@ -2,11 +2,20 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.js";
-export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Sum;
+/**
+ * The aggregation function used to compute the value of the pricing metric.
+ */
+export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Last | Lark.Aggregation.Max | Lark.Aggregation.Sum;
 export declare namespace Aggregation {
     interface Count extends Lark.CountAggregationPricingMetricResource {
         aggregation_type: "count";
     }
+    interface Last extends Lark.LastAggregationPricingMetricResource {
+        aggregation_type: "last";
+    }
+    interface Max extends Lark.MaxAggregationPricingMetricResource {
+        aggregation_type: "max";
+    }
     interface Sum extends Lark.SumAggregationPricingMetricResource {
         aggregation_type: "sum";
     }

package/dist/cjs/api/types/Amount.d.ts

@@ -4,5 +4,6 @@
 export interface Amount {
     /** The value of the amount in the smallest unit of the currency. */
     value: string;
+    /** The currency code of the amount. */
     currency_code: string;
 }

package/dist/cjs/api/types/BillingStateResponse.d.ts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BillingStateResponse {
+    /** Whether the subject has an active subscription. */
     has_active_subscription: boolean;
+    /** Whether the subject has exceeded the included usage (if any) on a usage-based rate they are subscribed to. */
     has_overage_for_usage: boolean;
 }

package/dist/cjs/api/types/CountAggregationPricingMetricInterface.d.ts

@@ -1,5 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Computes the number of usage events with the specified `event_name`.
+ */
 export interface CountAggregationPricingMetricInterface {
 }

package/dist/cjs/api/types/CreateCustomerPortalSessionResponse.d.ts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface CreateCustomerPortalSessionResponse {
+    /** The ID of the subject for the customer portal session. */
     subject_id: string;
+    /** The URL to redirect to the customer portal session. */
     url: string;
 }

package/dist/cjs/api/types/CreateFixedRateRequest.d.ts

@@ -3,7 +3,9 @@
  */
 import * as Lark from "../index.js";
 export interface CreateFixedRateRequest {
-    name?: string;
+    /** The name of the rate displayed to the customer. */
+    name: string;
+    /** The description of the rate displayed to the customer. */
     description?: string;
     price: Lark.Price;
 }

package/dist/cjs/api/types/CreateSimpleUsageBasedRateRequest.d.ts

@@ -3,9 +3,12 @@
  */
 import * as Lark from "../index.js";
 export interface CreateSimpleUsageBasedRateRequest {
-    name?: string;
+    /** The name of the rate displayed to the customer. */
+    name: string;
+    /** The description of the rate displayed to the customer. */
     description?: string;
     price: Lark.Price;
+    /** The number of units included in the rate before the price is applied. */
     included_units?: number;
     /** The ID of the pricing metric to use for this rate. */
     pricing_metric_id: string;

package/dist/cjs/api/types/CreateSubscriptionCheckoutSessionResponse.d.ts

@@ -3,7 +3,10 @@
  */
 import * as Lark from "../index.js";
 export interface CreateSubscriptionCheckoutSessionResponse {
+    /** The ID of the checkout session. */
     id: string;
+    /** The amount of the checkout session. */
     amount: Lark.Amount;
+    /** The URL to redirect to the checkout session. */
     url: string;
 }

package/dist/cjs/api/types/CustomAggregationPricingMetricInterface.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Custom aggregation for use cases not supported by the other aggregation types. Please email team@uselark.ai to enable this feature.
+ */
+export interface CustomAggregationPricingMetricInterface {
+    /** Custom expression to compute the pricing metric. Please email team@uselark.ai to enable this feature. */
+    custom_expression: string;
+}

package/dist/cjs/api/types/FixedRateInterface.d.ts

@@ -5,6 +5,6 @@ import * as Lark from "../index.js";
 export interface FixedRateInterface {
     id: string;
     name: string;
-    description: string;
+    description?: string;
     price: Lark.Price;
 }

package/dist/cjs/api/types/InvoiceResource.d.ts

@@ -3,17 +3,25 @@
  */
 import * as Lark from "../index.js";
 export interface InvoiceResource {
+    /** The ID of the invoice. */
     id: string;
-    merchant_id: string;
-    bill_id?: string;
+    /** The total amount of the invoice. */
     total_amount: Lark.Amount;
+    /** The ID of the subject for the invoice. */
     subject_id: string;
+    /** The date and time the invoice was created. */
     created_at: string;
+    /** The status of the invoice. */
     status: InvoiceResource.Status;
+    /** The URL of the hosted invoice. */
     hosted_url?: string;
+    /** The line items of the invoice. */
     line_items: Lark.InvoiceLineItemResource[];
 }
 export declare namespace InvoiceResource {
+    /**
+     * The status of the invoice.
+     */
     type Status = "draft" | "open" | "paid" | "uncollectible" | "void";
     const Status: {
         readonly Draft: "draft";

package/dist/cjs/api/types/LastAggregationPricingMetricInterface.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Computes the last value of the `value_field` over all usage events with the specified `event_name`.
+ */
+export interface LastAggregationPricingMetricInterface {
+    /** Field to get the last value of. */
+    value_field: string;
+}

package/dist/cjs/api/types/LastAggregationPricingMetricResource.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LastAggregationPricingMetricResource {
+    /** The field to get the last value of. */
+    value_field: string;
+}

package/dist/cjs/api/types/LastAggregationPricingMetricResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MaxAggregationPricingMetricInterface.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Computes the max value of the `value_field` over all usage events with the specified `event_name`.
+ */
+export interface MaxAggregationPricingMetricInterface {
+    /** Field to get the max value of. */
+    value_field: string;
+}

package/dist/cjs/api/types/MaxAggregationPricingMetricInterface.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MaxAggregationPricingMetricResource.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MaxAggregationPricingMetricResource {
+    /** The field to get the max value of. */
+    value_field: string;
+}

package/dist/cjs/api/types/MaxAggregationPricingMetricResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/PricingMetricResource.d.ts

@@ -3,9 +3,14 @@
  */
 import * as Lark from "../index.js";
 export interface PricingMetricResource {
+    /** The ID of the pricing metric. */
     id: string;
+    /** The name of the pricing metric. */
     name: string;
+    /** The event name that the pricing metric is computed on. */
     event_name: string;
+    /** The aggregation function used to compute the value of the pricing metric. */
     aggregation: Lark.Aggregation;
+    /** The unit of the value computed by the pricing metric. */
     unit: string;
 }

package/dist/cjs/api/types/PricingMetricSummaryResource.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface PricingMetricSummaryResource {
+    /** The ID of the pricing metric summary. */
+    id: string;
+    /** The ID of the pricing metric that the summary is for. */
+    pricing_metric_id: string;
+    /** The ID of the subject that the summary is for. */
+    subject_id: string;
+    /** The period that the summary is computed over. */
+    period: Lark.Period;
+    /** The computed value of the pricing metric for the period. If the pricing metric does not have any usage events for the period, this will be `null`. */
+    value?: string;
+}

package/dist/cjs/api/types/PricingMetricSummaryResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/RateCardResource.d.ts

@@ -3,13 +3,20 @@
  */
 import * as Lark from "../index.js";
 export interface RateCardResource {
+    /** The ID of the rate card. */
     id: string;
+    /** The name of the rate card. */
     name: string;
-    description: string;
+    /** The description of the rate card. */
+    description?: string;
+    /** The usage based rates of the rate card. */
     usage_based_rates: Lark.RateCardResourceUsageBasedRatesItem[];
+    /** The fixed rates of the rate card. */
     fixed_rates: Lark.FixedRateInterface[];
     billing_interval: RateCardResource.BillingInterval;
+    /** The date and time the rate card was created. */
     created_at: string;
+    /** The date and time the rate card was last updated. */
     updated_at: string;
     metadata: Record<string, string>;
 }

package/dist/cjs/api/types/SimpleUsageBasedRateInterface.d.ts

@@ -5,7 +5,7 @@ import * as Lark from "../index.js";
 export interface SimpleUsageBasedRateInterface {
     id: string;
     name: string;
-    description: string;
+    description?: string;
     price: Lark.Price;
     included_units: number;
     pricing_metric_id: string;

package/dist/cjs/api/types/SubscriptionResource.d.ts

@@ -3,17 +3,28 @@
  */
 import * as Lark from "../index.js";
 export interface SubscriptionResource {
+    /** The ID of the subscription. */
     id: string;
+    /** The ID of the subject that the subscription is for. */
     subject_id: string;
+    /** The ID of the rate card of the subscription. */
     rate_card_id: string;
+    /** The date and time the subscription became effective. */
     effective_at: string;
+    /** The date and time the next cycle of the subscription will start. */
     cycles_next_at?: string;
+    /** The current period of the subscription if it is active. */
     current_period?: Lark.PeriodResource;
     metadata: Record<string, string>;
+    /** The status of the subscription. */
     status: SubscriptionResource.Status;
+    /** Whether the subscription will be cancelled at the end of the current cycle. */
     cancels_at_end_of_cycle: boolean;
 }
 export declare namespace SubscriptionResource {
+    /**
+     * The status of the subscription.
+     */
     type Status = "active" | "cancelled" | "paused";
     const Status: {
         readonly Active: "active";

package/dist/cjs/api/types/SumAggregationPricingMetricInterface.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Computes the sum of the `value_field` over all usage events with the specified `event_name`.
+ */
 export interface SumAggregationPricingMetricInterface {
     /** Field to sum over. */
     value_field: string;

package/dist/cjs/api/types/SumAggregationPricingMetricResource.d.ts

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SumAggregationPricingMetricResource {
+    /** The field to sum over. */
     value_field: string;
 }

package/dist/cjs/api/types/index.d.ts

@@ -5,27 +5,30 @@ export * from "./CountAggregationPricingMetricResource.js";
 export * from "./CreateCustomerPortalSessionResponse.js";
 export * from "./Price.js";
 export * from "./CreateFixedRateRequest.js";
-export * from "./Aggregation.js";
-export * from "./CreatePricingMetricResponse.js";
 export * from "./CreateSimpleUsageBasedRateRequest.js";
 export * from "./CreateSubjectResponse.js";
 export * from "./CreateSubscriptionCheckoutSessionResponse.js";
-export * from "./CreateUsageEventSummaryResponse.js";
+export * from "./CustomAggregationPricingMetricInterface.js";
 export * from "./FixedRateInterface.js";
 export * from "./FlatPrice.js";
-export * from "./GetPricingMetricResponse.js";
 export * from "./HttpValidationError.js";
 export * from "./InvoiceLineItemResource.js";
 export * from "./InvoiceResource.js";
+export * from "./LastAggregationPricingMetricInterface.js";
+export * from "./LastAggregationPricingMetricResource.js";
 export * from "./ListInvoicesResponse.js";
 export * from "./ListPricingMetricsResponse.js";
 export * from "./ListRateCardsResponse.js";
 export * from "./ListSubjectsResponse.js";
 export * from "./ListSubscriptionsResponse.js";
+export * from "./MaxAggregationPricingMetricInterface.js";
+export * from "./MaxAggregationPricingMetricResource.js";
 export * from "./PackagePrice.js";
 export * from "./Period.js";
 export * from "./PeriodResource.js";
+export * from "./Aggregation.js";
 export * from "./PricingMetricResource.js";
+export * from "./PricingMetricSummaryResource.js";
 export * from "./RateCardResourceUsageBasedRatesItem.js";
 export * from "./RateCardResource.js";
 export * from "./SimpleUsageBasedRateInterface.js";

package/dist/cjs/api/types/index.js

@@ -21,27 +21,30 @@ __exportStar(require("./CountAggregationPricingMetricResource.js"), exports);
 __exportStar(require("./CreateCustomerPortalSessionResponse.js"), exports);
 __exportStar(require("./Price.js"), exports);
 __exportStar(require("./CreateFixedRateRequest.js"), exports);
-__exportStar(require("./Aggregation.js"), exports);
-__exportStar(require("./CreatePricingMetricResponse.js"), exports);
 __exportStar(require("./CreateSimpleUsageBasedRateRequest.js"), exports);
 __exportStar(require("./CreateSubjectResponse.js"), exports);
 __exportStar(require("./CreateSubscriptionCheckoutSessionResponse.js"), exports);
-__exportStar(require("./CreateUsageEventSummaryResponse.js"), exports);
+__exportStar(require("./CustomAggregationPricingMetricInterface.js"), exports);
 __exportStar(require("./FixedRateInterface.js"), exports);
 __exportStar(require("./FlatPrice.js"), exports);
-__exportStar(require("./GetPricingMetricResponse.js"), exports);
 __exportStar(require("./HttpValidationError.js"), exports);
 __exportStar(require("./InvoiceLineItemResource.js"), exports);
 __exportStar(require("./InvoiceResource.js"), exports);
+__exportStar(require("./LastAggregationPricingMetricInterface.js"), exports);
+__exportStar(require("./LastAggregationPricingMetricResource.js"), exports);
 __exportStar(require("./ListInvoicesResponse.js"), exports);
 __exportStar(require("./ListPricingMetricsResponse.js"), exports);
 __exportStar(require("./ListRateCardsResponse.js"), exports);
 __exportStar(require("./ListSubjectsResponse.js"), exports);
 __exportStar(require("./ListSubscriptionsResponse.js"), exports);
+__exportStar(require("./MaxAggregationPricingMetricInterface.js"), exports);
+__exportStar(require("./MaxAggregationPricingMetricResource.js"), exports);
 __exportStar(require("./PackagePrice.js"), exports);
 __exportStar(require("./Period.js"), exports);
 __exportStar(require("./PeriodResource.js"), exports);
+__exportStar(require("./Aggregation.js"), exports);
 __exportStar(require("./PricingMetricResource.js"), exports);
+__exportStar(require("./PricingMetricSummaryResource.js"), exports);
 __exportStar(require("./RateCardResourceUsageBasedRatesItem.js"), exports);
 __exportStar(require("./RateCardResource.js"), exports);
 __exportStar(require("./SimpleUsageBasedRateInterface.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.8";
+export declare const SDK_VERSION = "0.1.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.8";
+exports.SDK_VERSION = "0.1.0";

package/dist/esm/Client.mjs

@@ -17,8 +17,8 @@ export class LarkClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "lark-billing",
-                "X-Fern-SDK-Version": "0.0.8",
-                "User-Agent": "lark-billing/0.0.8",
+                "X-Fern-SDK-Version": "0.1.0",
+                "User-Agent": "lark-billing/0.1.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/checkout/client/Client.d.mts

@@ -37,8 +37,8 @@ export declare class Checkout {
      *
      * @example
      *     await client.checkout.createSubscriptionCheckoutSession({
-     *         subject_id: "subject_id",
-     *         rate_card_id: "rate_card_id",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
      *         success_callback_url: "https://example.com/callback"
      *     })
      */

package/dist/esm/api/resources/checkout/client/Client.mjs

@@ -27,8 +27,8 @@ export class Checkout {
      *
      * @example
      *     await client.checkout.createSubscriptionCheckoutSession({
-     *         subject_id: "subject_id",
-     *         rate_card_id: "rate_card_id",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
      *         success_callback_url: "https://example.com/callback"
      *     })
      */

package/dist/esm/api/resources/checkout/client/requests/CreateSubscriptionCheckoutSessionRequest.d.mts

@@ -4,13 +4,15 @@
 /**
  * @example
  *     {
- *         subject_id: "subject_id",
- *         rate_card_id: "rate_card_id",
+ *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+ *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
  *         success_callback_url: "https://example.com/callback"
  *     }
  */
 export interface CreateSubscriptionCheckoutSessionRequest {
+    /** The ID of the subject to create the checkout for. */
     subject_id: string;
+    /** The ID of the rate card to subscribe to. */
     rate_card_id: string;
     /** The URL to redirect to after the checkout is successful. */
     success_callback_url: string;

package/dist/esm/api/resources/customerPortal/client/Client.d.mts

@@ -37,7 +37,7 @@ export declare class CustomerPortal {
      *
      * @example
      *     await client.customerPortal.createCustomerPortalSession({
-     *         subject_id: "subject_id"
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
      *     })
      */
     createCustomerPortalSession(request: Lark.CreateCustomerPortalSessionRequest, requestOptions?: CustomerPortal.RequestOptions): core.HttpResponsePromise<Lark.CreateCustomerPortalSessionResponse>;

package/dist/esm/api/resources/customerPortal/client/Client.mjs

@@ -27,7 +27,7 @@ export class CustomerPortal {
      *
      * @example
      *     await client.customerPortal.createCustomerPortalSession({
-     *         subject_id: "subject_id"
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
      *     })
      */
     createCustomerPortalSession(request, requestOptions) {

package/dist/esm/api/resources/customerPortal/client/requests/CreateCustomerPortalSessionRequest.d.mts

@@ -4,9 +4,10 @@
 /**
  * @example
  *     {
- *         subject_id: "subject_id"
+ *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
  *     }
  */
 export interface CreateCustomerPortalSessionRequest {
+    /** The ID of the subject to create the customer portal session for. */
     subject_id: string;
 }