lark-billing 0.1.0 → 0.1.1

package/dist/cjs/Client.js

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

package/dist/cjs/api/resources/checkout/client/requests/CreateSubscriptionCheckoutSessionRequest.d.ts

@@ -10,7 +10,7 @@
  *     }
  */
 export interface CreateSubscriptionCheckoutSessionRequest {
-    /** The ID of the subject to create the checkout for. */
+    /** The ID or external 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;

package/dist/cjs/api/resources/customerPortal/client/requests/CreateCustomerPortalSessionRequest.d.ts

@@ -8,6 +8,6 @@
  *     }
  */
 export interface CreateCustomerPortalSessionRequest {
-    /** The ID of the subject to create the customer portal session for. */
+    /** The ID or external ID of the subject to create the customer portal session for. */
     subject_id: string;
 }

package/dist/cjs/api/resources/invoices/client/requests/ListInvoicesInvoicesGetRequest.d.ts

@@ -10,7 +10,7 @@
  *     }
  */
 export interface ListInvoicesInvoicesGetRequest {
-    /** The ID of the subject to list invoices for. */
+    /** The ID or external ID of the subject to list invoices for. */
     subject_id: string;
     limit?: number;
     offset?: number;

package/dist/cjs/api/resources/pricingMetrics/client/requests/CreatePricingMetricSummaryRequest.d.ts

@@ -13,7 +13,7 @@ import * as Lark from "../../../../index.js";
  *     }
  */
 export interface CreatePricingMetricSummaryRequest {
-    /** The ID of the subject that the summary should be computed for. */
+    /** The ID or external ID of the subject that the summary should be computed for. */
     subject_id: string;
     /** The period that the summary should be computed over. */
     period: Lark.Period;

package/dist/cjs/api/resources/subscriptions/client/requests/CreateSubscriptionRequest.d.ts

@@ -11,7 +11,7 @@
 export interface CreateSubscriptionRequest {
     /** The ID of the rate card to use for the subscription. */
     rate_card_id: string;
-    /** The ID of the subject to create the subscription for. */
+    /** The ID or external ID of the subject to create the subscription for. */
     subject_id: string;
     /** Additional metadata about the subscription. You may use this to store any custom data about the subscription. */
     metadata?: Record<string, string>;

package/dist/cjs/api/resources/subscriptions/client/requests/ListSubscriptionsSubscriptionsGetRequest.d.ts

@@ -11,7 +11,7 @@
  */
 export interface ListSubscriptionsSubscriptionsGetRequest {
     limit?: number;
-    /** The ID of the subject to list subscriptions for. Cannot be used with rate_card_id. */
+    /** The ID or external ID of the subject to list subscriptions for. Cannot be used with rate_card_id. */
     subject_id?: string;
     /** The ID of the rate card to list subscriptions for. Cannot be used with subject_id. */
     rate_card_id?: string;

package/dist/cjs/api/resources/usageEvents/client/Client.d.ts

@@ -37,10 +37,10 @@ export declare class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
      *         event_name: "compute_hours",
      *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
-     *         timestamp: "2025-10-31T20:29:47Z",
+     *         timestamp: "2025-11-03T18:37:02Z",
      *         data: {
      *             "compute_hours": 100,
      *             "instance_type": "t2.micro",

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

@@ -63,10 +63,10 @@ class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
      *         event_name: "compute_hours",
      *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
-     *         timestamp: "2025-10-31T20:29:47Z",
+     *         timestamp: "2025-11-03T18:37:02Z",
      *         data: {
      *             "compute_hours": 100,
      *             "instance_type": "t2.micro",

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

@@ -4,10 +4,10 @@
 /**
  * @example
  *     {
- *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+ *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
  *         event_name: "compute_hours",
  *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
- *         timestamp: "2025-10-31T20:29:47Z",
+ *         timestamp: "2025-11-03T18:37:02Z",
  *         data: {
  *             "compute_hours": 100,
  *             "instance_type": "t2.micro",
@@ -20,7 +20,7 @@ export interface CreateUsageEventRequest {
     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. */
+    /** The ID or external 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;

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActiveSubscription {
+    subscription_id: string;
+    rate_card_id: string;
+}

package/dist/cjs/api/types/ActiveSubscription.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/BillingStateResponse.d.ts

@@ -1,9 +1,14 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Lark from "../index.js";
 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;
+    /** List of active subscriptions the subject is subscribed to. */
+    active_subscriptions: Lark.ActiveSubscription[];
+    /** The usage data for the usage-based rates the subject is subscribed to. */
+    usage_data: Lark.UsageDataForRate[];
 }

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

@@ -6,4 +6,6 @@ export interface CreateCustomerPortalSessionResponse {
     subject_id: string;
     /** The URL to redirect to the customer portal session. */
     url: string;
+    /** The date and time the customer portal session expires. */
+    expires_at: string;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UsageDataForRate {
+    rate_name: string;
+    pricing_metric_id: string;
+    included_units: number;
+    used_units: string;
+}

package/dist/cjs/api/types/UsageDataForRate.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/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ActiveSubscription.js";
 export * from "./Amount.js";
 export * from "./BillingStateResponse.js";
 export * from "./CountAggregationPricingMetricInterface.js";
@@ -36,4 +37,5 @@ export * from "./SubjectResource.js";
 export * from "./SubscriptionResource.js";
 export * from "./SumAggregationPricingMetricInterface.js";
 export * from "./SumAggregationPricingMetricResource.js";
+export * from "./UsageDataForRate.js";
 export * from "./ValidationError.js";

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

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActiveSubscription.js"), exports);
 __exportStar(require("./Amount.js"), exports);
 __exportStar(require("./BillingStateResponse.js"), exports);
 __exportStar(require("./CountAggregationPricingMetricInterface.js"), exports);
@@ -52,4 +53,5 @@ __exportStar(require("./SubjectResource.js"), exports);
 __exportStar(require("./SubscriptionResource.js"), exports);
 __exportStar(require("./SumAggregationPricingMetricInterface.js"), exports);
 __exportStar(require("./SumAggregationPricingMetricResource.js"), exports);
+__exportStar(require("./UsageDataForRate.js"), exports);
 __exportStar(require("./ValidationError.js"), exports);

package/dist/cjs/version.d.ts

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

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.1.0";
+exports.SDK_VERSION = "0.1.1";

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.1.0",
-                "User-Agent": "lark-billing/0.1.0",
+                "X-Fern-SDK-Version": "0.1.1",
+                "User-Agent": "lark-billing/0.1.1",
                 "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/requests/CreateSubscriptionCheckoutSessionRequest.d.mts

@@ -10,7 +10,7 @@
  *     }
  */
 export interface CreateSubscriptionCheckoutSessionRequest {
-    /** The ID of the subject to create the checkout for. */
+    /** The ID or external 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;

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

@@ -8,6 +8,6 @@
  *     }
  */
 export interface CreateCustomerPortalSessionRequest {
-    /** The ID of the subject to create the customer portal session for. */
+    /** The ID or external ID of the subject to create the customer portal session for. */
     subject_id: string;
 }

package/dist/esm/api/resources/invoices/client/requests/ListInvoicesInvoicesGetRequest.d.mts

@@ -10,7 +10,7 @@
  *     }
  */
 export interface ListInvoicesInvoicesGetRequest {
-    /** The ID of the subject to list invoices for. */
+    /** The ID or external ID of the subject to list invoices for. */
     subject_id: string;
     limit?: number;
     offset?: number;

package/dist/esm/api/resources/pricingMetrics/client/requests/CreatePricingMetricSummaryRequest.d.mts

@@ -13,7 +13,7 @@ import * as Lark from "../../../../index.mjs";
  *     }
  */
 export interface CreatePricingMetricSummaryRequest {
-    /** The ID of the subject that the summary should be computed for. */
+    /** The ID or external ID of the subject that the summary should be computed for. */
     subject_id: string;
     /** The period that the summary should be computed over. */
     period: Lark.Period;

package/dist/esm/api/resources/subscriptions/client/requests/CreateSubscriptionRequest.d.mts

@@ -11,7 +11,7 @@
 export interface CreateSubscriptionRequest {
     /** The ID of the rate card to use for the subscription. */
     rate_card_id: string;
-    /** The ID of the subject to create the subscription for. */
+    /** The ID or external ID of the subject to create the subscription for. */
     subject_id: string;
     /** Additional metadata about the subscription. You may use this to store any custom data about the subscription. */
     metadata?: Record<string, string>;

package/dist/esm/api/resources/subscriptions/client/requests/ListSubscriptionsSubscriptionsGetRequest.d.mts

@@ -11,7 +11,7 @@
  */
 export interface ListSubscriptionsSubscriptionsGetRequest {
     limit?: number;
-    /** The ID of the subject to list subscriptions for. Cannot be used with rate_card_id. */
+    /** The ID or external ID of the subject to list subscriptions for. Cannot be used with rate_card_id. */
     subject_id?: string;
     /** The ID of the rate card to list subscriptions for. Cannot be used with subject_id. */
     rate_card_id?: string;

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

@@ -37,10 +37,10 @@ export declare class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
      *         event_name: "compute_hours",
      *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
-     *         timestamp: "2025-10-31T20:29:47Z",
+     *         timestamp: "2025-11-03T18:37:02Z",
      *         data: {
      *             "compute_hours": 100,
      *             "instance_type": "t2.micro",

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

@@ -27,10 +27,10 @@ export class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
      *         event_name: "compute_hours",
      *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
-     *         timestamp: "2025-10-31T20:29:47Z",
+     *         timestamp: "2025-11-03T18:37:02Z",
      *         data: {
      *             "compute_hours": 100,
      *             "instance_type": "t2.micro",

package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventRequest.d.mts

@@ -4,10 +4,10 @@
 /**
  * @example
  *     {
- *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+ *         idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
  *         event_name: "compute_hours",
  *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
- *         timestamp: "2025-10-31T20:29:47Z",
+ *         timestamp: "2025-11-03T18:37:02Z",
  *         data: {
  *             "compute_hours": 100,
  *             "instance_type": "t2.micro",
@@ -20,7 +20,7 @@ export interface CreateUsageEventRequest {
     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. */
+    /** The ID or external 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;

package/dist/esm/api/types/ActiveSubscription.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActiveSubscription {
+    subscription_id: string;
+    rate_card_id: string;
+}

package/dist/esm/api/types/ActiveSubscription.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/BillingStateResponse.d.mts

@@ -1,9 +1,14 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Lark from "../index.mjs";
 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;
+    /** List of active subscriptions the subject is subscribed to. */
+    active_subscriptions: Lark.ActiveSubscription[];
+    /** The usage data for the usage-based rates the subject is subscribed to. */
+    usage_data: Lark.UsageDataForRate[];
 }

package/dist/esm/api/types/CreateCustomerPortalSessionResponse.d.mts

@@ -6,4 +6,6 @@ export interface CreateCustomerPortalSessionResponse {
     subject_id: string;
     /** The URL to redirect to the customer portal session. */
     url: string;
+    /** The date and time the customer portal session expires. */
+    expires_at: string;
 }

package/dist/esm/api/types/UsageDataForRate.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UsageDataForRate {
+    rate_name: string;
+    pricing_metric_id: string;
+    included_units: number;
+    used_units: string;
+}

package/dist/esm/api/types/UsageDataForRate.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/index.d.mts

@@ -1,3 +1,4 @@
+export * from "./ActiveSubscription.mjs";
 export * from "./Amount.mjs";
 export * from "./BillingStateResponse.mjs";
 export * from "./CountAggregationPricingMetricInterface.mjs";
@@ -36,4 +37,5 @@ export * from "./SubjectResource.mjs";
 export * from "./SubscriptionResource.mjs";
 export * from "./SumAggregationPricingMetricInterface.mjs";
 export * from "./SumAggregationPricingMetricResource.mjs";
+export * from "./UsageDataForRate.mjs";
 export * from "./ValidationError.mjs";

package/dist/esm/api/types/index.mjs

@@ -1,3 +1,4 @@
+export * from "./ActiveSubscription.mjs";
 export * from "./Amount.mjs";
 export * from "./BillingStateResponse.mjs";
 export * from "./CountAggregationPricingMetricInterface.mjs";
@@ -36,4 +37,5 @@ export * from "./SubjectResource.mjs";
 export * from "./SubscriptionResource.mjs";
 export * from "./SumAggregationPricingMetricInterface.mjs";
 export * from "./SumAggregationPricingMetricResource.mjs";
+export * from "./UsageDataForRate.mjs";
 export * from "./ValidationError.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.0";
+export const SDK_VERSION = "0.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lark-billing",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "private": false,
     "repository": "github:fern-demo/lark-ts-sdk",
     "type": "commonjs",

package/reference.md

@@ -303,10 +303,10 @@ await client.rateCards.getRateCard("rate_card_id");
 
 ```typescript
 await client.usageEvents.createUsageEvent({
-    idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+    idempotency_key: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
     event_name: "compute_hours",
     subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
-    timestamp: "2025-10-31T20:29:47Z",
+    timestamp: "2025-11-03T18:37:02Z",
     data: {
         compute_hours: 100,
         instance_type: "t2.micro",