@metronome/sdk 0.3.0 → 1.0.0

package/src/resources/v1/customers/index.ts

@@ -4,40 +4,35 @@ export {
   Alerts,
   type CustomerAlert,
   type AlertRetrieveResponse,
-  type AlertListResponse,
   type AlertRetrieveParams,
   type AlertListParams,
   type AlertResetParams,
-} from "./alerts.js";
+  type CustomerAlertsCursorPageWithoutLimit,
+} from './alerts';
 export {
   BillingConfig,
   type BillingConfigRetrieveResponse,
   type BillingConfigCreateParams,
   type BillingConfigRetrieveParams,
   type BillingConfigDeleteParams,
-} from "./billing-config.js";
+} from './billing-config';
 export {
   Commits,
   type CommitCreateResponse,
-  type CommitListResponse,
   type CommitUpdateEndDateResponse,
   type CommitCreateParams,
   type CommitListParams,
   type CommitUpdateEndDateParams,
-} from "./commits.js";
+} from './commits';
 export {
   Credits,
   type CreditCreateResponse,
-  type CreditListResponse,
   type CreditUpdateEndDateResponse,
   type CreditCreateParams,
   type CreditListParams,
   type CreditUpdateEndDateParams,
-} from "./credits.js";
+} from './credits';
 export {
-  CustomerDetailsCursorPage,
-  CustomerListBillableMetricsResponsesCursorPage,
-  CustomerListCostsResponsesCursorPage,
   Customers,
   type Customer,
   type CustomerDetail,
@@ -47,6 +42,7 @@ export {
   type CustomerListBillableMetricsResponse,
   type CustomerListCostsResponse,
   type CustomerPreviewEventsResponse,
+  type CustomerRetrieveBillingConfigurationsResponse,
   type CustomerSetNameResponse,
   type CustomerCreateParams,
   type CustomerRetrieveParams,
@@ -55,13 +51,16 @@ export {
   type CustomerListBillableMetricsParams,
   type CustomerListCostsParams,
   type CustomerPreviewEventsParams,
+  type CustomerRetrieveBillingConfigurationsParams,
+  type CustomerSetBillingConfigurationsParams,
   type CustomerSetIngestAliasesParams,
   type CustomerSetNameParams,
   type CustomerUpdateConfigParams,
-} from "./customers.js";
+  type CustomerDetailsCursorPage,
+  type CustomerListBillableMetricsResponsesCursorPage,
+  type CustomerListCostsResponsesCursorPage,
+} from './customers';
 export {
-  InvoicesCursorPage,
-  InvoiceListBreakdownsResponsesCursorPage,
   Invoices,
   type Invoice,
   type InvoiceRetrieveResponse,
@@ -71,16 +70,16 @@ export {
   type InvoiceListParams,
   type InvoiceAddChargeParams,
   type InvoiceListBreakdownsParams,
-} from "./invoices.js";
+  type InvoicesCursorPage,
+  type InvoiceListBreakdownsResponsesCursorPage,
+} from './invoices';
 export {
   NamedSchedules,
   type NamedScheduleRetrieveResponse,
   type NamedScheduleRetrieveParams,
   type NamedScheduleUpdateParams,
-} from "./named-schedules.js";
+} from './named-schedules';
 export {
-  PlanListResponsesCursorPage,
-  PlanListPriceAdjustmentsResponsesCursorPage,
   Plans,
   type PlanListResponse,
   type PlanAddResponse,
@@ -90,4 +89,6 @@ export {
   type PlanAddParams,
   type PlanEndParams,
   type PlanListPriceAdjustmentsParams,
-} from "./plans.js";
+  type PlanListResponsesCursorPage,
+  type PlanListPriceAdjustmentsResponsesCursorPage,
+} from './plans';

package/src/resources/v1/customers/invoices.ts

