@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/customers/credits.d.mts

@@ -0,0 +1,310 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as Shared from "../../shared.mjs";
+import { CreditsBodyCursorPage } from "../../shared.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { type BodyCursorPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Credits extends APIResource {
+    /**
+     * Creates customer-level credits that provide spending allowances or free credit
+     * balances for customers across their Metronome usage. Note: In most cases, you
+     * should add credits directly to customer contracts using the contract/create or
+     * contract/edit APIs.
+     *
+     * ### Use this endpoint to:
+     *
+     * Use this endpoint when you need to provision credits directly at the customer
+     * level that can be applied across multiple contracts or scoped to specific
+     * contracts. Customer-level credits are ideal for:
+     *
+     * - Customer onboarding incentives that apply globally
+     * - Flexible spending allowances that aren't tied to a single contract
+     * - Migration scenarios where you need to preserve existing customer balances
+     *
+     * #### Scoping flexibility:
+     *
+     * Customer-level credits can be configured in two ways:
+     *
+     * - Contract-specific: Use the applicable_contract_ids field to limit the credit
+     *   to specific contracts
+     * - Cross-contract: Leave applicable_contract_ids empty to allow the credit to be
+     *   used across all of the customer's contracts
+     *
+     * #### Product Targeting:
+     *
+     * Credits can be scoped to specific products using `applicable_product_ids` or
+     * `applicable_product_tags`, or left unrestricted to apply to all products.
+     *
+     * #### Priority considerations:
+     *
+     * When multiple credits are applicable, the one with the lower priority value will
+     * be consumed first. If there is a tie, contract level commits and credits will be
+     * applied before customer level commits and credits. Plan your priority scheme
+     * carefully to ensure credits are applied in the desired order.
+     *
+     * #### Access Schedule Required:
+     *
+     * You must provide an `access_schedule` that defines when and how much credit
+     * becomes available to the customer over time. This usually is aligned to the
+     * contract schedule or starts immediately and is set to expire in the future.
+     *
+     * ### Usage Guidelines:
+     *
+     * ⚠️ Preferred Alternative: In most cases, you should add credits directly to
+     * contracts using the contract/create or contract/edit APIs instead of creating
+     * customer-level credits. Contract-level credits provide better organization, and
+     * are easier for finance teams to recognize revenue, and are the recommended
+     * approach for most use cases.
+     *
+     * @example
+     * ```ts
+     * const credit = await client.v1.customers.credits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   name: 'My Credit',
+     * });
+     * ```
+     */
+    create(body: CreditCreateParams, options?: RequestOptions): APIPromise<CreditCreateResponse>;
+    /**
+     * Retrieve a detailed list of all credits available to a customer, including
+     * promotional credits and contract-specific credits. This endpoint provides
+     * comprehensive visibility into credit balances, access schedules, and usage
+     * rules, enabling you to build credit management interfaces and track available
+     * funding.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display all available credits in customer billing dashboards
+     * - Show credit balances and expiration dates
+     * - Track credit usage history with optional ledger details
+     * - Build credit management and reporting tools
+     * - Monitor promotional credit utilization • Support customer inquiries about
+     *   available credits
+     *
+     * ### Key response fields:
+     *
+     * An array of Credit objects containing:
+     *
+     * - Credit details: Name, priority, and which applicable products/tags it applies
+     *   to
+     * - Product ID: The `product_id` of the credit. This is for external mapping into
+     *   your quote-to-cash stack, not the product it applies to.
+     * - Access schedule: When credits become available and expire
+     * - Optional ledger entries: Transaction history (if `include_ledgers=true`)
+     * - Balance information: Current available amount (if `include_balance=true`)
+     * - Metadata: Custom fields and usage specifiers
+     *
+     * ### Usage guidelines:
+     *
+     * - Pagination: Results limited to 25 commits per page; use next_page for more
+     * - Date filtering options:
+     *   - `covering_date`: Credits active on a specific date
+     *   - `starting_at`: Credits with access on/after a date
+     *   - `effective_before`: Credits with access before a date (exclusive)
+     * - Scope options:
+     *   - `include_contract_credits`: Include contract-level credits (not just
+     *     customer-level)
+     *   - `include_archived`: Include archived credits and credits from archived
+     *     contracts
+     * - Performance considerations:
+     *   - `include_ledgers`: Adds detailed transaction history (slower)
+     *   - `include_balance`: Adds current balance calculation (slower)
+     * - Optional filtering: Use credit_id to retrieve a specific commit
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const credit of client.v1.customers.credits.list(
+     *   {
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     include_ledgers: true,
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body: CreditListParams, options?: RequestOptions): PagePromise<CreditsBodyCursorPage, Shared.Credit>;
+    /**
+     * Shortens the end date of an existing customer credit to terminate it earlier
+     * than originally scheduled. Only allows moving end dates forward (earlier), not
+     * extending them.
+     *
+     * Note: To extend credit end dates or make comprehensive edits, use the 'edit
+     * credit' endpoint instead.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.credits.updateEndDate({
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   });
+     * ```
+     */
+    updateEndDate(body: CreditUpdateEndDateParams, options?: RequestOptions): APIPromise<CreditUpdateEndDateResponse>;
+}
+export interface CreditCreateResponse {
+    data: Shared.ID;
+}
+export interface CreditUpdateEndDateResponse {
+    data: Shared.ID;
+}
+export interface CreditCreateParams {
+    /**
+     * Schedule for distributing the credit to the customer.
+     */
+    access_schedule: CreditCreateParams.AccessSchedule;
+    customer_id: string;
+    /**
+     * If multiple credits or commits are applicable, the one with the lower priority
+     * will apply first.
+     */
+    priority: number;
+    product_id: string;
+    /**
+     * Which contract the credit applies to. If not provided, the credit applies to all
+     * contracts.
+     */
+    applicable_contract_ids?: Array<string>;
+    /**
+     * Which products the credit applies to. If both applicable_product_ids and
+     * applicable_product_tags are not provided, the credit applies to all products.
+     */
+    applicable_product_ids?: Array<string>;
+    /**
+     * Which tags the credit applies to. If both applicable_product_ids and
+     * applicable_product_tags are not provided, the credit applies to all products.
+     */
+    applicable_product_tags?: Array<string>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+    /**
+     * Used only in UI/API. It is not exposed to end customers.
+     */
+    description?: string;
+    /**
+     * displayed on invoices
+     */
+    name?: string;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_sales_order_id?: string;
+    rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    salesforce_opportunity_id?: string;
+    /**
+     * List of filters that determine what kind of customer usage draws down a commit
+     * or credit. A customer's usage needs to meet the condition of at least one of the
+     * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+     * be used together with `applicable_product_ids` or `applicable_product_tags`.
+     */
+    specifiers?: Array<Shared.CommitSpecifierInput>;
+    /**
+     * Prevents the creation of duplicates. If a request to create a commit or credit
+     * is made with a uniqueness key that was previously used to create a commit or
+     * credit, a new record will not be created and the request will fail with a 409
+     * error.
+     */
+    uniqueness_key?: string;
+}
+export declare namespace CreditCreateParams {
+    /**
+     * Schedule for distributing the credit to the customer.
+     */
+    interface AccessSchedule {
+        schedule_items: Array<AccessSchedule.ScheduleItem>;
+        /**
+         * Defaults to USD (cents) if not passed
+         */
+        credit_type_id?: string;
+    }
+    namespace AccessSchedule {
+        interface ScheduleItem {
+            amount: number;
+            /**
+             * RFC 3339 timestamp (exclusive)
+             */
+            ending_before: string;
+            /**
+             * RFC 3339 timestamp (inclusive)
+             */
+            starting_at: string;
+        }
+    }
+}
+export interface CreditListParams extends BodyCursorPageParams {
+    customer_id: string;
+    /**
+     * Return only credits that have access schedules that "cover" the provided date
+     */
+    covering_date?: string;
+    credit_id?: string;
+    /**
+     * Include only credits that have any access before the provided date (exclusive)
+     */
+    effective_before?: string;
+    /**
+     * Include archived credits and credits from archived contracts.
+     */
+    include_archived?: boolean;
+    /**
+     * Include the balance in the response. Setting this flag may cause the query to be
+     * slower.
+     */
+    include_balance?: boolean;
+    /**
+     * Include credits on the contract level.
+     */
+    include_contract_credits?: boolean;
+    /**
+     * Include credit ledgers in the response. Setting this flag may cause the query to
+     * be slower.
+     */
+    include_ledgers?: boolean;
+    /**
+     * Include only credits that have any access on or after the provided date
+     */
+    starting_at?: string;
+}
+export interface CreditUpdateEndDateParams {
+    /**
+     * RFC 3339 timestamp indicating when access to the credit will end and it will no
+     * longer be possible to draw it down (exclusive).
+     */
+    access_ending_before: string;
+    /**
+     * ID of the commit to update
+     */
+    credit_id: string;
+    /**
+     * ID of the customer whose credit is to be updated
+     */
+    customer_id: string;
+}
+export declare namespace Credits {
+    export { type CreditCreateResponse as CreditCreateResponse, type CreditUpdateEndDateResponse as CreditUpdateEndDateResponse, type CreditCreateParams as CreditCreateParams, type CreditListParams as CreditListParams, type CreditUpdateEndDateParams as CreditUpdateEndDateParams, };
+}
+export { type CreditsBodyCursorPage };
+//# sourceMappingURL=credits.d.mts.map

