lark-billing 0.0.8 → 0.1.0

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

@@ -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/esm/api/types/CountAggregationPricingMetricInterface.d.mts

@@ -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/esm/api/types/CreateCustomerPortalSessionResponse.d.mts

@@ -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/esm/api/types/CreateFixedRateRequest.d.mts

@@ -3,7 +3,9 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/CreateSimpleUsageBasedRateRequest.d.mts

@@ -3,9 +3,12 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/CreateSubscriptionCheckoutSessionResponse.d.mts

@@ -3,7 +3,10 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/CustomAggregationPricingMetricInterface.d.mts

@@ -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/esm/api/types/FixedRateInterface.d.mts

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

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

@@ -3,17 +3,25 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/LastAggregationPricingMetricInterface.d.mts

@@ -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/esm/api/types/LastAggregationPricingMetricResource.d.mts

@@ -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/esm/api/types/LastAggregationPricingMetricResource.mjs

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

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

@@ -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/esm/api/types/MaxAggregationPricingMetricInterface.mjs

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

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

@@ -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/esm/api/types/MaxAggregationPricingMetricResource.mjs

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

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

@@ -3,9 +3,14 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/PricingMetricSummaryResource.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+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/esm/api/types/PricingMetricSummaryResource.mjs

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

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

@@ -3,13 +3,20 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/SimpleUsageBasedRateInterface.d.mts

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

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

@@ -3,17 +3,28 @@
  */
 import * as Lark from "../index.mjs";
 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/esm/api/types/SumAggregationPricingMetricInterface.d.mts

@@ -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/esm/api/types/SumAggregationPricingMetricResource.d.mts

@@ -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/esm/api/types/index.d.mts

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

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

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

package/reference.md

@@ -16,8 +16,8 @@
 
 ```typescript
 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",
 });
 ```
@@ -70,7 +70,7 @@ await client.checkout.createSubscriptionCheckoutSession({
 
 ```typescript
 await client.customerPortal.createCustomerPortalSession({
-    subject_id: "subject_id",
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
 });
 ```
 
@@ -172,8 +172,38 @@ await client.rateCards.listRateCards({
 
 ```typescript
 await client.rateCards.createRateCard({
-    name: "name",
+    name: "Pro Plan",
+    description: "For production applications with moderate usage.",
     billing_interval: "monthly",
+    fixed_rates: [
+        {
+            name: "Base Rate",
+            price: {
+                price_type: "flat",
+                amount: {
+                    value: "2500",
+                    currency_code: "usd",
+                },
+            },
+        },
+    ],
+    usage_based_rates: [
+        {
+            usage_based_rate_type: "simple",
+            name: "name",
+            price: {
+                price_type: "flat",
+                amount: {
+                    value: "2500",
+                    currency_code: "usd",
+                },
+            },
+            pricing_metric_id: "pricing_metric_id",
+        },
+    ],
+    metadata: {
+        key: "value",
+    },
 });
 ```
 
@@ -273,11 +303,14 @@ await client.rateCards.getRateCard("rate_card_id");
 
 ```typescript
 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",
     },
 });
 ```
@@ -314,62 +347,6 @@ await client.usageEvents.createUsageEvent({
 </dl>
 </details>
 
-<details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEventSummary</a>({ ...params }) -> Lark.CreateUsageEventSummaryResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-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",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Lark.CreateUsageEventSummaryRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `UsageEvents.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Subscriptions
 
 <details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">listSubscriptions</a>({ ...params }) -> Lark.ListSubscriptionsResponse</code></summary>
@@ -593,7 +570,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 
 ```typescript
 await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-    rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+    rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g",
 });
 ```
 
@@ -703,7 +680,14 @@ await client.subjects.listSubjects({
 <dd>
 
 ```typescript
-await client.subjects.createSubject();
+await client.subjects.createSubject({
+    external_id: "user_1234567890",
+    name: "John Doe",
+    email: "john.doe@example.com",
+    metadata: {
+        key: "value",
+    },
+});
 ```
 
 </dd>
@@ -942,7 +926,7 @@ await client.pricingMetrics.listPricingMetrics({
 </dl>
 </details>
 
-<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.CreatePricingMetricResponse</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.PricingMetricResource</code></summary>
 <dl>
 <dd>
 
@@ -956,12 +940,13 @@ await client.pricingMetrics.listPricingMetrics({
 
 ```typescript
 await client.pricingMetrics.createPricingMetric({
-    name: "name",
-    event_name: "event_name",
+    name: "Compute Hours",
+    event_name: "job_completed",
     aggregation: {
-        aggregation_type: "count",
+        aggregation_type: "sum",
+        value_field: "value_field",
     },
-    unit: "unit",
+    unit: "hours",
 });
 ```
 
@@ -997,7 +982,7 @@ await client.pricingMetrics.createPricingMetric({
 </dl>
 </details>
 
-<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">getPricingMetric</a>(pricingMetricId) -> Lark.GetPricingMetricResponse</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">getPricingMetric</a>(pricingMetricId) -> Lark.PricingMetricResource</code></summary>
 <dl>
 <dd>
 
@@ -1045,6 +1030,68 @@ await client.pricingMetrics.getPricingMetric("pricing_metric_id");
 </dl>
 </details>
 
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetricSummary</a>(pricingMetricId, { ...params }) -> Lark.PricingMetricSummaryResource</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pricingMetrics.createPricingMetricSummary("pricing_metric_id", {
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+    period: {
+        start: "2025-10-01T00:00:00Z",
+        end: "2025-11-01T00:00:00Z",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**pricingMetricId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Lark.CreatePricingMetricSummaryRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PricingMetrics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## CustomerAccess
 
 <details><summary><code>client.customerAccess.<a href="/src/api/resources/customerAccess/client/Client.ts">getBillingState</a>(subjectId) -> Lark.BillingStateResponse</code></summary>