lark-billing 0.0.8 → 0.0.9

package/README.md

@@ -24,8 +24,8 @@ import { LarkClient } from "lark-billing";
 
 const client = new LarkClient({ apiKey: "YOUR_API_KEY" });
 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/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.0.8",
-                "User-Agent": "lark-billing/0.0.8",
+                "X-Fern-SDK-Version": "0.0.9",
+                "User-Agent": "lark-billing/0.0.9",
                 "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/Client.d.ts

@@ -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/cjs/api/resources/checkout/client/Client.js

@@ -63,8 +63,8 @@ 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/cjs/api/resources/checkout/client/requests/CreateSubscriptionCheckoutSessionRequest.d.ts

@@ -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/cjs/api/resources/customerPortal/client/Client.d.ts

@@ -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/cjs/api/resources/customerPortal/client/Client.js

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

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

@@ -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;
 }

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

@@ -50,7 +50,7 @@ export declare class RateCards {
      *
      * @example
      *     await client.rateCards.createRateCard({
-     *         name: "name",
+     *         name: "Pro Plan",
      *         billing_interval: "monthly"
      *     })
      */

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

@@ -127,7 +127,7 @@ class RateCards {
      *
      * @example
      *     await client.rateCards.createRateCard({
-     *         name: "name",
+     *         name: "Pro Plan",
      *         billing_interval: "monthly"
      *     })
      */

package/dist/cjs/api/resources/rateCards/client/requests/CreateRateCardRequest.d.ts

@@ -5,19 +5,25 @@ import * as Lark from "../../../../index.js";
 /**
  * @example
  *     {
- *         name: "name",
+ *         name: "Pro Plan",
  *         billing_interval: "monthly"
  *     }
  */
 export interface CreateRateCardRequest {
+    /** The name of the rate card displayed to the customer. */
     name: string;
+    /** The description of the rate card displayed to the customer. */
     description?: string;
-    usage_based_rates?: Lark.CreateRateCardRequestUsageBasedRatesItem[];
-    fixed_rates?: Lark.CreateFixedRateRequest[];
+    /** How often the customer will be billed for this rate card. */
     billing_interval: CreateRateCardRequest.BillingInterval;
+    fixed_rates?: Lark.CreateFixedRateRequest[];
+    usage_based_rates?: Lark.CreateRateCardRequestUsageBasedRatesItem[];
     metadata?: Record<string, string>;
 }
 export declare namespace CreateRateCardRequest {
+    /**
+     * How often the customer will be billed for this rate card.
+     */
     type BillingInterval = "monthly" | "yearly";
     const BillingInterval: {
         readonly Monthly: "monthly";

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

@@ -90,7 +90,7 @@ export declare class Subscriptions {
      *
      * @example
      *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
      *     })
      */
     changeSubscriptionRateCard(subscriptionId: string, request: Lark.ChangeSubscriptionRateCardRequest, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;

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

@@ -317,7 +317,7 @@ class Subscriptions {
      *
      * @example
      *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
      *     })
      */
     changeSubscriptionRateCard(subscriptionId, request, requestOptions) {

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

@@ -4,9 +4,10 @@
 /**
  * @example
  *     {
- *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+ *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
  *     }
  */
 export interface ChangeSubscriptionRateCardRequest {
+    /** The ID of the rate card to change the subscription to. */
     rate_card_id: string;
 }

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

@@ -13,9 +13,19 @@
  *     }
  */
 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 | number | boolean;
+    }
 }

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/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/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/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/version.d.ts

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

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.0.9";

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.0.9",
+                "User-Agent": "lark-billing/0.0.9",
                 "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;
 }

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

@@ -50,7 +50,7 @@ export declare class RateCards {
      *
      * @example
      *     await client.rateCards.createRateCard({
-     *         name: "name",
+     *         name: "Pro Plan",
      *         billing_interval: "monthly"
      *     })
      */

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

@@ -91,7 +91,7 @@ export class RateCards {
      *
      * @example
      *     await client.rateCards.createRateCard({
-     *         name: "name",
+     *         name: "Pro Plan",
      *         billing_interval: "monthly"
      *     })
      */

package/dist/esm/api/resources/rateCards/client/requests/CreateRateCardRequest.d.mts

@@ -5,19 +5,25 @@ import * as Lark from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         name: "name",
+ *         name: "Pro Plan",
  *         billing_interval: "monthly"
  *     }
  */
 export interface CreateRateCardRequest {
+    /** The name of the rate card displayed to the customer. */
     name: string;
+    /** The description of the rate card displayed to the customer. */
     description?: string;
-    usage_based_rates?: Lark.CreateRateCardRequestUsageBasedRatesItem[];
-    fixed_rates?: Lark.CreateFixedRateRequest[];
+    /** How often the customer will be billed for this rate card. */
     billing_interval: CreateRateCardRequest.BillingInterval;
+    fixed_rates?: Lark.CreateFixedRateRequest[];
+    usage_based_rates?: Lark.CreateRateCardRequestUsageBasedRatesItem[];
     metadata?: Record<string, string>;
 }
 export declare namespace CreateRateCardRequest {
+    /**
+     * How often the customer will be billed for this rate card.
+     */
     type BillingInterval = "monthly" | "yearly";
     const BillingInterval: {
         readonly Monthly: "monthly";

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

@@ -90,7 +90,7 @@ export declare class Subscriptions {
      *
      * @example
      *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
      *     })
      */
     changeSubscriptionRateCard(subscriptionId: string, request: Lark.ChangeSubscriptionRateCardRequest, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;

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

@@ -281,7 +281,7 @@ export class Subscriptions {
      *
      * @example
      *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
      *     })
      */
     changeSubscriptionRateCard(subscriptionId, request, requestOptions) {

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

@@ -4,9 +4,10 @@
 /**
  * @example
  *     {
- *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB"
+ *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
  *     }
  */
 export interface ChangeSubscriptionRateCardRequest {
+    /** The ID of the rate card to change the subscription to. */
     rate_card_id: string;
 }

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

@@ -13,9 +13,19 @@
  *     }
  */
 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 | number | boolean;
+    }
 }

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

@@ -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/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/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/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/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lark-billing",
-    "version": "0.0.8",
+    "version": "0.0.9",
     "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,7 +172,7 @@ await client.rateCards.listRateCards({
 
 ```typescript
 await client.rateCards.createRateCard({
-    name: "name",
+    name: "Pro Plan",
     billing_interval: "monthly",
 });
 ```
@@ -593,7 +593,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 
 ```typescript
 await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
-    rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+    rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g",
 });
 ```