package/resources/v1/customers/credits.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,qBAAqB,EAAE;OACzB,EAAE,UAAU,EAAE;OACd,EAAkB,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,MAAM,CAAC;IAQzG;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,CAAC"}

package/resources/v1/customers/credits.d.ts

@@ -1,9 +1,60 @@
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
+import { CreditsBodyCursorPage } from "../../shared.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { type BodyCursorPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Credits extends APIResource {
     /**
-     * Create a new credit at the customer level.
+     * Creates customer-level credits that provide spending allowances or free credit
+     * balances for customers across their Metronome usage. Note: In most cases, you
+     * should add credits directly to customer contracts using the contract/create or
+     * contract/edit APIs.
+     *
+     * ### Use this endpoint to:
+     *
+     * Use this endpoint when you need to provision credits directly at the customer
+     * level that can be applied across multiple contracts or scoped to specific
+     * contracts. Customer-level credits are ideal for:
+     *
+     * - Customer onboarding incentives that apply globally
+     * - Flexible spending allowances that aren't tied to a single contract
+     * - Migration scenarios where you need to preserve existing customer balances
+     *
+     * #### Scoping flexibility:
+     *
+     * Customer-level credits can be configured in two ways:
+     *
+     * - Contract-specific: Use the applicable_contract_ids field to limit the credit
+     *   to specific contracts
+     * - Cross-contract: Leave applicable_contract_ids empty to allow the credit to be
+     *   used across all of the customer's contracts
+     *
+     * #### Product Targeting:
+     *
+     * Credits can be scoped to specific products using `applicable_product_ids` or
+     * `applicable_product_tags`, or left unrestricted to apply to all products.
+     *
+     * #### Priority considerations:
+     *
+     * When multiple credits are applicable, the one with the lower priority value will
+     * be consumed first. If there is a tie, contract level commits and credits will be
+     * applied before customer level commits and credits. Plan your priority scheme
+     * carefully to ensure credits are applied in the desired order.
+     *
+     * #### Access Schedule Required:
+     *
+     * You must provide an `access_schedule` that defines when and how much credit
+     * becomes available to the customer over time. This usually is aligned to the
+     * contract schedule or starts immediately and is set to expire in the future.
+     *
+     * ### Usage Guidelines:
+     *
+     * ⚠️ Preferred Alternative: In most cases, you should add credits directly to
+     * contracts using the contract/create or contract/edit APIs instead of creating
+     * customer-level credits. Contract-level credits provide better organization, and
+     * are easier for finance teams to recognize revenue, and are the recommended
+     * approach for most use cases.
      *
      * @example
      * ```ts
@@ -25,23 +76,75 @@ export declare class Credits extends APIResource {
      * });
      * ```
      */
