lark-billing 0.5.0 → 0.7.0

package/src/resources/rate-catalogs.ts

@@ -0,0 +1,597 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as InvoicesAPI from './invoices';
+import * as RateCardsAPI from './rate-cards';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class RateCatalogs extends APIResource {
+  /**
+   * Create Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const rateCatalog = await client.rateCatalogs.create({
+   *   description: 'My Catalog Description',
+   *   name: 'My Catalog',
+   * });
+   * ```
+   */
+  create(body: RateCatalogCreateParams, options?: RequestOptions): APIPromise<RateCatalogCreateResponse> {
+    return this._client.post('/rate-catalogs', { body, ...options });
+  }
+
+  /**
+   * Get Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const rateCatalog = await client.rateCatalogs.retrieve(
+   *   'rate_catalog_id',
+   * );
+   * ```
+   */
+  retrieve(rateCatalogID: string, options?: RequestOptions): APIPromise<RateCatalogRetrieveResponse> {
+    return this._client.get(path`/rate-catalogs/${rateCatalogID}`, options);
+  }
+
+  /**
+   * List Rate Catalogs
+   *
+   * @example
+   * ```ts
+   * const rateCatalogs = await client.rateCatalogs.list();
+   * ```
+   */
+  list(
+    query: RateCatalogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogListResponse> {
+    return this._client.get('/rate-catalogs', { query, ...options });
+  }
+
+  /**
+   * Add Rates To Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const response = await client.rateCatalogs.addRates(
+   *   'rate_catalog_id',
+   *   { billing_interval: 'monthly' },
+   * );
+   * ```
+   */
+  addRates(
+    rateCatalogID: string,
+    body: RateCatalogAddRatesParams,
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogAddRatesResponse> {
+    return this._client.post(path`/rate-catalogs/${rateCatalogID}/add_rates`, { body, ...options });
+  }
+
+  /**
+   * List Rates In Catalog
+   *
+   * @example
+   * ```ts
+   * const response = await client.rateCatalogs.listRates(
+   *   'rate_catalog_id',
+   * );
+   * ```
+   */
+  listRates(
+    rateCatalogID: string,
+    query: RateCatalogListRatesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogListRatesResponse> {
+    return this._client.get(path`/rate-catalogs/${rateCatalogID}/rates`, { query, ...options });
+  }
+}
+
+export interface RateCatalogCreateResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogRetrieveResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogListResponse {
+  has_more: boolean;
+
+  rate_catalogs: Array<RateCatalogListResponse.RateCatalog>;
+}
+
+export namespace RateCatalogListResponse {
+  export interface RateCatalog {
+    id: string;
+
+    description: string;
+
+    name: string;
+
+    rate_count: number;
+  }
+}
+
+export interface RateCatalogAddRatesResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogListRatesResponse {
+  has_more: boolean;
+
+  rates: Array<RateCatalogListRatesResponse.Rate>;
+}
+
+export namespace RateCatalogListRatesResponse {
+  export interface Rate {
+    id: string;
+
+    interval: 'monthly' | 'yearly';
+
+    rate_catalog_id: string;
+
+    type: 'fixed' | 'usage_based';
+
+    fixed?: Rate.Fixed | null;
+
+    usage_based?: Rate.SimpleUsageBasedRateTypedDict | Rate.DimensionalUsageBasedRateTypedDict | null;
+  }
+
+  export namespace Rate {
+    export interface Fixed {
+      id: string;
+
+      code: string | null;
+
+      credit_grants: Array<Fixed.CreditGrant>;
+
+      description: string | null;
+
+      name: string;
+
+      price: Fixed.FlatPriceTypedDict | Fixed.PackagePriceTypedDict;
+
+      quantity_code: string | null;
+    }
+
+    export namespace Fixed {
+      export interface CreditGrant {
+        amount: InvoicesAPI.AmountOutput;
+
+        expiration:
+          | CreditGrant.CreditGrantDurationExpirationModel
+          | CreditGrant.CreditGrantDateTimeExpirationModel
+          | null;
+
+        metadata: { [key: string]: string };
+
+        name: string;
+
+        schedule:
+          | CreditGrant.CreditGrantScheduleOneTimeModel
+          | CreditGrant.CreditGrantScheduleRateCycleStartModel
+          | null;
+
+        subject_granting_config: CreditGrant.SubjectGrantingConfig | null;
+      }
+
+      export namespace CreditGrant {
+        export interface CreditGrantDurationExpirationModel {
+          duration: number;
+
+          unit: 'hours' | 'days' | 'weeks' | 'months' | 'years';
+
+          expiration_type?: 'duration';
+        }
+
+        export interface CreditGrantDateTimeExpirationModel {
+          date: string;
+
+          expiration_type?: 'date';
+        }
+
+        export interface CreditGrantScheduleOneTimeModel {
+          scheduled_at: string;
+
+          schedule_type?: 'one_time';
+        }
+
+        export interface CreditGrantScheduleRateCycleStartModel {
+          rate_cycle_start_at: string;
+
+          schedule_type?: 'rate_cycle_start';
+        }
+
+        export interface SubjectGrantingConfig {
+          apply_to_children: boolean;
+
+          apply_to_self: boolean;
+        }
+      }
+
+      export interface FlatPriceTypedDict {
+        amount: FlatPriceTypedDict.Amount;
+
+        price_type: 'flat';
+      }
+
+      export namespace FlatPriceTypedDict {
+        export interface Amount {
+          currency_code: string;
+
+          value: string;
+        }
+      }
+
+      export interface PackagePriceTypedDict {
+        amount: PackagePriceTypedDict.Amount;
+
+        package_units: number;
+
+        price_type: 'package';
+
+        rounding_behavior: 'round_up' | 'round_down';
+      }
+
+      export namespace PackagePriceTypedDict {
+        export interface Amount {
+          currency_code: string;
+
+          value: string;
+        }
+      }
+    }
+
+    export interface SimpleUsageBasedRateTypedDict {
+      id: string;
+
+      code: string;
+
+      description: string | null;
+
+      included_units: number;
+
+      name: string;
+
+      price:
+        | SimpleUsageBasedRateTypedDict.FlatPriceTypedDict
+        | SimpleUsageBasedRateTypedDict.PackagePriceTypedDict;
+
+      pricing_metric_id: string;
+
+      usage_based_rate_type: 'simple';
+    }
+
+    export namespace SimpleUsageBasedRateTypedDict {
+      export interface FlatPriceTypedDict {
+        amount: FlatPriceTypedDict.Amount;
+
+        price_type: 'flat';
+      }
+
+      export namespace FlatPriceTypedDict {
+        export interface Amount {
+          currency_code: string;
+
+          value: string;
+        }
+      }
+
+      export interface PackagePriceTypedDict {
+        amount: PackagePriceTypedDict.Amount;
+
+        package_units: number;
+
+        price_type: 'package';
+
+        rounding_behavior: 'round_up' | 'round_down';
+      }
+
+      export namespace PackagePriceTypedDict {
+        export interface Amount {
+          currency_code: string;
+
+          value: string;
+        }
+      }
+    }
+
+    export interface DimensionalUsageBasedRateTypedDict {
+      id: string;
+
+      code: string;
+
+      description: string | null;
+
+      dimensions: Array<DimensionalUsageBasedRateTypedDict.Dimension>;
+
+      included_units: number;
+
+      name: string;
+
+      pricing_matrix: DimensionalUsageBasedRateTypedDict.PricingMatrix;
+
+      pricing_metric_id: string;
+
+      usage_based_rate_type: 'dimensional';
+    }
+
+    export namespace DimensionalUsageBasedRateTypedDict {
+      export interface Dimension {
+        description: string | null;
+
+        key: string;
+
+        values: Array<string>;
+      }
+
+      export interface PricingMatrix {
+        cells: Array<PricingMatrix.Cell>;
+      }
+
+      export namespace PricingMatrix {
+        export interface Cell {
+          dimension_coordinates: { [key: string]: string };
+
+          price: Cell.FlatPriceTypedDict | Cell.PackagePriceTypedDict;
+        }
+
+        export namespace Cell {
+          export interface FlatPriceTypedDict {
+            amount: FlatPriceTypedDict.Amount;
+
+            price_type: 'flat';
+          }
+
+          export namespace FlatPriceTypedDict {
+            export interface Amount {
+              currency_code: string;
+
+              value: string;
+            }
+          }
+
+          export interface PackagePriceTypedDict {
+            amount: PackagePriceTypedDict.Amount;
+
+            package_units: number;
+
+            price_type: 'package';
+
+            rounding_behavior: 'round_up' | 'round_down';
+          }
+
+          export namespace PackagePriceTypedDict {
+            export interface Amount {
+              currency_code: string;
+
+              value: string;
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+export interface RateCatalogCreateParams {
+  /**
+   * The description of the catalog.
+   */
+  description: string;
+
+  /**
+   * The name of the catalog.
+   */
+  name: string;
+}
+
+export interface RateCatalogListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export interface RateCatalogAddRatesParams {
+  /**
+   * How often the customer will be billed for these rates.
+   */
+  billing_interval: 'monthly' | 'yearly';
+
+  /**
+   * The fixed rate to create in the catalog.
+   */
+  fixed_rates?: Array<RateCatalogAddRatesParams.FixedRate>;
+
+  /**
+   * The usage based rates to create in the catalog.
+   */
+  usage_based_rates?: Array<
+    | RateCatalogAddRatesParams.CreateSimpleUsageBasedRateRequest
+    | RateCatalogAddRatesParams.CreateDimensionalUsageBasedRateRequest
+  >;
+}
+
+export namespace RateCatalogAddRatesParams {
+  export interface FixedRate {
+    /**
+     * Code of this rate to be used for setting quantity and price multipliers. This
+     * code must be unique within the rate card.
+     */
+    code: string;
+
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+  }
+
+  export interface CreateSimpleUsageBasedRateRequest {
+    /**
+     * Code of this rate to be used for price multipliers. This code must be unique
+     * within the rate card.
+     */
+    code: string;
+
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+
+    /**
+     * The ID of the pricing metric to use for this rate.
+     */
+    pricing_metric_id: string;
+
+    usage_based_rate_type: 'simple';
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+
+    /**
+     * The number of units included in the rate before the price is applied.
+     */
+    included_units?: number;
+  }
+
+  export interface CreateDimensionalUsageBasedRateRequest {
+    /**
+     * Code of this rate to be used for price multipliers. This code must be unique
+     * within the rate card.
+     */
+    code: string;
+
+    /**
+     * The dimensions of the rate.
+     */
+    dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
+
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
+
+    /**
+     * The ID of the pricing metric to use for this rate.
+     */
+    pricing_metric_id: string;
+
+    usage_based_rate_type: 'dimensional';
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+
+    /**
+     * The number of units included in the rate before the price is applied.
+     */
+    included_units?: number;
+  }
+
+  export namespace CreateDimensionalUsageBasedRateRequest {
+    export interface Dimension {
+      /**
+       * The name of the dimension. This is used to identify the dimension in the pricing
+       * matrix.
+       */
+      key: string;
+
+      /**
+       * A list of possible values for the dimension.
+       */
+      values: Array<string>;
+
+      /**
+       * The description of the dimension.
+       */
+      description?: string | null;
+    }
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    export interface PricingMatrix {
+      cells: Array<PricingMatrix.Cell>;
+    }
+
+    export namespace PricingMatrix {
+      export interface Cell {
+        /**
+         * A key-value mapping of dimension keys and values to identify the price for a
+         * given set of dimension values.
+         */
+        dimension_coordinates: { [key: string]: string };
+
+        /**
+         * The price for the cell.
+         */
+        price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+      }
+    }
+  }
+}
+
+export interface RateCatalogListRatesParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace RateCatalogs {
+  export {
+    type RateCatalogCreateResponse as RateCatalogCreateResponse,
+    type RateCatalogRetrieveResponse as RateCatalogRetrieveResponse,
+    type RateCatalogListResponse as RateCatalogListResponse,
+    type RateCatalogAddRatesResponse as RateCatalogAddRatesResponse,
+    type RateCatalogListRatesResponse as RateCatalogListRatesResponse,
+    type RateCatalogCreateParams as RateCatalogCreateParams,
+    type RateCatalogListParams as RateCatalogListParams,
+    type RateCatalogAddRatesParams as RateCatalogAddRatesParams,
+    type RateCatalogListRatesParams as RateCatalogListRatesParams,
+  };
+}

package/src/resources/subjects.ts

@@ -192,18 +192,18 @@ export interface SubjectUpdateParams {
   /**
    * The email of the subject. Must be a valid email address.
    */
-  email: string | null;
+  email?: string | null;
 
   /**
    * Additional metadata about the subject. You may use this to store any custom data
    * about the subject.
    */
-  metadata: { [key: string]: string } | null;
+  metadata?: { [key: string]: string } | null;
 
   /**
    * The name of the subject. Used for display in the dashboard.
    */
-  name: string | null;
+  name?: string | null;
 }
 
 export interface SubjectListParams {

package/src/resources/subscriptions.ts

@@ -19,7 +19,9 @@ export class Subscriptions extends APIResource {
    *     cancelled_url: 'https://example.com/try-again',
    *     success_url: 'https://example.com/welcome',
    *   },
+   *   fixed_rate_quantities: { seats: '2', addon_storage: '0' },
    *   metadata: {},
+   *   rate_price_multipliers: { seats: '0.5' },
    * });
    * ```
    */
@@ -139,6 +141,11 @@ export interface SubscriptionResource {
    */
   effective_at: string;
 
+  /**
+   * The quantities of the fixed rates of the subscription.
+   */
+  fixed_rate_quantities: { [key: string]: string };
+
   metadata: { [key: string]: string };
 
   /**
@@ -146,6 +153,11 @@ export interface SubscriptionResource {
    */
   rate_card_id: string;
 
+  /**
+   * The price multipliers of the rates of the subscription.
+   */
+  rate_price_multipliers: { [key: string]: string };
+
   /**
    * The status of the subscription.
    */
@@ -293,11 +305,29 @@ export interface SubscriptionCreateParams {
    */
   create_checkout_session?: 'when_required' | 'always';
 
+  /**
+   * The quantities of the fixed rates to use for the subscription. Each quantity
+   * should be specified as a key-value pair, where the key is the `code` of the
+   * fixed rate and the value is the quantity. All fixed rates must have a quantity
+   * specified.
+   */
+  fixed_rate_quantities?: { [key: string]: number | string };
+
   /**
    * Additional metadata about the subscription. You may use this to store any custom
    * data about the subscription.
    */
   metadata?: { [key: string]: string };
+
+  /**
+   * Pricing multipliers to apply to the rate amounts. Each price multiplier should
+   * be specified as a key-value pair, where the key is the `code` of the rate and
+   * the value is the price multiplier. Typically, pricing multipliers are used to
+   * apply a discount to a rate. For example, if a rate is $10 per seat and the price
+   * multiplier for the `seats` rate is 0.5, the discounted rate amount will be $5
+   * per seat.
+   */
+  rate_price_multipliers?: { [key: string]: number | string };
 }
 
 export interface SubscriptionListParams {

package/src/resources/usage-events.ts

@@ -17,9 +17,9 @@ export class UsageEvents extends APIResource {
    *     region: 'us-east-1',
    *   },
    *   event_name: 'job_completed',
-   *   idempotency_key: 'dec98bc7-e75c-4414-9f34-02e98ae9e047',
+   *   idempotency_key: '5ee29f5a-ff4d-4265-8029-bf29e465f5dc',
    *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
-   *   timestamp: '2025-12-14T19:55:29.967956+00:00',
+   *   timestamp: '2026-01-13T22:50:12.390246+00:00',
    * });
    * ```
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.7.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.7.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.7.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.5.0'; // x-release-please-version
+exports.VERSION = '0.7.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map