@@ -1,13 +1,54 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
-import * as Shared from "../../shared.js";
-import { CursorPage, type CursorPageParams } from "../../../pagination.js";
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Invoices extends APIResource {
   /**
-   * Fetch a specific invoice for a given customer.
+   * Retrieve detailed information for a specific invoice by its unique identifier.
+   * This endpoint returns comprehensive invoice data including line items, applied
+   * credits, totals, and billing period details for both finalized and draft
+   * invoices.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Display historical invoice details in customer-facing dashboards or billing
+   *   portals.
+   * - Retrieve current month draft invoices to show customers their month-to-date
+   *   spend.
+   * - Access finalized invoices for historical billing records and payment
+   *   reconciliation.
+   * - Validate customer pricing and credit applications for customer support
+   *   queries.
+   *
+   * ### Key response fields:
+   *
+   * Invoice status (DRAFT, FINALIZED, VOID) Billing period start and end dates Total
+   * amount and amount due after credits Detailed line items broken down by:
+   *
+   * - Customer and contract information
+   * - Invoice line item type
+   * - Product/service name and ID
+   * - Quantity consumed
+   * - Unit and total price
+   * - Time period for usage-based charges
+   * - Applied credits or prepaid commitments
+   *
+   * ### Usage guidelines:
+   *
+   * - Draft invoices update in real-time as usage is reported and may change before
+   *   finalization
+   * - The response includes both usage-based line items (e.g., API calls, data
+   *   processed) and scheduled charges (e.g., monthly subscriptions, commitment
+   *   fees)
+   * - Credit and commitment applications are shown as separate line items with
+   *   negative amounts
+   * - For voided invoices, the response will indicate VOID status but retain all
+   *   original line item details
    *
    * @example
    * ```ts
@@ -19,17 +60,58 @@ export class Invoices extends APIResource {
    * );
    * ```
    */
-  retrieve(
-    params: InvoiceRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InvoiceRetrieveResponse> {
+  retrieve(params: InvoiceRetrieveParams, options?: RequestOptions): APIPromise<InvoiceRetrieveResponse> {
     const { customer_id, invoice_id, ...query } = params;
-    return this._client.get(`/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
+    return this._client.get(path`/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
   }
 
   /**
-   * List all invoices for a given customer, optionally filtered by status, date
-   * range, and/or credit type.
+   * Retrieves a paginated list of invoices for a specific customer, with flexible
+   * filtering options to narrow results by status, date range, credit type, and
+   * more. This endpoint provides a comprehensive view of a customer's billing
+   * history and current charges, supporting both real-time billing dashboards and
+   * historical reporting needs.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Display historical invoice details in customer-facing dashboards or billing
+   *   portals.
+   * - Retrieve current month draft invoices to show customers their month-to-date
+   *   spend.
+   * - Access finalized invoices for historical billing records and payment
+   *   reconciliation.
+   * - Validate customer pricing and credit applications for customer support
+   *   queries.
+   * - Generate financial reports by filtering invoices within specific date ranges
+   *
+   * ### Key response fields:
+   *
+   * Array of invoice objects containing:
+   *
+   * - Invoice ID and status (DRAFT, FINALIZED, VOID)
+   * - Invoice type (USAGE, SCHEDULED)
+   * - Billing period start and end dates
+   * - Issue date and due date
+   * - Total amount, subtotal, and amount due
+   * - Applied credits summary
+   * - Contract ID reference
+   * - External billing provider status (if integrated with Stripe, etc.)
+   * - Pagination metadata `next_page` cursor
+   *
+   * ### Usage guidelines:
+   *
+   * - The endpoint returns invoice summaries; use the Get Invoice endpoint for
+   *   detailed line items
+   * - Draft invoices are continuously updated as new usage is reported and will show
+   *   real-time spend
+   * - Results are ordered by creation date descending by default (newest first)
+   * - When filtering by date range, the filter applies to the billing period, not
+   *   the issue date
+   * - For customers with many invoices, implement pagination to ensure all results
+   *   are retrieved External billing provider statuses (like Stripe payment status)
+   *   are included when applicable
+   * - Voided invoices are included in results by default unless filtered out by
+   *   status
    *
    * @example
    * ```ts
@@ -41,12 +123,9 @@ export class Invoices extends APIResource {
    * }
    * ```
    */
-  list(
-    params: InvoiceListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoicesCursorPage, Invoice> {
+  list(params: InvoiceListParams, options?: RequestOptions): PagePromise<InvoicesCursorPage, Invoice> {
     const { customer_id, ...query } = params;
-    return this._client.getAPIList(`/v1/customers/${customer_id}/invoices`, InvoicesCursorPage, {
+    return this._client.getAPIList(path`/v1/customers/${customer_id}/invoices`, CursorPage<Invoice>, {
       query,
       ...options,
     });
@@ -70,20 +149,50 @@ export class Invoices extends APIResource {
    *   });
    * ```
    */
-  addCharge(
-    params: InvoiceAddChargeParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InvoiceAddChargeResponse> {
+  addCharge(params: InvoiceAddChargeParams, options?: RequestOptions): APIPromise<InvoiceAddChargeResponse> {
     const { customer_id, ...body } = params;
-    return this._client.post(`/v1/customers/${customer_id}/addCharge`, { body, ...options });
+    return this._client.post(path`/v1/customers/${customer_id}/addCharge`, { body, ...options });
   }
 
   /**
-   * List daily or hourly invoice breakdowns for a given customer, optionally
-   * filtered by status, date range, and/or credit type. Important considerations:
+   * Retrieve granular time-series breakdowns of invoice data at hourly or daily
+   * intervals. This endpoint transforms standard invoices into detailed timelines,
+   * enabling you to track usage patterns, identify consumption spikes, and provide
+   * customers with transparency into their billing details throughout the billing
+   * period.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Build usage analytics dashboards showing daily or hourly consumption trends
+   * - Identify peak usage periods for capacity planning and cost optimization
+   * - Generate detailed billing reports for finance teams and customer success
+   * - Troubleshoot billing disputes by examining usage patterns at specific times
+   * - Power real-time cost monitoring and alerting systems
+   *
+   * ### Key response fields:
+   *
+   * An array of BreakdownInvoice objects, each containing:
    *
-   * - If we receive backdated usage after an invoice has been finalized, the
-   *   backdated usage will be included in the response and usage numbers may differ.
+   * - All standard invoice fields (ID, customer, commit, line items, totals, status)
+   * - Line items with quantities and costs for that specific period
+   * - `breakdown_start_timestamp`: Start of the specific time window
+   * - `breakdown_end_timestamp`: End of the specific time window
+   * - `next_page`: Pagination cursor for large result sets
+   *
+   * ### Usage guidelines:
+   *
+   * - Time granularity: Set `window_size` to hour or day based on your analysis
+   *   needs
+   * - Response limits: Daily breakdowns return up to 35 days; hourly breakdowns
+   *   return up to 24 hours per request
+   * - Date filtering: Use `starting_on` and `ending_before` to focus on specific
+   *   periods
+   * - Performance: For large date ranges, use pagination to retrieve all data
+   *   efficiently
+   * - Backdated usage: If usage events arrive after invoice finalization, breakdowns
+   *   will reflect the updated usage
+   * - Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude
+   *   periods with no usage
    *
    * @example
    * ```ts
@@ -101,20 +210,20 @@ export class Invoices extends APIResource {
    */
   listBreakdowns(
     params: InvoiceListBreakdownsParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse> {
+    options?: RequestOptions,
+  ): PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse> {
     const { customer_id, ...query } = params;
     return this._client.getAPIList(
-      `/v1/customers/${customer_id}/invoices/breakdowns`,
-      InvoiceListBreakdownsResponsesCursorPage,
+      path`/v1/customers/${customer_id}/invoices/breakdowns`,
+      CursorPage<InvoiceListBreakdownsResponse>,
       { query, ...options },
     );
   }
 }
 
-export class InvoicesCursorPage extends CursorPage<Invoice> {}
+export type InvoicesCursorPage = CursorPage<Invoice>;
 
-export class InvoiceListBreakdownsResponsesCursorPage extends CursorPage<InvoiceListBreakdownsResponse> {}
+export type InvoiceListBreakdownsResponsesCursorPage = CursorPage<InvoiceListBreakdownsResponse>;
 
 export interface Invoice {
   id: string;
@@ -138,6 +247,9 @@ export interface Invoice {
    */
   billable_status?: 'billable' | 'unbillable';
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   contract_custom_fields?: { [key: string]: string };
 
   contract_id?: string;
@@ -152,6 +264,9 @@ export interface Invoice {
 
   custom_fields?: { [key: string]: unknown };
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   customer_custom_fields?: { [key: string]: string };
 
   /**
@@ -175,6 +290,9 @@ export interface Invoice {
    */
   netsuite_sales_order_id?: string;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   plan_custom_fields?: { [key: string]: string };
 
   plan_id?: string;
@@ -208,11 +326,29 @@ export namespace Invoice {
     total: number;
 
     /**
-     * The type of line item. Possible values are 'aws_royalty',
-     * 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
-     * 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
-     * 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
-     * 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+     * The type of line item.
+     *
+     * - `scheduled`: Line item is associated with a scheduled charge. View the
+     *   scheduled_charge_id on the line item.
+     * - `commit_purchase`: Line item is associated with a payment for a prepaid
+     *   commit. View the commit_id on the line item.
+     * - `usage`: Line item is associated with a usage product or composite product.
+     *   View the product_id on the line item to determine which product.
+     * - `subscription`: Line item is associated with a subscription. e.g. monthly
+     *   recurring payment for an in-advance subscription.
+     * - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+     *   are associated with their own line items. These line items have negative
+     *   totals. Use the applied_commit_or_credit object on the line item to understand
+     *   the id of the applied commit or credit, and its type. Note that the
+     *   application of a postpaid commit is associated with a line item, but the total
+     *   on the line item is not included in the invoice's total as postpaid commits
+     *   are paid in-arrears.
+     * - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+     *   currency, using the conversion rate set on the rate card. This line item will
+     *   appear when there are products priced in custom pricing units, and there is
+     *   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+     *   the spend. Then, the outstanding spend in custom pricing units will be
+     *   converted to fiat currency using a cpu_conversion line item.
      */
     type: string;
 
@@ -223,6 +359,9 @@ export namespace Invoice {
      */
     applied_commit_or_credit?: LineItem.AppliedCommitOrCredit;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     commit_custom_fields?: { [key: string]: string };
 
     /**
@@ -245,8 +384,14 @@ export namespace Invoice {
      */
     commit_type?: string;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     discount_custom_fields?: { [key: string]: string };
 
     /**
@@ -306,6 +451,9 @@ export namespace Invoice {
      */
     pricing_group_values?: { [key: string]: string };
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     product_custom_fields?: { [key: string]: string };
 
     /**
@@ -327,6 +475,9 @@ export namespace Invoice {
      */
     product_type?: string;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     professional_service_custom_fields?: { [key: string]: string };
 
     professional_service_id?: string;
@@ -338,6 +489,9 @@ export namespace Invoice {
 
     reseller_type?: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     scheduled_charge_custom_fields?: { [key: string]: string };
 
     /**
@@ -352,6 +506,9 @@ export namespace Invoice {
 
     sub_line_items?: Array<LineItem.SubLineItem>;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     subscription_custom_fields?: { [key: string]: string };
 
     /**
@@ -385,6 +542,9 @@ export namespace Invoice {
     }
 
     export interface SubLineItem {
+      /**
+       * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+       */
       custom_fields: { [key: string]: string };
 
       name: string;
@@ -534,6 +694,9 @@ export namespace Invoice {
 
     total: number;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     credit_grant_custom_fields?: { [key: string]: string };
 
     credit_grant_id?: string;
@@ -728,17 +891,14 @@ export interface InvoiceListBreakdownsParams extends CursorPageParams {
   window_size?: 'HOUR' | 'DAY';
 }
 
-Invoices.InvoicesCursorPage = InvoicesCursorPage;
-Invoices.InvoiceListBreakdownsResponsesCursorPage = InvoiceListBreakdownsResponsesCursorPage;
-
 export declare namespace Invoices {
   export {
     type Invoice as Invoice,
     type InvoiceRetrieveResponse as InvoiceRetrieveResponse,
     type InvoiceAddChargeResponse as InvoiceAddChargeResponse,
     type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse,
-    InvoicesCursorPage as InvoicesCursorPage,
-    InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
+    type InvoicesCursorPage as InvoicesCursorPage,
+    type InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
     type InvoiceRetrieveParams as InvoiceRetrieveParams,
     type InvoiceListParams as InvoiceListParams,
     type InvoiceAddChargeParams as InvoiceAddChargeParams,

package/src/resources/v1/customers/named-schedules.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class NamedSchedules extends APIResource {
   /**
@@ -20,8 +22,8 @@ export class NamedSchedules extends APIResource {
    */
   retrieve(
     body: NamedScheduleRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<NamedScheduleRetrieveResponse> {
+    options?: RequestOptions,
+  ): APIPromise<NamedScheduleRetrieveResponse> {
     return this._client.post('/v1/customers/getNamedSchedule', { body, ...options });
   }
 
@@ -40,11 +42,11 @@ export class NamedSchedules extends APIResource {
    * });
    * ```
    */
-  update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/v1/customers/updateNamedSchedule', {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }

package/src/resources/v1/customers/plans.ts

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
-import * as Shared from "../../shared.js";
-import { CursorPage, type CursorPageParams } from "../../../pagination.js";
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Plans extends APIResource {
   /**
@@ -21,10 +23,10 @@ export class Plans extends APIResource {
    */
   list(
     params: PlanListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
+    options?: RequestOptions,
+  ): PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
     const { customer_id, ...query } = params;
-    return this._client.getAPIList(`/v1/customers/${customer_id}/plans`, PlanListResponsesCursorPage, {
+    return this._client.getAPIList(path`/v1/customers/${customer_id}/plans`, CursorPage<PlanListResponse>, {
       query,
       ...options,
     });
@@ -45,9 +47,9 @@ export class Plans extends APIResource {
    * });
    * ```
    */
-  add(params: PlanAddParams, options?: Core.RequestOptions): Core.APIPromise<PlanAddResponse> {
+  add(params: PlanAddParams, options?: RequestOptions): APIPromise<PlanAddResponse> {
     const { customer_id, ...body } = params;
-    return this._client.post(`/v1/customers/${customer_id}/plans/add`, { body, ...options });
+    return this._client.post(path`/v1/customers/${customer_id}/plans/add`, { body, ...options });
   }
 
   /**
@@ -62,9 +64,9 @@ export class Plans extends APIResource {
    * });
    * ```
    */
-  end(params: PlanEndParams, options?: Core.RequestOptions): Core.APIPromise<PlanEndResponse> {
+  end(params: PlanEndParams, options?: RequestOptions): APIPromise<PlanEndResponse> {
     const { customer_id, customer_plan_id, ...body } = params;
-    return this._client.post(`/v1/customers/${customer_id}/plans/${customer_plan_id}/end`, {
+    return this._client.post(path`/v1/customers/${customer_id}/plans/${customer_plan_id}/end`, {
       body,
       ...options,
     });
@@ -91,20 +93,20 @@ export class Plans extends APIResource {
    */
   listPriceAdjustments(
     params: PlanListPriceAdjustmentsParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListPriceAdjustmentsResponsesCursorPage, PlanListPriceAdjustmentsResponse> {
+    options?: RequestOptions,
+  ): PagePromise<PlanListPriceAdjustmentsResponsesCursorPage, PlanListPriceAdjustmentsResponse> {
     const { customer_id, customer_plan_id, ...query } = params;
     return this._client.getAPIList(
-      `/v1/customers/${customer_id}/plans/${customer_plan_id}/priceAdjustments`,
-      PlanListPriceAdjustmentsResponsesCursorPage,
+      path`/v1/customers/${customer_id}/plans/${customer_plan_id}/priceAdjustments`,
+      CursorPage<PlanListPriceAdjustmentsResponse>,
       { query, ...options },
     );
   }
 }
 
-export class PlanListResponsesCursorPage extends CursorPage<PlanListResponse> {}
+export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
 
-export class PlanListPriceAdjustmentsResponsesCursorPage extends CursorPage<PlanListPriceAdjustmentsResponse> {}
+export type PlanListPriceAdjustmentsResponsesCursorPage = CursorPage<PlanListPriceAdjustmentsResponse>;
 
 export interface PlanListResponse {
   /**
@@ -112,6 +114,9 @@ export interface PlanListResponse {
    */
   id: string;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields: { [key: string]: string };
 
   plan_description: string;
@@ -358,17 +363,14 @@ export interface PlanListPriceAdjustmentsParams extends CursorPageParams {
   customer_plan_id: string;
 }
 
-Plans.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
-Plans.PlanListPriceAdjustmentsResponsesCursorPage = PlanListPriceAdjustmentsResponsesCursorPage;
-
 export declare namespace Plans {
   export {
     type PlanListResponse as PlanListResponse,
     type PlanAddResponse as PlanAddResponse,
     type PlanEndResponse as PlanEndResponse,
     type PlanListPriceAdjustmentsResponse as PlanListPriceAdjustmentsResponse,
-    PlanListResponsesCursorPage as PlanListResponsesCursorPage,
-    PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage,
+    type PlanListResponsesCursorPage as PlanListResponsesCursorPage,
+    type PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage,
     type PlanListParams as PlanListParams,
     type PlanAddParams as PlanAddParams,
     type PlanEndParams as PlanEndParams,

package/src/resources/v1/customers.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./customers/index.js";
+export * from './customers/index';