-    create(body: CreditCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditCreateResponse>;
+    create(body: CreditCreateParams, options?: RequestOptions): APIPromise<CreditCreateResponse>;
     /**
-     * List credits.
+     * Retrieve a detailed list of all credits available to a customer, including
+     * promotional credits and contract-specific credits. This endpoint provides
+     * comprehensive visibility into credit balances, access schedules, and usage
+     * rules, enabling you to build credit management interfaces and track available
+     * funding.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display all available credits in customer billing dashboards
+     * - Show credit balances and expiration dates
+     * - Track credit usage history with optional ledger details
+     * - Build credit management and reporting tools
+     * - Monitor promotional credit utilization • Support customer inquiries about
+     *   available credits
+     *
+     * ### Key response fields:
+     *
+     * An array of Credit objects containing:
+     *
+     * - Credit details: Name, priority, and which applicable products/tags it applies
+     *   to
+     * - Product ID: The `product_id` of the credit. This is for external mapping into
+     *   your quote-to-cash stack, not the product it applies to.
+     * - Access schedule: When credits become available and expire
+     * - Optional ledger entries: Transaction history (if `include_ledgers=true`)
+     * - Balance information: Current available amount (if `include_balance=true`)
+     * - Metadata: Custom fields and usage specifiers
+     *
+     * ### Usage guidelines:
+     *
+     * - Pagination: Results limited to 25 commits per page; use next_page for more
+     * - Date filtering options:
+     *   - `covering_date`: Credits active on a specific date
+     *   - `starting_at`: Credits with access on/after a date
+     *   - `effective_before`: Credits with access before a date (exclusive)
+     * - Scope options:
+     *   - `include_contract_credits`: Include contract-level credits (not just
+     *     customer-level)
+     *   - `include_archived`: Include archived credits and credits from archived
+     *     contracts
+     * - Performance considerations:
+     *   - `include_ledgers`: Adds detailed transaction history (slower)
+     *   - `include_balance`: Adds current balance calculation (slower)
+     * - Optional filtering: Use credit_id to retrieve a specific commit
      *
      * @example
      * ```ts
-     * const credits = await client.v1.customers.credits.list({
-     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
-     *   credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
-     *   include_ledgers: true,
-     * });
+     * // Automatically fetches more pages as needed.
+     * for await (const credit of client.v1.customers.credits.list(
+     *   {
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     include_ledgers: true,
+     *   },
+     * )) {
+     *   // ...
+     * }
      * ```
      */
-    list(body: CreditListParams, options?: Core.RequestOptions): Core.APIPromise<CreditListResponse>;
+    list(body: CreditListParams, options?: RequestOptions): PagePromise<CreditsBodyCursorPage, Shared.Credit>;
     /**
-     * Pull forward the end date of a credit. Use the "edit a credit" endpoint to
-     * extend the end date of a credit, or to make other edits to the credit.
+     * Shortens the end date of an existing customer credit to terminate it earlier
+     * than originally scheduled. Only allows moving end dates forward (earlier), not
+     * extending them.
+     *
+     * Note: To extend credit end dates or make comprehensive edits, use the 'edit
+     * credit' endpoint instead.
      *
      * @example
      * ```ts
@@ -53,15 +156,11 @@ export declare class Credits extends APIResource {
      *   });
      * ```
      */
-    updateEndDate(body: CreditUpdateEndDateParams, options?: Core.RequestOptions): Core.APIPromise<CreditUpdateEndDateResponse>;
+    updateEndDate(body: CreditUpdateEndDateParams, options?: RequestOptions): APIPromise<CreditUpdateEndDateResponse>;
 }
 export interface CreditCreateResponse {
     data: Shared.ID;
 }
