@metronome/sdk 0.1.0-beta.9 → 0.2.0

package/src/resources/v1/contracts/rate-cards/rates.ts

@@ -1,13 +1,35 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../resource';
-import * as Core from '../../../../core';
-import * as Shared from '../../../shared';
-import { CursorPage, type CursorPageParams } from '../../../../pagination';
+import { APIResource } from "../../../../resource.js";
+import * as Core from "../../../../core.js";
+import * as Shared from "../../../shared.js";
+import { CursorPage, type CursorPageParams } from "../../../../pagination.js";
 
 export class Rates extends APIResource {
   /**
    * Get all rates for a rate card at a point in time
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const rateListResponse of client.v1.contracts.rateCards.rates.list(
+   *   {
+   *     at: '2024-01-01T00:00:00.000Z',
+   *     rate_card_id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+   *     selectors: [
+   *       {
+   *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+   *         partial_pricing_group_values: {
+   *           region: 'us-west-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *     ],
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: RateListParams,
@@ -24,6 +46,20 @@ export class Rates extends APIResource {
 
   /**
    * Add a new rate
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.rateCards.rates.add({
+   *     entitled: true,
+   *     product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     rate_type: 'FLAT',
+   *     starting_at: '2020-01-01T00:00:00.000Z',
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     price: 100,
+   *   });
+   * ```
    */
   add(body: RateAddParams, options?: Core.RequestOptions): Core.APIPromise<RateAddResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/addRate', { body, ...options });
@@ -31,6 +67,38 @@ export class Rates extends APIResource {
 
   /**
    * Add new rates
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.rateCards.rates.addMany({
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     rates: [
+   *       {
+   *         product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         starting_at: '2020-01-01T00:00:00.000Z',
+   *         entitled: true,
+   *         rate_type: 'FLAT',
+   *         price: 100,
+   *         pricing_group_values: {
+   *           region: 'us-west-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *       {
+   *         product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         starting_at: '2020-01-01T00:00:00.000Z',
+   *         entitled: true,
+   *         rate_type: 'FLAT',
+   *         price: 120,
+   *         pricing_group_values: {
+   *           region: 'us-east-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   addMany(body: RateAddManyParams, options?: Core.RequestOptions): Core.APIPromise<RateAddManyResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/addRates', { body, ...options });
@@ -42,7 +110,7 @@ export class RateListResponsesCursorPage extends CursorPage<RateListResponse> {}
 export interface RateListResponse {
   entitled: boolean;
 
-  product_custom_fields: Record<string, string>;
+  product_custom_fields: { [key: string]: string };
 
   product_id: string;
 
@@ -54,7 +122,7 @@ export interface RateListResponse {
 
   starting_at: string;
 
-  billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+  billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
   /**
    * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -64,7 +132,7 @@ export interface RateListResponse {
 
   ending_before?: string;
 
-  pricing_group_values?: Record<string, string>;
+  pricing_group_values?: { [key: string]: string };
 }
 
 export namespace RateListResponse {
@@ -107,7 +175,7 @@ export namespace RateAddResponse {
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
      * processors.
      */
-    custom_rate?: Record<string, unknown>;
+    custom_rate?: { [key: string]: unknown };
 
     /**
      * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -125,7 +193,7 @@ export namespace RateAddResponse {
      * if pricing groups are used, this will contain the values used to calculate the
      * price
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
@@ -198,19 +266,19 @@ export namespace RateListParams {
      * Subscription rates matching the billing frequency will be included in the
      * response.
      */
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * List of pricing group key value pairs, rates containing the matching key / value
      * pairs will be included in the response.
      */
-    partial_pricing_group_values?: Record<string, string>;
+    partial_pricing_group_values?: { [key: string]: string };
 
     /**
      * List of pricing group key value pairs, rates matching all of the key / value
      * pairs will be included in the response.
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Rates matching the product id will be included in the response.
@@ -249,7 +317,7 @@ export interface RateAddParams {
    * Optional. Frequency to bill subscriptions with. Required for subscription type
    * products with Flat rate.
    */
-  billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+  billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
   /**
    * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -268,7 +336,7 @@ export interface RateAddParams {
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
    * processors.
    */
-  custom_rate?: Record<string, unknown>;
+  custom_rate?: { [key: string]: unknown };
 
   /**
    * exclusive end date
@@ -292,7 +360,7 @@ export interface RateAddParams {
    * Optional. List of pricing group key value pairs which will be used to calculate
    * the price.
    */
-  pricing_group_values?: Record<string, string>;
+  pricing_group_values?: { [key: string]: string };
 
   /**
    * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
@@ -358,7 +426,7 @@ export namespace RateAddManyParams {
      * Optional. Frequency to bill subscriptions with. Required for subscription type
      * products with Flat rate.
      */
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -377,7 +445,7 @@ export namespace RateAddManyParams {
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
      * processors.
      */
-    custom_rate?: Record<string, unknown>;
+    custom_rate?: { [key: string]: unknown };
 
     /**
      * exclusive end date
@@ -401,7 +469,7 @@ export namespace RateAddManyParams {
      * Optional. List of pricing group key value pairs which will be used to calculate
      * the price.
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

package/src/resources/v1/contracts/rate-cards.ts

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

package/src/resources/v1/contracts.ts

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

package/src/resources/v1/credit-grants.ts

@@ -1,15 +1,36 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as CreditGrantsAPI from './credit-grants';
-import * as Shared from '../shared';
-import { CursorPage, type CursorPageParams } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as CreditGrantsAPI from "./credit-grants.js";
+import * as Shared from "../shared.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 
 export class CreditGrants extends APIResource {
   /**
    * Create a new credit grant
+   *
+   * @example
+   * ```ts
+   * const creditGrant = await client.v1.creditGrants.create({
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *   expires_at: '2022-04-01T00:00:00Z',
+   *   grant_amount: {
+   *     amount: 1000,
+   *     credit_type_id: '5ae401dc-a648-4b49-9ac3-391bb5bc4d7b',
+   *   },
+   *   name: 'Acme Corp Promotional Credit Grant',
+   *   paid_amount: {
+   *     amount: 5000,
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *   },
+   *   priority: 0.5,
+   *   credit_grant_type: 'trial',
+   *   effective_at: '2022-02-01T00:00:00Z',
+   *   reason: 'Incentivize new customer',
+   * });
+   * ```
    */
   create(
     body: CreditGrantCreateParams,
@@ -20,6 +41,26 @@ export class CreditGrants extends APIResource {
 
   /**
    * List credit grants. This list does not included voided grants.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditGrantListResponse of client.v1.creditGrants.list(
+   *   {
+   *     credit_type_ids: [
+   *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     ],
+   *     customer_ids: [
+   *       'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *       '0e5b8609-d901-4992-b394-c3c2e3f37b1c',
+   *     ],
+   *     effective_before: '2022-02-01T00:00:00Z',
+   *     not_expiring_before: '2022-02-01T00:00:00Z',
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params?: CreditGrantListParams,
@@ -46,6 +87,15 @@ export class CreditGrants extends APIResource {
 
   /**
    * Edit an existing credit grant
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.edit({
+   *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *   expires_at: '2022-04-01T00:00:00Z',
+   *   name: 'Acme Corp Promotional Credit Grant',
+   * });
+   * ```
    */
   edit(body: CreditGrantEditParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantEditResponse> {
     return this._client.post('/v1/credits/editGrant', { body, ...options });
@@ -55,6 +105,16 @@ export class CreditGrants extends APIResource {
    * Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
    * Ledger entries are returned in chronological order. Ledger entries associated
    * with voided credit grants are not included.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.listEntries({
+   *   credit_type_ids: ['2714e483-4ff1-48e4-9e25-ac732e8f24f2'],
+   *   customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
+   *   ending_before: '2021-02-01T00:00:00Z',
+   *   starting_on: '2021-01-01T00:00:00Z',
+   * });
+   * ```
    */
   listEntries(
     params?: CreditGrantListEntriesParams,
@@ -68,12 +128,19 @@ export class CreditGrants extends APIResource {
     if (isRequestOptions(params)) {
       return this.listEntries({}, params);
     }
-    const { next_page, ...body } = params;
-    return this._client.post('/v1/credits/listEntries', { query: { next_page }, body, ...options });
+    const { next_page, sort, ...body } = params;
+    return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
   }
 
   /**
    * Void a credit grant
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.void({
+   *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   void(body: CreditGrantVoidParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantVoidResponse> {
     return this._client.post('/v1/credits/voidGrant', { body, ...options });
@@ -154,7 +221,7 @@ export interface CreditGrantListResponse {
    */
   balance: CreditGrantListResponse.Balance;
 
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   /**
    * the Metronome ID of the customer
@@ -382,7 +449,7 @@ export interface CreditGrantCreateParams {
   /**
    * Custom fields to attach to the credit grant.
    */
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * The credit grant will only apply to usage or charges dated on or after this
@@ -528,6 +595,11 @@ export interface CreditGrantListEntriesParams {
    */
   next_page?: string;
 
+  /**
+   * Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
+   */
+  sort?: 'asc' | 'desc';
+
   /**
    * Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
    * absent, ledger entries for all credit types will be returned.

package/src/resources/v1/custom-fields.ts

@@ -1,13 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
 
 export class CustomFields extends APIResource {
   /**
    * Add a key to the allow list for a given entity. There is a 100 character limit
    * on custom field keys.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.addKey({
+   *   enforce_uniqueness: true,
+   *   entity: 'customer',
+   *   key: 'x_account_id',
+   * });
+   * ```
    */
   addKey(body: CustomFieldAddKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/customFields/addKey', {
@@ -19,6 +28,15 @@ export class CustomFields extends APIResource {
 
   /**
    * Deletes one or more custom fields on an instance of a Metronome entity.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.deleteValues({
+   *   entity: 'customer',
+   *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+   *   keys: ['x_account_id'],
+   * });
+   * ```
    */
   deleteValues(body: CustomFieldDeleteValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/customFields/deleteValues', {
@@ -30,6 +48,13 @@ export class CustomFields extends APIResource {
 
   /**
    * List all active custom field keys, optionally filtered by entity type.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.customFields.listKeys({
+   *   entities: ['customer'],
+   * });
+   * ```
    */
   listKeys(
     params?: CustomFieldListKeysParams,
@@ -49,6 +74,14 @@ export class CustomFields extends APIResource {
 
   /**
    * Remove a key from the allow list for a given entity.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.removeKey({
+   *   entity: 'customer',
+   *   key: 'x_account_id',
+   * });
+   * ```
    */
   removeKey(body: CustomFieldRemoveKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/customFields/removeKey', {
@@ -66,6 +99,15 @@ export class CustomFields extends APIResource {
    * transactional and will update all key/value pairs or no key/value pairs. Partial
    * updates are not supported. There is a 200 character limit on custom field
    * values.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.setValues({
+   *   custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
+   *   entity: 'customer',
+   *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+   * });
+   * ```
    */
   setValues(body: CustomFieldSetValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/customFields/setValues', {
@@ -103,7 +145,8 @@ export namespace CustomFieldListKeysResponse {
       | 'professional_service'
       | 'product'
       | 'rate_card'
-      | 'scheduled_charge';
+      | 'scheduled_charge'
+      | 'subscription';
 
     key: string;
   }
@@ -129,7 +172,8 @@ export interface CustomFieldAddKeyParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   key: string;
 }
@@ -152,7 +196,8 @@ export interface CustomFieldDeleteValuesParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   entity_id: string;
 
@@ -186,6 +231,7 @@ export interface CustomFieldListKeysParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
+    | 'subscription'
   >;
 }
 
@@ -207,13 +253,14 @@ export interface CustomFieldRemoveKeyParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   key: string;
 }
 
 export interface CustomFieldSetValuesParams {
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   entity:
     | 'alert'
@@ -232,7 +279,8 @@ export interface CustomFieldSetValuesParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   entity_id: string;
 }

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

@@ -1,13 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 export class Alerts extends APIResource {
   /**
    * Get the customer alert status and alert information for the specified customer
    * and alert
+   *
+   * @example
+   * ```ts
+   * const alert = await client.v1.customers.alerts.retrieve({
+   *   alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   retrieve(body: AlertRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<AlertRetrieveResponse> {
     return this._client.post('/v1/customer-alerts/get', { body, ...options });
@@ -15,6 +23,13 @@ export class Alerts extends APIResource {
 
   /**
    * Fetch all customer alert statuses and alert information for a customer
+   *
+   * @example
+   * ```ts
+   * const alerts = await client.v1.customers.alerts.list({
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   list(params: AlertListParams, options?: Core.RequestOptions): Core.APIPromise<AlertListResponse> {
     const { next_page, ...body } = params;
@@ -23,6 +38,14 @@ export class Alerts extends APIResource {
 
   /**
    * Reset state for an alert by customer id and force re-evaluation
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.alerts.reset({
+   *   alert_id: '5e8691bf-b22a-4672-922d-f80eee940f01',
+   *   customer_id: '4c83caf3-8af4-44e2-9aeb-e290531726d9',
+   * });
+   * ```
    */
   reset(body: AlertResetParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/customer-alerts/reset', {
@@ -114,6 +137,12 @@ export namespace CustomerAlert {
      */
     group_key_filter?: Alert.GroupKeyFilter;
 
+    /**
+     * Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+     * group key on individual line items.
+     */
+    group_values?: Array<Alert.GroupValue>;
+
     /**
      * Only supported for invoice_total_reached alerts. A list of invoice types to
      * evaluate.
@@ -146,6 +175,12 @@ export namespace CustomerAlert {
 
       value: string;
     }
+
+    export interface GroupValue {
+      key: string;
+
+      value: string;
+    }
   }
 }
 
@@ -169,6 +204,12 @@ export interface AlertRetrieveParams {
    * The Metronome ID of the customer
    */
   customer_id: string;
+
+  /**
+   * When parallel alerts are enabled during migration, this flag denotes whether to
+   * fetch alerts for plans or contracts.
+   */
+  plans_or_contracts?: 'PLANS' | 'CONTRACTS';
 }
 
 export interface AlertListParams {

package/src/resources/v1/customers/billing-config.ts

@@ -1,11 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
 
 export class BillingConfig extends APIResource {
   /**
    * Set the billing configuration for a given customer.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.billingConfig.create({
+   *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   billing_provider_type: 'stripe',
+   *   billing_provider_customer_id: 'cus_AJ6y20bjkOOayM',
+   *   stripe_collection_method: 'charge_automatically',
+   * });
+   * ```
    */
   create(params: BillingConfigCreateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     const { customer_id, billing_provider_type, ...body } = params;
@@ -18,6 +28,15 @@ export class BillingConfig extends APIResource {
 
   /**
    * Fetch the billing configuration for the given customer.
+   *
+   * @example
+   * ```ts
+   * const billingConfig =
+   *   await client.v1.customers.billingConfig.retrieve({
+   *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     billing_provider_type: 'stripe',
+   *   });
+   * ```
    */
   retrieve(
     params: BillingConfigRetrieveParams,
@@ -30,6 +49,14 @@ export class BillingConfig extends APIResource {
   /**
    * Delete the billing configuration for a given customer. Note: this is unsupported
    * for Azure and AWS Marketplace customers.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.billingConfig.delete({
+   *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   billing_provider_type: 'stripe',
+   * });
+   * ```
    */
   delete(params: BillingConfigDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     const { customer_id, billing_provider_type } = params;
@@ -53,6 +80,11 @@ export namespace BillingConfigRetrieveResponse {
      */
     aws_expiration_date?: string;
 
+    /**
+     * True if the aws_product_code is a SAAS subscription product, false otherwise.
+     */
+    aws_is_subscription_product?: boolean;
+
     aws_product_code?: string;
 
     aws_region?: