@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/contracts/rate-cards/rate-cards.mjs

@@ -1,13 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../../resource.mjs";
-import { isRequestOptions } from "../../../../core.mjs";
+import { APIResource } from "../../../../core/resource.mjs";
 import * as NamedSchedulesAPI from "./named-schedules.mjs";
 import { NamedSchedules, } from "./named-schedules.mjs";
 import * as ProductOrdersAPI from "./product-orders.mjs";
 import { ProductOrders, } from "./product-orders.mjs";
 import * as RatesAPI from "./rates.mjs";
-import { RateListResponsesCursorPage, Rates, } from "./rates.mjs";
-import { CursorPage } from "../../../../pagination.mjs";
+import { Rates, } from "./rates.mjs";
+import { CursorPage } from "../../../../core/pagination.mjs";
 export class RateCards extends APIResource {
     constructor() {
         super(...arguments);
@@ -16,7 +15,39 @@ export class RateCards extends APIResource {
         this.namedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
     }
     /**
-     * Create a new rate card
+     * In Metronome, the rate card is the central location for your pricing. Rate cards
+     * were built with new product launches and pricing changes in mind - you can
+     * update your products and pricing in one place, and that change will be
+     * automatically propagated across your customer cohorts. Most clients need only
+     * maintain one or a few rate cards within Metronome.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Create a rate card with a name and description
+     * - Define the rate card's single underlying fiat currency, and any number of
+     *   conversion rates between that fiat currency and custom pricing units. You can
+     *   then add products and associated rates in the fiat currency or custom pricing
+     *   unit for which you have defined a conversion rate.
+     * - Set aliases for the rate card. Aliases are human-readable names that you can
+     *   use in the place of the id of the rate card when provisioning a customer's
+     *   contract. By using an alias, you can easily create a contract and provision a
+     *   customer by choosing the paygo rate card, without storing the rate card id in
+     *   your internal systems. This is helpful when launching a new rate card for
+     *   paygo customers, you can update the alias for paygo to be scheduled to be
+     *   assigned to the new rate card without updating your code.
+     *
+     * ### Key response fields:
+     *
+     * - The ID of the rate card you just created
+     *
+     * ### Usage guidelines:
+     *
+     * - After creating a rate card, you can now use the addRate or addRates endpoints
+     *   to add products and their prices to it
+     * - A rate card alias can only be used by one rate card at a time. If you create a
+     *   contract with a rate card alias that is already in use by another rate card,
+     *   the original rate card's alias schedule will be updated. The alias will
+     *   reference the rate card to which it was most recently assigned.
      *
      * @example
      * ```ts
@@ -42,8 +73,9 @@ export class RateCards extends APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/create', { body, ...options });
     }
     /**
-     * Get a specific rate card NOTE: Use `/contract-pricing/rate-cards/getRates` to
-     * retrieve rate card rates.
+     * Return details for a specific rate card including name, description, and
+     * aliases. This endpoint does not return rates - use the dedicated getRates or
+     * getRateSchedule endpoints to understand the rates on a rate card.
      *
      * @example
      * ```ts
@@ -57,7 +89,58 @@ export class RateCards extends APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/get', { body, ...options });
     }
     /**
-     * Update a rate card
+     * Update the metadata properties of an existing rate card, including its name,
+     * description, and aliases. This endpoint is designed for managing rate card
+     * identity and reference aliases rather than modifying pricing rates.
+     *
+     * Modifies the descriptive properties and alias configuration of a rate card
+     * without affecting the underlying pricing rates or schedules. This allows you to
+     * update how a rate card is identified and referenced throughout your system.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Rate card renaming: Update display names or descriptions for organizational
+     *   clarity
+     * - Alias management: Add, modify, or schedule alias transitions for seamless rate
+     *   card migrations
+     * - Documentation updates: Keep rate card descriptions current with business
+     *   context
+     * - Self-serve provisioning setup: Configure aliases to enable code-free rate card
+     *   transitions
+     *
+     * #### Active contract impact:
+     *
+     * - Alias changes: Already-created contracts continue using their originally
+     *   assigned rate cards.
+     * - Other changes made using this endpoint will only impact the Metronome UI.
+     *
+     * #### Grandfathering existing PLG customer pricing:
+     *
+     * - Rate card aliases support scheduled transitions, enabling seamless rate card
+     *   migrations for new customers, allowing existing customers to be grandfathered
+     *   into their existing prices without code. Note that there are multiple
+     *   mechanisms to support grandfathering in Metronome.
+     *
+     * #### How scheduled aliases work for PLG grandfathering:
+     *
+     * Initial setup:
+     *
+     * - Add alias to current rate card: Assign a stable alias (e.g.,
+     *   "standard-pricing") to your active rate card
+     * - Reference alias during contract creation: Configure your self-serve workflow
+     *   to create contracts using `rate_card_alias` instead of direct `rate_card_id`
+     * - Automatic resolution: New contracts referencing the alias automatically
+     *   resolve to the rate card associated with the alias at the point in time of
+     *   provisioning
+     *
+     * #### Grandfathering process:
+     *
+     * - Create new rate card: Build your new rate card with updated pricing structure
+     * - Schedule alias transition: Add the same alias to the new rate card with a
+     *   `starting_at` timestamp
+     * - Automatic cutover: Starting at the scheduled time, new contracts created in
+     *   your PLG workflow using that alias will automatically reference the new rate
+     *   card
      *
      * @example
      * ```ts
@@ -73,12 +156,22 @@ export class RateCards extends APIResource {
     update(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/update', { body, ...options });
     }
-    list(params, options) {
-        if (isRequestOptions(params)) {
-            return this.list(undefined, params);
-        }
+    /**
+     * List all rate cards. Returns rate card IDs, names, descriptions, aliases, and
+     * other details. To view the rates associated with a given rate card, use the
+     * getRates or getRateSchedule endpoints.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const rateCardListResponse of client.v1.contracts.rateCards.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params = undefined, options) {
         const { limit, next_page, body } = params ?? {};
-        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
+        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', (CursorPage), {
             query: { limit, next_page },
             body: body,
             method: 'post',
@@ -86,7 +179,11 @@ export class RateCards extends APIResource {
         });
     }
     /**
-     * Archive a rate card
+     * Permanently disable a rate card by archiving it, preventing use in new contracts
+     * while preserving existing contract pricing. Use this when retiring old pricing
+     * models, consolidating rate cards, or removing outdated pricing structures.
+     * Returns the archived rate card ID and stops the rate card from appearing in
+     * contract creation workflows.
      *
      * @example
      * ```ts
@@ -100,8 +197,18 @@ export class RateCards extends APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/archive', { body, ...options });
     }
     /**
-     * Get all rates for a rate card from starting_at (either in perpetuity or until
-     * ending_before, if provided)
+     * A rate card defines the prices that you charge for your products. Rate cards
+     * support scheduled changes over time, to allow you to easily roll out pricing
+     * changes and new product launches across your customer base. Use this endpoint to
+     * understand the rate schedule `starting_at` a given date, optionally filtering
+     * the list of rates returned based on product id or pricing group values. For
+     * example, you may want to display a schedule of upcoming price changes for a
+     * given product in your product experience - use this endpoint to fetch that
+     * information from its source of truth in Metronome.
+     *
+     * If you want to understand the rates for a specific customer's contract,
+     * inclusive of contract-level overrides, use the `getContractRateSchedule`
+     * endpoint.
      *
      * @example
      * ```ts
@@ -130,11 +237,7 @@ export class RateCards extends APIResource {
         });
     }
 }
-export class RateCardListResponsesCursorPage extends CursorPage {
-}
-RateCards.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
 RateCards.ProductOrders = ProductOrders;
 RateCards.Rates = Rates;
-RateCards.RateListResponsesCursorPage = RateListResponsesCursorPage;
 RateCards.NamedSchedules = NamedSchedules;
 //# sourceMappingURL=rate-cards.mjs.map

package/resources/v1/contracts/rate-cards/rate-cards.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"rate-cards.mjs","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,gBAAgB;OACrB,EAKL,aAAa,GACd;OACM,KAAK,QAAQ;OACb,EAOL,2BAA2B,EAC3B,KAAK,GACN;OACM,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwJxG,CAAC;IAtJC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAqBD,IAAI,CACF,MAAiD,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sCAAsC,EAAE,+BAA+B,EAAE;YACtG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE;YAC1E,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,UAAgC;CAAG;AA6SxF,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAC5E,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC;AACxC,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;AACxB,SAAS,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AACpE,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}
+{"version":3,"file":"rate-cards.mjs","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,gBAAgB;OACrB,EAKL,aAAa,GACd;OACM,KAAK,QAAQ;OACb,EAQL,KAAK,GACN;OAEM,EAAE,UAAU,EAAsC;AAGzD,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2OxG,CAAC;IAzOC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAgD,SAAS,EACzD,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sCAAsC,EAAE,CAAA,UAAgC,CAAA,EAAE;YACvG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE;YAC1E,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAuSD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC;AACxC,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;AACxB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}

package/resources/v1/contracts/rate-cards/rates.d.mts

@@ -0,0 +1,382 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import * as Shared from "../../../shared.mjs";
+import { APIPromise } from "../../../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../internal/request-options.mjs";
+export declare class Rates extends APIResource {
+    /**
+     * Understand the rate schedule at a given timestamp, optionally filtering the list
+     * of rates returned based on properties such as `product_id` and
+     * `pricing_group_values`. For example, you may want to display the current price
+     * for a given product in your product experience - use this endpoint to fetch that
+     * information from its source of truth in Metronome.
+     *
+     * If you want to understand the rates for a specific customer's contract,
+     * inclusive of contract-level overrides, use the `getContractRateSchedule`
+     * endpoint.
+     *
+     * @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, options?: RequestOptions): PagePromise<RateListResponsesCursorPage, RateListResponse>;
+    /**
+     * 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?: RequestOptions): APIPromise<RateAddResponse>;
+    /**
+     * 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?: RequestOptions): APIPromise<RateAddManyResponse>;
+}
+export type RateListResponsesCursorPage = CursorPage<RateListResponse>;
+export interface RateListResponse {
+    entitled: boolean;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    product_custom_fields: {
+        [key: string]: string;
+    };
+    product_id: string;
+    product_name: string;
+    product_tags: Array<string>;
+    rate: Shared.Rate;
+    starting_at: string;
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    /**
+     * A distinct rate on the rate card. You can choose to use this rate rather than
+     * list rate when consuming a credit or commit.
+     */
+    commit_rate?: Shared.CommitRate;
+    ending_before?: string;
+    pricing_group_values?: {
+        [key: string]: string;
+    };
+}
+export interface RateAddResponse {
+    data: RateAddResponse.Data;
+}
+export declare namespace RateAddResponse {
+    interface Data {
+        rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'CUSTOM' | 'TIERED';
+        /**
+         * A distinct rate on the rate card. You can choose to use this rate rather than
+         * list rate when consuming a credit or commit.
+         */
+        commit_rate?: Shared.CommitRate;
+        credit_type?: Shared.CreditTypeData;
+        /**
+         * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+         * processors.
+         */
+        custom_rate?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+         * set to true.
+         */
+        is_prorated?: boolean;
+        /**
+         * Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+         * this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+         */
+        price?: number;
+        /**
+         * if pricing groups are used, this will contain the values used to calculate the
+         * price
+         */
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+         */
+        quantity?: number;
+        /**
+         * Only set for TIERED rate_type.
+         */
+        tiers?: Array<Shared.Tier>;
+        /**
+         * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+         * using list prices rather than the standard rates for this product on the
+         * contract.
+         */
+        use_list_prices?: boolean;
+    }
+}
+export interface RateAddManyResponse {
+    /**
+     * The ID of the rate card to which the rates were added.
+     */
+    data: Shared.ID;
+}
+export interface RateListParams extends CursorPageParams {
+    /**
+     * Body param: inclusive starting point for the rates schedule
+     */
+    at: string;
+    /**
+     * Body param: ID of the rate card to get the schedule for
+     */
+    rate_card_id: string;
+    /**
+     * Body param: List of rate selectors, rates matching ANY of the selector will be
+     * included in the response Passing no selectors will result in all rates being
+     * returned.
+     */
+    selectors?: Array<RateListParams.Selector>;
+}
+export declare namespace RateListParams {
+    interface Selector {
+        /**
+         * Subscription rates matching the billing frequency will be included in the
+         * response.
+         */
+        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?: {
+            [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?: {
+            [key: string]: string;
+        };
+        /**
+         * Rates matching the product id will be included in the response.
+         */
+        product_id?: string;
+        /**
+         * List of product tags, rates matching any of the tags will be included in the
+         * response.
+         */
+        product_tags?: Array<string>;
+    }
+}
+export interface RateAddParams {
+    entitled: boolean;
+    /**
+     * ID of the product to add a rate for
+     */
+    product_id: string;
+    /**
+     * ID of the rate card to update
+     */
+    rate_card_id: string;
+    rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+    /**
+     * inclusive effective date
+     */
+    starting_at: string;
+    /**
+     * Optional. Frequency to bill subscriptions with. Required for subscription type
+     * products with Flat rate.
+     */
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    /**
+     * A distinct rate on the rate card. You can choose to use this rate rather than
+     * list rate when consuming a credit or commit.
+     */
+    commit_rate?: Shared.CommitRate;
+    /**
+     * The Metronome ID of the credit type to associate with price, defaults to USD
+     * (cents) if not passed. Used by all rate_types except type PERCENTAGE. PERCENTAGE
+     * rates use the credit type of associated rates.
+     */
+    credit_type_id?: string;
+    /**
+     * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+     * processors.
+     */
+    custom_rate?: {
+        [key: string]: unknown;
+    };
+    /**
+     * exclusive end date
+     */
+    ending_before?: string;
+    /**
+     * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+     * set to true.
+     */
+    is_prorated?: boolean;
+    /**
+     * Default price. For FLAT and SUBSCRIPTION rate_type, this must be >=0. For
+     * PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this
+     * must be >=0 and <=1.
+     */
+    price?: number;
+    /**
+     * Optional. List of pricing group key value pairs which will be used to calculate
+     * the price.
+     */
+    pricing_group_values?: {
+        [key: string]: string;
+    };
+    /**
+     * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+     */
+    quantity?: number;
+    /**
+     * Only set for TIERED rate_type.
+     */
+    tiers?: Array<Shared.Tier>;
+    /**
+     * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+     * using list prices rather than the standard rates for this product on the
+     * contract.
+     */
+    use_list_prices?: boolean;
+}
+export interface RateAddManyParams {
+    rate_card_id: string;
+    rates: Array<RateAddManyParams.Rate>;
+}
+export declare namespace RateAddManyParams {
+    interface Rate {
+        entitled: boolean;
+        /**
+         * ID of the product to add a rate for
+         */
+        product_id: string;
+        rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+        /**
+         * inclusive effective date
+         */
+        starting_at: string;
+        /**
+         * Optional. Frequency to bill subscriptions with. Required for subscription type
+         * products with Flat rate.
+         */
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * A distinct rate on the rate card. You can choose to use this rate rather than
+         * list rate when consuming a credit or commit.
+         */
+        commit_rate?: Shared.CommitRate;
+        /**
+         * "The Metronome ID of the credit type to associate with price, defaults to USD
+         * (cents) if not passed. Used by all rate_types except type PERCENTAGE. PERCENTAGE
+         * rates use the credit type of associated rates."
+         */
+        credit_type_id?: string;
+        /**
+         * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+         * processors.
+         */
+        custom_rate?: {
+            [key: string]: unknown;
+        };
+        /**
+         * exclusive end date
+         */
+        ending_before?: string;
+        /**
+         * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+         * set to true.
+         */
+        is_prorated?: boolean;
+        /**
+         * Default price. For FLAT and SUBSCRIPTION rate_type, this must be >=0. For
+         * PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this
+         * must be >=0 and <=1.
+         */
+        price?: number;
+        /**
+         * Optional. List of pricing group key value pairs which will be used to calculate
+         * the price.
+         */
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+         */
+        quantity?: number;
+        /**
+         * Only set for TIERED rate_type.
+         */
+        tiers?: Array<Shared.Tier>;
+        /**
+         * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+         * using list prices rather than the standard rates for this product on the
+         * contract.
+         */
+        use_list_prices?: boolean;
+    }
+}
+export declare namespace Rates {
+    export { type RateListResponse as RateListResponse, type RateAddResponse as RateAddResponse, type RateAddManyResponse as RateAddManyResponse, type RateListResponsesCursorPage as RateListResponsesCursorPage, type RateListParams as RateListParams, type RateAddParams as RateAddParams, type RateAddManyParams as RateAddManyParams, };
+}
+//# sourceMappingURL=rates.d.mts.map

package/resources/v1/contracts/rate-cards/rates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rates.d.mts","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,IAAI,CACF,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAU7D;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5F;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,qBAAqB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjD,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAElE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAEhC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClD;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;CAC5B;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAExE;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;QAEhC,WAAW,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;QAEpC;;;WAGG;QACH,WAAW,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEzC;;;WAGG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE3B;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;CAC5C;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,QAAQ;QACvB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,4BAA4B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzD;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAExE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAElE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAEhC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IAErB,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAExE;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;QAEhC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,WAAW,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEzC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE3B;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}