-export interface CreditListResponse {
-    data: Array<Shared.Credit>;
-    next_page: string | null;
-}
 export interface CreditUpdateEndDateResponse {
     data: Shared.ID;
 }
@@ -92,6 +191,9 @@ export interface CreditCreateParams {
      * applicable_product_tags are not provided, the credit applies to all products.
      */
     applicable_product_tags?: Array<string>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: {
         [key: string]: string;
     };
@@ -118,7 +220,7 @@ export interface CreditCreateParams {
      * specifiers to contribute to a commit's or credit's drawdown. This field cannot
      * be used together with `applicable_product_ids` or `applicable_product_tags`.
      */
-    specifiers?: Array<CreditCreateParams.Specifier>;
+    specifiers?: Array<Shared.CommitSpecifierInput>;
     /**
      * Prevents the creation of duplicates. If a request to create a commit or credit
      * is made with a uniqueness key that was previously used to create a commit or
@@ -151,25 +253,8 @@ export declare namespace CreditCreateParams {
             starting_at: string;
         }
     }
-    interface Specifier {
-        presentation_group_values?: {
-            [key: string]: string;
-        };
-        pricing_group_values?: {
-            [key: string]: string;
-        };
-        /**
-         * If provided, the specifier will only apply to the product with the specified ID.
-         */
-        product_id?: string;
-        /**
-         * If provided, the specifier will only apply to products with all the specified
-         * tags.
-         */
-        product_tags?: Array<string>;
-    }
 }
-export interface CreditListParams {
+export interface CreditListParams extends BodyCursorPageParams {
     customer_id: string;
     /**
      * Return only credits that have access schedules that "cover" the provided date
@@ -198,14 +283,6 @@ export interface CreditListParams {
      * be slower.
      */
     include_ledgers?: boolean;
-    /**
-     * The maximum number of commits to return. Defaults to 25.
-     */
-    limit?: number;
-    /**
-     * The next page token from a previous response.
-     */
-    next_page?: string;
     /**
      * Include only credits that have any access on or after the provided date
      */
@@ -227,6 +304,7 @@ export interface CreditUpdateEndDateParams {
     customer_id: string;
 }
 export declare namespace Credits {
-    export { type CreditCreateResponse as CreditCreateResponse, type CreditListResponse as CreditListResponse, type CreditUpdateEndDateResponse as CreditUpdateEndDateResponse, type CreditCreateParams as CreditCreateParams, type CreditListParams as CreditListParams, type CreditUpdateEndDateParams as CreditUpdateEndDateParams, };
+    export { type CreditCreateResponse as CreditCreateResponse, type CreditUpdateEndDateResponse as CreditUpdateEndDateResponse, type CreditCreateParams as CreditCreateParams, type CreditListParams as CreditListParams, type CreditUpdateEndDateParams as CreditUpdateEndDateParams, };
 }
+export { type CreditsBodyCursorPage };
 //# sourceMappingURL=credits.d.ts.map

package/resources/v1/customers/credits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AAEvC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED,UAAiB,SAAS;QACxB,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEtD,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,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,qBAAqB,EAAE;OACzB,EAAE,UAAU,EAAE;OACd,EAAkB,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,MAAM,CAAC;IAQzG;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,CAAC"}