lark-billing 0.0.7 → 0.0.8

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

@@ -2,20 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Custom | Lark.Aggregation.Last | Lark.Aggregation.Max | Lark.Aggregation.Sum;
+export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Sum;
 export declare namespace Aggregation {
     interface Count extends Lark.CountAggregationPricingMetricResource {
         aggregation_type: "count";
     }
-    interface Custom extends Lark.CustomPricingMetricResource {
-        aggregation_type: "custom";
-    }
-    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/esm/api/types/{CreateFixedRateInterface.d.mts → CreateFixedRateRequest.d.mts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface CreateFixedRateInterface {
+export interface CreateFixedRateRequest {
     name?: string;
     description?: string;
     price: Lark.Price;

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

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

package/dist/esm/api/types/{CreateSimpleUsageBasedRateInterface.d.mts → CreateSimpleUsageBasedRateRequest.d.mts}

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface CreateSimpleUsageBasedRateInterface {
-    usage_based_rate_type?: "simple";
+export interface CreateSimpleUsageBasedRateRequest {
     name?: string;
     description?: string;
     price: Lark.Price;
     included_units?: number;
+    /** The ID of the pricing metric to use for this rate. */
     pricing_metric_id: string;
 }

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

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

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface CreateSubjectResponse {
+    /** The ID of the subject. */
     id: string;
+    /** The ID of the subject in your system. You may pass it to the API in place of the subject ID. */
     external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata: Record<string, string>;
+    /** The date and time the subject was created. */
     created_at: string;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface InvoiceLineItemResource {
+    amount: Lark.Amount;
+    description: string;
+    quantity: number;
+    price_in_unit_amount: Lark.Amount;
+}

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

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

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface InvoiceResource {
+    id: string;
+    merchant_id: string;
+    bill_id?: string;
+    total_amount: Lark.Amount;
+    subject_id: string;
+    created_at: string;
+    status: InvoiceResource.Status;
+    hosted_url?: string;
+    line_items: Lark.InvoiceLineItemResource[];
+}
+export declare namespace InvoiceResource {
+    type Status = "draft" | "open" | "paid" | "uncollectible" | "void";
+    const Status: {
+        readonly Draft: "draft";
+        readonly Open: "open";
+        readonly Paid: "paid";
+        readonly Uncollectible: "uncollectible";
+        readonly Void: "void";
+    };
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var InvoiceResource;
+(function (InvoiceResource) {
+    InvoiceResource.Status = {
+        Draft: "draft",
+        Open: "open",
+        Paid: "paid",
+        Uncollectible: "uncollectible",
+        Void: "void",
+    };
+})(InvoiceResource || (InvoiceResource = {}));

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface ListInvoicesResponse {
+    invoices: Lark.InvoiceResource[];
+    has_more: boolean;
+}

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface ListPricingMetricsResponse {
+    pricing_metrics: Lark.PricingMetricResource[];
+    has_more: boolean;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PeriodResource {
+    inclusive_start?: boolean;
+    inclusive_end?: boolean;
+    start: string;
+    end: string;
+}

package/dist/esm/api/types/PeriodResource.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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface PricingMetricResource {
+    id: string;
+    name: string;
+    event_name: string;
+    aggregation: Lark.Aggregation;
+    unit: string;
+}

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

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

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

@@ -4,8 +4,6 @@
 import * as Lark from "../index.mjs";
 export interface SimpleUsageBasedRateInterface {
     id: string;
-    /** Code of this rate to be used for overrides and external reference. */
-    code: string;
     name: string;
     description: string;
     price: Lark.Price;

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SubjectResource {
+    /** The ID of the subject. */
     id: string;
+    /** The ID of the subject in your system. You may pass it to the API in place of the subject ID. */
     external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata: Record<string, string>;
+    /** The date and time the subject was created. */
     created_at: string;
 }

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

@@ -1,19 +1,23 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Lark from "../index.mjs";
 export interface SubscriptionResource {
     id: string;
     subject_id: string;
     rate_card_id: string;
     effective_at: string;
     cycles_next_at?: string;
-    metadata?: Record<string, string | undefined>;
+    current_period?: Lark.PeriodResource;
+    metadata: Record<string, string>;
     status: SubscriptionResource.Status;
+    cancels_at_end_of_cycle: boolean;
 }
 export declare namespace SubscriptionResource {
-    type Status = "active" | "cancelled";
+    type Status = "active" | "cancelled" | "paused";
     const Status: {
         readonly Active: "active";
         readonly Cancelled: "cancelled";
+        readonly Paused: "paused";
     };
 }

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

@@ -6,5 +6,6 @@ export var SubscriptionResource;
     SubscriptionResource.Status = {
         Active: "active",
         Cancelled: "cancelled",
+        Paused: "paused",
     };
 })(SubscriptionResource || (SubscriptionResource = {}));

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

@@ -4,25 +4,28 @@ export * from "./CountAggregationPricingMetricInterface.mjs";
 export * from "./CountAggregationPricingMetricResource.mjs";
 export * from "./CreateCustomerPortalSessionResponse.mjs";
 export * from "./Price.mjs";
-export * from "./CreateFixedRateInterface.mjs";
+export * from "./CreateFixedRateRequest.mjs";
 export * from "./Aggregation.mjs";
 export * from "./CreatePricingMetricResponse.mjs";
-export * from "./CreateSimpleUsageBasedRateInterface.mjs";
+export * from "./CreateSimpleUsageBasedRateRequest.mjs";
 export * from "./CreateSubjectResponse.mjs";
 export * from "./CreateSubscriptionCheckoutSessionResponse.mjs";
 export * from "./CreateUsageEventSummaryResponse.mjs";
-export * from "./CustomPricingMetricResource.mjs";
 export * from "./FixedRateInterface.mjs";
 export * from "./FlatPrice.mjs";
 export * from "./GetPricingMetricResponse.mjs";
 export * from "./HttpValidationError.mjs";
-export * from "./LastAggregationPricingMetricResource.mjs";
+export * from "./InvoiceLineItemResource.mjs";
+export * from "./InvoiceResource.mjs";
+export * from "./ListInvoicesResponse.mjs";
+export * from "./ListPricingMetricsResponse.mjs";
 export * from "./ListRateCardsResponse.mjs";
 export * from "./ListSubjectsResponse.mjs";
 export * from "./ListSubscriptionsResponse.mjs";
-export * from "./MaxAggregationPricingMetricResource.mjs";
 export * from "./PackagePrice.mjs";
 export * from "./Period.mjs";
+export * from "./PeriodResource.mjs";
+export * from "./PricingMetricResource.mjs";
 export * from "./RateCardResourceUsageBasedRatesItem.mjs";
 export * from "./RateCardResource.mjs";
 export * from "./SimpleUsageBasedRateInterface.mjs";

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

@@ -4,25 +4,28 @@ export * from "./CountAggregationPricingMetricInterface.mjs";
 export * from "./CountAggregationPricingMetricResource.mjs";
 export * from "./CreateCustomerPortalSessionResponse.mjs";
 export * from "./Price.mjs";
-export * from "./CreateFixedRateInterface.mjs";
+export * from "./CreateFixedRateRequest.mjs";
 export * from "./Aggregation.mjs";
 export * from "./CreatePricingMetricResponse.mjs";
-export * from "./CreateSimpleUsageBasedRateInterface.mjs";
+export * from "./CreateSimpleUsageBasedRateRequest.mjs";
 export * from "./CreateSubjectResponse.mjs";
 export * from "./CreateSubscriptionCheckoutSessionResponse.mjs";
 export * from "./CreateUsageEventSummaryResponse.mjs";
-export * from "./CustomPricingMetricResource.mjs";
 export * from "./FixedRateInterface.mjs";
 export * from "./FlatPrice.mjs";
 export * from "./GetPricingMetricResponse.mjs";
 export * from "./HttpValidationError.mjs";
-export * from "./LastAggregationPricingMetricResource.mjs";
+export * from "./InvoiceLineItemResource.mjs";
+export * from "./InvoiceResource.mjs";
+export * from "./ListInvoicesResponse.mjs";
+export * from "./ListPricingMetricsResponse.mjs";
 export * from "./ListRateCardsResponse.mjs";
 export * from "./ListSubjectsResponse.mjs";
 export * from "./ListSubscriptionsResponse.mjs";
-export * from "./MaxAggregationPricingMetricResource.mjs";
 export * from "./PackagePrice.mjs";
 export * from "./Period.mjs";
+export * from "./PeriodResource.mjs";
+export * from "./PricingMetricResource.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.7";
+export declare const SDK_VERSION = "0.0.8";

package/dist/esm/version.mjs

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

package/package.json

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

package/reference.md

@@ -18,7 +18,7 @@
 await client.checkout.createSubscriptionCheckoutSession({
     subject_id: "subject_id",
     rate_card_id: "rate_card_id",
-    callback_url: "callback_url",
+    success_callback_url: "https://example.com/callback",
 });
 ```
 
@@ -438,8 +438,8 @@ await client.subscriptions.listSubscriptions({
 
 ```typescript
 await client.subscriptions.createSubscription({
-    rate_card_id: "rate_card_id",
-    subject_id: "subject_id",
+    rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
 });
 ```
 
@@ -523,6 +523,120 @@ await client.subscriptions.getSubscription("subscription_id");
 </dl>
 </details>
 
+<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">cancelSubscription</a>(subscriptionId, { ...params }) -> Lark.SubscriptionResource</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.subscriptions.cancelSubscription("subscription_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**subscriptionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Lark.CancelSubscriptionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Subscriptions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">changeSubscriptionRateCard</a>(subscriptionId, { ...params }) -> Lark.SubscriptionResource</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
+    rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**subscriptionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Lark.ChangeSubscriptionRateCardRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Subscriptions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Subjects
 
 <details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">listSubjects</a>({ ...params }) -> Lark.ListSubjectsResponse</code></summary>
@@ -778,6 +892,56 @@ await client.subjects.deleteSubject("subject_id");
 
 ## PricingMetrics
 
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">listPricingMetrics</a>({ ...params }) -> Lark.ListPricingMetricsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pricingMetrics.listPricingMetrics({
+    limit: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Lark.ListPricingMetricsPricingMetricsGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PricingMetrics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.CreatePricingMetricResponse</code></summary>
 <dl>
 <dd>
@@ -930,3 +1094,57 @@ await client.customerAccess.getBillingState("subject_id");
 </dd>
 </dl>
 </details>
+
+## Invoices
+
+<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">listInvoices</a>({ ...params }) -> Lark.ListInvoicesResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.invoices.listInvoices({
+    subject_id: "subject_id",
+    limit: 1,
+    offset: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Lark.ListInvoicesInvoicesGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Invoices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CustomPricingMetricResource {
-    sql: string;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface LastAggregationPricingMetricResource {
-    value_field: string;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface MaxAggregationPricingMetricResource {
-    value_field: string;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CustomPricingMetricResource {
-    sql: string;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface LastAggregationPricingMetricResource {
-    value_field: string;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface MaxAggregationPricingMetricResource {
-    value_field: string;
-}