orb-billing 5.76.0 → 6.0.0

package/resources/customers/costs.mjs

@@ -1,6 +1,6 @@
 // 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 { path } from "../../internal/utils/path.mjs";
 /**
  * A customer is a buyer of your products, and the other party to the billing relationship.
  *
@@ -18,17 +18,249 @@ import { isRequestOptions } from "../../core.mjs";
  * information on what this timezone parameter influences within Orb.
  */
 export class Costs extends APIResource {
+    /**
+     * This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
+     * Orb, calculated by applying pricing information to the underlying usage (see the
+     * [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+     * to fetch usage per metric, in usage units rather than a currency).
+     *
+     * This endpoint can be leveraged for internal tooling and to provide a more
+     * transparent billing experience for your end users:
+     *
+     * 1. Understand the cost breakdown per line item historically and in real-time for
+     *    the current billing period.
+     * 2. Provide customer visibility into how different services are contributing to
+     *    the overall invoice with a per-day timeseries (as compared to the
+     *    [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+     *    which represents a snapshot for the current period).
+     * 3. Assess how minimums and discounts affect your customers by teasing apart
+     *    costs directly as a result of usage, as opposed to minimums and discounts at
+     *    the plan and price level.
+     * 4. Gain insight into key customer health metrics, such as the percent
+     *    utilization of the minimum committed spend.
+     *
+     * ## Fetching subscriptions
+     *
+     * By default, this endpoint fetches the currently active subscription for the
+     * customer, and returns cost information for the subscription's current billing
+     * period, broken down by each participating price. If there are no currently
+     * active subscriptions, this will instead default to the most recently active
+     * subscription or return an empty series if none are found. For example, if your
+     * plan charges for compute hours, job runs, and data syncs, then this endpoint
+     * would provide a daily breakdown of your customer's cost for each of those axes.
+     *
+     * If timeframe bounds are specified, Orb fetches all subscriptions that were
+     * active in that timeframe. If two subscriptions overlap on a single day, costs
+     * from each price will be summed, and prices for both subscriptions will be
+     * included in the breakdown.
+     *
+     * ## Prepaid plans
+     *
+     * For plans that include prices which deduct credits rather than accrue in-arrears
+     * charges in a billable currency, this endpoint will return the total deduction
+     * amount, in credits, for the specified timeframe.
+     *
+     * ## Cumulative subtotals and totals
+     *
+     * Since the subtotal and total must factor in any billing-period level discounts
+     * and minimums, it's most meaningful to consider costs relative to the start of
+     * the subscription's billing period. As a result, by default this endpoint returns
+     * cumulative totals since the beginning of the billing period. In particular, the
+     * `timeframe_start` of a returned timeframe window is _always_ the beginning of
+     * the billing period and `timeframe_end` is incremented one day at a time to build
+     * the result.
+     *
+     * A customer that uses a few API calls a day but has a minimum commitment might
+     * exhibit the following pattern for their subtotal and total in the first few days
+     * of the month. Here, we assume that each API call is \$2.50, the customer's plan
+     * has a monthly minimum of \$50 for this price, and that the subscription's
+     * billing period bounds are aligned to the first of the month:
+     *
+     * | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |
+     * | --------------- | ------------- | ---------------- | -------- | ------------------------ |
+     * | 2023-02-01      | 2023-02-02    | 9                | \$22.50  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-03    | 19               | \$47.50  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-04    | 20               | \$50.00  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-05    | 28               | \$70.00  | \$70.00                  |
+     * | 2023-02-01      | 2023-02-06    | 36               | \$90.00  | \$90.00                  |
+     *
+     * ### Periodic values
+     *
+     * When the query parameter `view_mode=periodic` is specified, Orb will return an
+     * incremental day-by-day view of costs. In this case, there will always be a
+     * one-day difference between `timeframe_start` and `timeframe_end` for the
+     * timeframes returned. This is a transform on top of the cumulative costs,
+     * calculated by taking the difference of each timeframe with the last. Note that
+     * in the above example, the `Total` value would be 0 for the second two data
+     * points, since the minimum commitment has not yet been hit and each day is not
+     * contributing anything to the total cost.
+     *
+     * ## Timeframe bounds
+     *
+     * For an active subscription, both timeframes should be specified in the request.
+     * If a subscription starts or ends within the timeframe, the response will only
+     * include windows where the subscription is active. If a subscription has ended,
+     * no timeframe bounds need to be specified and the response will default to the
+     * billing period when the subscription was last active.
+     *
+     * As noted above, `timeframe_start` for a given cumulative datapoint is always the
+     * beginning of the billing period, and `timeframe_end` is incremented one day at a
+     * time to construct the response. When a timeframe is passed in that is not
+     * aligned to the current subscription's billing period, the response will contain
+     * cumulative totals from multiple billing periods.
+     *
+     * Suppose the queried customer has a subscription aligned to the 15th of every
+     * month. If this endpoint is queried with the date range `2023-06-01` -
+     * `2023-07-01`, the first data point will represent about half a billing period's
+     * worth of costs, accounting for accruals from the start of the billing period and
+     * inclusive of the first day of the timeframe
+     * (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`)
+     *
+     * | datapoint index | timeframe_start | timeframe_end |
+     * | --------------- | --------------- | ------------- |
+     * | 0               | 2023-05-15      | 2023-06-02    |
+     * | 1               | 2023-05-15      | 2023-06-03    |
+     * | 2               | ...             | ...           |
+     * | 3               | 2023-05-15      | 2023-06-14    |
+     * | 4               | 2023-06-15      | 2023-06-16    |
+     * | 5               | 2023-06-15      | 2023-06-17    |
+     * | 6               | ...             | ...           |
+     * | 7               | 2023-06-15      | 2023-07-01    |
+     *
+     * You can see this sliced timeframe visualized
+     * [here](https://i.imgur.com/TXhYgme.png).
+     *
+     * ### Matrix prices
+     *
+     * When a price uses matrix pricing, it's important to view costs grouped by those
+     * matrix dimensions. Orb will return `price_groups` with the `grouping_key` and
+     * `secondary_grouping_key` based on the matrix price definition, for each
+     * `grouping_value` and `secondary_grouping_value` available.
+     */
     list(customerId, query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list(customerId, {}, query);
-        }
-        return this._client.get(`/customers/${customerId}/costs`, { query, ...options });
+        return this._client.get(path `/customers/${customerId}/costs`, { query, ...options });
     }
-    listByExternalId(externalCustomerId, query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.listByExternalId(externalCustomerId, {}, query);
-        }
-        return this._client.get(`/customers/external_customer_id/${externalCustomerId}/costs`, {
+    /**
+     * This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
+     * Orb, calculated by applying pricing information to the underlying usage (see the
+     * [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+     * to fetch usage per metric, in usage units rather than a currency).
+     *
+     * This endpoint can be leveraged for internal tooling and to provide a more
+     * transparent billing experience for your end users:
+     *
+     * 1. Understand the cost breakdown per line item historically and in real-time for
+     *    the current billing period.
+     * 2. Provide customer visibility into how different services are contributing to
+     *    the overall invoice with a per-day timeseries (as compared to the
+     *    [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+     *    which represents a snapshot for the current period).
+     * 3. Assess how minimums and discounts affect your customers by teasing apart
+     *    costs directly as a result of usage, as opposed to minimums and discounts at
+     *    the plan and price level.
+     * 4. Gain insight into key customer health metrics, such as the percent
+     *    utilization of the minimum committed spend.
+     *
+     * ## Fetching subscriptions
+     *
+     * By default, this endpoint fetches the currently active subscription for the
+     * customer, and returns cost information for the subscription's current billing
+     * period, broken down by each participating price. If there are no currently
+     * active subscriptions, this will instead default to the most recently active
+     * subscription or return an empty series if none are found. For example, if your
+     * plan charges for compute hours, job runs, and data syncs, then this endpoint
+     * would provide a daily breakdown of your customer's cost for each of those axes.
+     *
+     * If timeframe bounds are specified, Orb fetches all subscriptions that were
+     * active in that timeframe. If two subscriptions overlap on a single day, costs
+     * from each price will be summed, and prices for both subscriptions will be
+     * included in the breakdown.
+     *
+     * ## Prepaid plans
+     *
+     * For plans that include prices which deduct credits rather than accrue in-arrears
+     * charges in a billable currency, this endpoint will return the total deduction
+     * amount, in credits, for the specified timeframe.
+     *
+     * ## Cumulative subtotals and totals
+     *
+     * Since the subtotal and total must factor in any billing-period level discounts
+     * and minimums, it's most meaningful to consider costs relative to the start of
+     * the subscription's billing period. As a result, by default this endpoint returns
+     * cumulative totals since the beginning of the billing period. In particular, the
+     * `timeframe_start` of a returned timeframe window is _always_ the beginning of
+     * the billing period and `timeframe_end` is incremented one day at a time to build
+     * the result.
+     *
+     * A customer that uses a few API calls a day but has a minimum commitment might
+     * exhibit the following pattern for their subtotal and total in the first few days
+     * of the month. Here, we assume that each API call is \$2.50, the customer's plan
+     * has a monthly minimum of \$50 for this price, and that the subscription's
+     * billing period bounds are aligned to the first of the month:
+     *
+     * | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |
+     * | --------------- | ------------- | ---------------- | -------- | ------------------------ |
+     * | 2023-02-01      | 2023-02-02    | 9                | \$22.50  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-03    | 19               | \$47.50  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-04    | 20               | \$50.00  | \$50.00                  |
+     * | 2023-02-01      | 2023-02-05    | 28               | \$70.00  | \$70.00                  |
+     * | 2023-02-01      | 2023-02-06    | 36               | \$90.00  | \$90.00                  |
+     *
+     * ### Periodic values
+     *
+     * When the query parameter `view_mode=periodic` is specified, Orb will return an
+     * incremental day-by-day view of costs. In this case, there will always be a
+     * one-day difference between `timeframe_start` and `timeframe_end` for the
+     * timeframes returned. This is a transform on top of the cumulative costs,
+     * calculated by taking the difference of each timeframe with the last. Note that
+     * in the above example, the `Total` value would be 0 for the second two data
+     * points, since the minimum commitment has not yet been hit and each day is not
+     * contributing anything to the total cost.
+     *
+     * ## Timeframe bounds
+     *
+     * For an active subscription, both timeframes should be specified in the request.
+     * If a subscription starts or ends within the timeframe, the response will only
+     * include windows where the subscription is active. If a subscription has ended,
+     * no timeframe bounds need to be specified and the response will default to the
+     * billing period when the subscription was last active.
+     *
+     * As noted above, `timeframe_start` for a given cumulative datapoint is always the
+     * beginning of the billing period, and `timeframe_end` is incremented one day at a
+     * time to construct the response. When a timeframe is passed in that is not
+     * aligned to the current subscription's billing period, the response will contain
+     * cumulative totals from multiple billing periods.
+     *
+     * Suppose the queried customer has a subscription aligned to the 15th of every
+     * month. If this endpoint is queried with the date range `2023-06-01` -
+     * `2023-07-01`, the first data point will represent about half a billing period's
+     * worth of costs, accounting for accruals from the start of the billing period and
+     * inclusive of the first day of the timeframe
+     * (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`)
+     *
+     * | datapoint index | timeframe_start | timeframe_end |
+     * | --------------- | --------------- | ------------- |
+     * | 0               | 2023-05-15      | 2023-06-02    |
+     * | 1               | 2023-05-15      | 2023-06-03    |
+     * | 2               | ...             | ...           |
+     * | 3               | 2023-05-15      | 2023-06-14    |
+     * | 4               | 2023-06-15      | 2023-06-16    |
+     * | 5               | 2023-06-15      | 2023-06-17    |
+     * | 6               | ...             | ...           |
+     * | 7               | 2023-06-15      | 2023-07-01    |
+     *
+     * You can see this sliced timeframe visualized
+     * [here](https://i.imgur.com/TXhYgme.png).
+     *
+     * ### Matrix prices
+     *
+     * When a price uses matrix pricing, it's important to view costs grouped by those
+     * matrix dimensions. Orb will return `price_groups` with the `grouping_key` and
+     * `secondary_grouping_key` based on the matrix price definition, for each
+     * `grouping_value` and `secondary_grouping_value` available.
+     */
+    listByExternalID(externalCustomerId, query = {}, options) {
+        return this._client.get(path `/customers/external_customer_id/${externalCustomerId}/costs`, {
             query,
             ...options,
         });

package/resources/customers/costs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"costs.mjs","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IA8HpC,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAkID,gBAAgB,CACd,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,QAAQ,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"costs.mjs","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,IAAI,CACF,UAAkB,EAClB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,gBAAgB,CACd,kBAA0B,EAC1B,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mCAAmC,kBAAkB,QAAQ,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,287 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as Shared from "../../shared.mjs";
+import * as LedgerAPI from "./ledger.mjs";
+import { AffectedBlock, AmendmentLedgerEntry, CreditBlockExpiryLedgerEntry, DecrementLedgerEntry, ExpirationChangeLedgerEntry, IncrementLedgerEntry, Ledger, LedgerCreateEntryByExternalIDParams, LedgerCreateEntryByExternalIDResponse, LedgerCreateEntryParams, LedgerCreateEntryResponse, LedgerListByExternalIDParams, LedgerListByExternalIDResponse, LedgerListByExternalIDResponsesPage, LedgerListParams, LedgerListResponse, LedgerListResponsesPage, VoidInitiatedLedgerEntry, VoidLedgerEntry } from "./ledger.mjs";
+import * as TopUpsAPI from "./top-ups.mjs";
+import { TopUpCreateByExternalIDParams, TopUpCreateByExternalIDResponse, TopUpCreateParams, TopUpCreateResponse, TopUpDeleteByExternalIDParams, TopUpDeleteParams, TopUpInvoiceSettings, TopUpListByExternalIDParams, TopUpListByExternalIDResponse, TopUpListByExternalIDResponsesPage, TopUpListParams, TopUpListResponse, TopUpListResponsesPage, TopUps } from "./top-ups.mjs";
+import { Page, type PageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+ */
+export declare class Credits extends APIResource {
+    ledger: LedgerAPI.Ledger;
+    topUps: TopUpsAPI.TopUps;
+    /**
+     * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
+     *
+     * If `include_all_blocks` is set to `true`, all credit blocks (including expired
+     * and depleted blocks) will be included in the response.
+     *
+     * Note that `currency` defaults to credits if not specified. To use a real world
+     * currency, set `currency` to an ISO 4217 string.
+     *
+     * Results can be filtered by the block's `effective_date` using the
+     * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+     * `effective_date[lte]` query parameters. This filters on when the credit block
+     * becomes effective, which may differ from creation time for backdated credits.
+     */
+    list(customerId: string, query?: CreditListParams | null | undefined, options?: RequestOptions): PagePromise<CreditListResponsesPage, CreditListResponse>;
+    /**
+     * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
+     *
+     * If `include_all_blocks` is set to `true`, all credit blocks (including expired
+     * and depleted blocks) will be included in the response.
+     *
+     * Note that `currency` defaults to credits if not specified. To use a real world
+     * currency, set `currency` to an ISO 4217 string.
+     *
+     * Results can be filtered by the block's `effective_date` using the
+     * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+     * `effective_date[lte]` query parameters. This filters on when the credit block
+     * becomes effective, which may differ from creation time for backdated credits.
+     */
+    listByExternalID(externalCustomerId: string, query?: CreditListByExternalIDParams | null | undefined, options?: RequestOptions): PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
+}
+export type CreditListResponsesPage = Page<CreditListResponse>;
+export type CreditListByExternalIDResponsesPage = Page<CreditListByExternalIDResponse>;
+export interface CreditListResponse {
+    id: string;
+    balance: number;
+    /**
+     * How this credit block was created: `allocation` (a subscription's recurring
+     * credit allocation), `top_up` (an automatic balance-threshold top-up),
+     * `commitment` (a subscription commitment true-up rolled forward as credit), or
+     * `manual` (a manual credit ledger increment, including credits voided or expired
+     * off another block).
+     */
+    credit_block_source: 'allocation' | 'top_up' | 'commitment' | 'manual';
+    effective_date: string | null;
+    expiry_date: string | null;
+    filters: Array<CreditListResponse.Filter>;
+    maximum_initial_balance: number | null;
+    /**
+     * User specified key-value pairs for the resource. If not present, this defaults
+     * to an empty dictionary. Individual keys can be removed by setting the value to
+     * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+     * `null`.
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    per_unit_cost_basis: string | null;
+    status: 'active' | 'pending_payment';
+    /**
+     * The credit allocation that funded a block. Extends the allocation resource
+     * serialized on prices with the catalog-item attribution of the funding price.
+     */
+    credit_allocation?: CreditListResponse.CreditAllocation | null;
+    /**
+     * The subscription commitment whose true-up rolled forward into this credit block.
+     * Present only when `credit_block_source` is `commitment`.
+     */
+    credit_commitment?: CreditListResponse.CreditCommitment | null;
+}
+export declare namespace CreditListResponse {
+    /**
+     * A PriceFilter that only allows item_id field for block filters.
+     */
+    interface Filter {
+        /**
+         * The property of the price the block applies to. Only item_id is supported.
+         */
+        field: 'item_id';
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+    }
+    /**
+     * The credit allocation that funded a block. Extends the allocation resource
+     * serialized on prices with the catalog-item attribution of the funding price.
+     */
+    interface CreditAllocation {
+        allows_rollover: boolean;
+        currency: string;
+        custom_expiration: Shared.CustomExpiration | null;
+        /**
+         * The ID of the catalog item this block was allocated from, derived from the
+         * allocation's price.
+         */
+        item_id: string;
+        filters?: Array<CreditAllocation.Filter>;
+        license_type_id?: string | null;
+    }
+    namespace CreditAllocation {
+        interface Filter {
+            /**
+             * The property of the price to filter on.
+             */
+            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+            /**
+             * Should prices that match the filter be included or excluded.
+             */
+            operator: 'includes' | 'excludes';
+            /**
+             * The IDs or values that match this filter.
+             */
+            values: Array<string>;
+        }
+    }
+    /**
+     * The subscription commitment whose true-up rolled forward into this credit block.
+     * Present only when `credit_block_source` is `commitment`.
+     */
+    interface CreditCommitment {
+        /**
+         * The ID of the subscription commitment this block was rolled forward from.
+         */
+        id: string;
+        /**
+         * The subscription the commitment belongs to.
+         */
+        subscription_id?: string | null;
+    }
+}
+export interface CreditListByExternalIDResponse {
+    id: string;
+    balance: number;
+    /**
+     * How this credit block was created: `allocation` (a subscription's recurring
+     * credit allocation), `top_up` (an automatic balance-threshold top-up),
+     * `commitment` (a subscription commitment true-up rolled forward as credit), or
+     * `manual` (a manual credit ledger increment, including credits voided or expired
+     * off another block).
+     */
+    credit_block_source: 'allocation' | 'top_up' | 'commitment' | 'manual';
+    effective_date: string | null;
+    expiry_date: string | null;
+    filters: Array<CreditListByExternalIDResponse.Filter>;
+    maximum_initial_balance: number | null;
+    /**
+     * User specified key-value pairs for the resource. If not present, this defaults
+     * to an empty dictionary. Individual keys can be removed by setting the value to
+     * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+     * `null`.
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    per_unit_cost_basis: string | null;
+    status: 'active' | 'pending_payment';
+    /**
+     * The credit allocation that funded a block. Extends the allocation resource
+     * serialized on prices with the catalog-item attribution of the funding price.
+     */
+    credit_allocation?: CreditListByExternalIDResponse.CreditAllocation | null;
+    /**
+     * The subscription commitment whose true-up rolled forward into this credit block.
+     * Present only when `credit_block_source` is `commitment`.
+     */
+    credit_commitment?: CreditListByExternalIDResponse.CreditCommitment | null;
+}
+export declare namespace CreditListByExternalIDResponse {
+    /**
+     * A PriceFilter that only allows item_id field for block filters.
+     */
+    interface Filter {
+        /**
+         * The property of the price the block applies to. Only item_id is supported.
+         */
+        field: 'item_id';
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+    }
+    /**
+     * The credit allocation that funded a block. Extends the allocation resource
+     * serialized on prices with the catalog-item attribution of the funding price.
+     */
+    interface CreditAllocation {
+        allows_rollover: boolean;
+        currency: string;
+        custom_expiration: Shared.CustomExpiration | null;
+        /**
+         * The ID of the catalog item this block was allocated from, derived from the
+         * allocation's price.
+         */
+        item_id: string;
+        filters?: Array<CreditAllocation.Filter>;
+        license_type_id?: string | null;
+    }
+    namespace CreditAllocation {
+        interface Filter {
+            /**
+             * The property of the price to filter on.
+             */
+            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+            /**
+             * Should prices that match the filter be included or excluded.
+             */
+            operator: 'includes' | 'excludes';
+            /**
+             * The IDs or values that match this filter.
+             */
+            values: Array<string>;
+        }
+    }
+    /**
+     * The subscription commitment whose true-up rolled forward into this credit block.
+     * Present only when `credit_block_source` is `commitment`.
+     */
+    interface CreditCommitment {
+        /**
+         * The ID of the subscription commitment this block was rolled forward from.
+         */
+        id: string;
+        /**
+         * The subscription the commitment belongs to.
+         */
+        subscription_id?: string | null;
+    }
+}
+export interface CreditListParams extends PageParams {
+    /**
+     * The ledger currency or custom pricing unit to use.
+     */
+    currency?: string | null;
+    'effective_date[gt]'?: string | null;
+    'effective_date[gte]'?: string | null;
+    'effective_date[lt]'?: string | null;
+    'effective_date[lte]'?: string | null;
+    /**
+     * If set to True, all expired and depleted blocks, as well as active block will be
+     * returned.
+     */
+    include_all_blocks?: boolean;
+}
+export interface CreditListByExternalIDParams extends PageParams {
+    /**
+     * The ledger currency or custom pricing unit to use.
+     */
+    currency?: string | null;
+    'effective_date[gt]'?: string | null;
+    'effective_date[gte]'?: string | null;
+    'effective_date[lt]'?: string | null;
+    'effective_date[lte]'?: string | null;
+    /**
+     * If set to True, all expired and depleted blocks, as well as active block will be
+     * returned.
+     */
+    include_all_blocks?: boolean;
+}
+export declare namespace Credits {
+    export { type CreditListResponse as CreditListResponse, type CreditListByExternalIDResponse as CreditListByExternalIDResponse, type CreditListResponsesPage as CreditListResponsesPage, type CreditListByExternalIDResponsesPage as CreditListByExternalIDResponsesPage, type CreditListParams as CreditListParams, type CreditListByExternalIDParams as CreditListByExternalIDParams, };
+    export { Ledger as Ledger, type AffectedBlock as AffectedBlock, type AmendmentLedgerEntry as AmendmentLedgerEntry, type CreditBlockExpiryLedgerEntry as CreditBlockExpiryLedgerEntry, type DecrementLedgerEntry as DecrementLedgerEntry, type ExpirationChangeLedgerEntry as ExpirationChangeLedgerEntry, type IncrementLedgerEntry as IncrementLedgerEntry, type VoidInitiatedLedgerEntry as VoidInitiatedLedgerEntry, type VoidLedgerEntry as VoidLedgerEntry, type LedgerListResponse as LedgerListResponse, type LedgerCreateEntryResponse as LedgerCreateEntryResponse, type LedgerCreateEntryByExternalIDResponse as LedgerCreateEntryByExternalIDResponse, type LedgerListByExternalIDResponse as LedgerListByExternalIDResponse, type LedgerListResponsesPage as LedgerListResponsesPage, type LedgerListByExternalIDResponsesPage as LedgerListByExternalIDResponsesPage, type LedgerListParams as LedgerListParams, type LedgerCreateEntryParams as LedgerCreateEntryParams, type LedgerCreateEntryByExternalIDParams as LedgerCreateEntryByExternalIDParams, type LedgerListByExternalIDParams as LedgerListByExternalIDParams, };
+    export { TopUps as TopUps, type TopUpInvoiceSettings as TopUpInvoiceSettings, type TopUpCreateResponse as TopUpCreateResponse, type TopUpListResponse as TopUpListResponse, type TopUpCreateByExternalIDResponse as TopUpCreateByExternalIDResponse, type TopUpListByExternalIDResponse as TopUpListByExternalIDResponse, type TopUpListResponsesPage as TopUpListResponsesPage, type TopUpListByExternalIDResponsesPage as TopUpListByExternalIDResponsesPage, type TopUpCreateParams as TopUpCreateParams, type TopUpListParams as TopUpListParams, type TopUpDeleteParams as TopUpDeleteParams, type TopUpCreateByExternalIDParams as TopUpCreateByExternalIDParams, type TopUpDeleteByExternalIDParams as TopUpDeleteByExternalIDParams, type TopUpListByExternalIDParams as TopUpListByExternalIDParams, };
+}
+//# sourceMappingURL=credits.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,4BAA4B,EAC5B,oBAAoB,EACpB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,EACN,mCAAmC,EACnC,qCAAqC,EACrC,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mCAAmC,EACnC,gBAAgB,EAChB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,qBAAiB;AAClB,OAAO,KAAK,SAAS,sBAAkB;AACvC,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,iBAAiB,EACjB,mBAAmB,EACnB,6BAA6B,EAC7B,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,kCAAkC,EAClC,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,EACP,sBAAkB;AACnB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,qCAAiC;AAC9E,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAO3D;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAOpF;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,8BAA8B,CAAC,CAAC;AAEvF,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,mBAAmB,EAAE,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;IAEvE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE1C,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;IAErC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAChE;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,SAAS,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B,eAAe,EAAE,OAAO,CAAC;QAEzB,QAAQ,EAAE,MAAM,CAAC;QAEjB,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAElD;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEzC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;YAE9E;;eAEG;YACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;KACF;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,mBAAmB,EAAE,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;IAEvE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAEtD,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;IAErC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,8BAA8B,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE3E;;;OAGG;IACH,iBAAiB,CAAC,EAAE,8BAA8B,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,SAAS,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B,eAAe,EAAE,OAAO,CAAC;QAEzB,QAAQ,EAAE,MAAM,CAAC;QAEjB,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAElD;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEzC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;YAE9E;;eAEG;YACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;KACF;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

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

@@ -1,11 +1,11 @@
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
 import * as LedgerAPI from "./ledger.js";
 import { AffectedBlock, AmendmentLedgerEntry, CreditBlockExpiryLedgerEntry, DecrementLedgerEntry, ExpirationChangeLedgerEntry, IncrementLedgerEntry, Ledger, LedgerCreateEntryByExternalIDParams, LedgerCreateEntryByExternalIDResponse, LedgerCreateEntryParams, LedgerCreateEntryResponse, LedgerListByExternalIDParams, LedgerListByExternalIDResponse, LedgerListByExternalIDResponsesPage, LedgerListParams, LedgerListResponse, LedgerListResponsesPage, VoidInitiatedLedgerEntry, VoidLedgerEntry } from "./ledger.js";
 import * as TopUpsAPI from "./top-ups.js";
-import { TopUpCreateByExternalIDParams, TopUpCreateByExternalIDResponse, TopUpCreateParams, TopUpCreateResponse, TopUpInvoiceSettings, TopUpListByExternalIDParams, TopUpListByExternalIDResponse, TopUpListByExternalIDResponsesPage, TopUpListParams, TopUpListResponse, TopUpListResponsesPage, TopUps } from "./top-ups.js";
-import { Page, type PageParams } from "../../../pagination.js";
+import { TopUpCreateByExternalIDParams, TopUpCreateByExternalIDResponse, TopUpCreateParams, TopUpCreateResponse, TopUpDeleteByExternalIDParams, TopUpDeleteParams, TopUpInvoiceSettings, TopUpListByExternalIDParams, TopUpListByExternalIDResponse, TopUpListByExternalIDResponsesPage, TopUpListParams, TopUpListResponse, TopUpListResponsesPage, TopUps } from "./top-ups.js";
+import { Page, type PageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 /**
  * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
  */
@@ -26,8 +26,7 @@ export declare class Credits extends APIResource {
      * `effective_date[lte]` query parameters. This filters on when the credit block
      * becomes effective, which may differ from creation time for backdated credits.
      */
-    list(customerId: string, query?: CreditListParams, options?: Core.RequestOptions): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
-    list(customerId: string, options?: Core.RequestOptions): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
+    list(customerId: string, query?: CreditListParams | null | undefined, options?: RequestOptions): PagePromise<CreditListResponsesPage, CreditListResponse>;
     /**
      * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
      *
@@ -42,13 +41,10 @@ export declare class Credits extends APIResource {
      * `effective_date[lte]` query parameters. This filters on when the credit block
      * becomes effective, which may differ from creation time for backdated credits.
      */
-    listByExternalId(externalCustomerId: string, query?: CreditListByExternalIDParams, options?: Core.RequestOptions): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
-    listByExternalId(externalCustomerId: string, options?: Core.RequestOptions): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
-}
-export declare class CreditListResponsesPage extends Page<CreditListResponse> {
-}
-export declare class CreditListByExternalIDResponsesPage extends Page<CreditListByExternalIDResponse> {
+    listByExternalID(externalCustomerId: string, query?: CreditListByExternalIDParams | null | undefined, options?: RequestOptions): PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
 }
+export type CreditListResponsesPage = Page<CreditListResponse>;
+export type CreditListByExternalIDResponsesPage = Page<CreditListByExternalIDResponse>;
 export interface CreditListResponse {
     id: string;
     balance: number;
@@ -284,8 +280,8 @@ export interface CreditListByExternalIDParams extends PageParams {
     include_all_blocks?: boolean;
 }
 export declare namespace Credits {
-    export { type CreditListResponse as CreditListResponse, type CreditListByExternalIDResponse as CreditListByExternalIDResponse, CreditListResponsesPage as CreditListResponsesPage, CreditListByExternalIDResponsesPage as CreditListByExternalIDResponsesPage, type CreditListParams as CreditListParams, type CreditListByExternalIDParams as CreditListByExternalIDParams, };
-    export { Ledger as Ledger, type AffectedBlock as AffectedBlock, type AmendmentLedgerEntry as AmendmentLedgerEntry, type CreditBlockExpiryLedgerEntry as CreditBlockExpiryLedgerEntry, type DecrementLedgerEntry as DecrementLedgerEntry, type ExpirationChangeLedgerEntry as ExpirationChangeLedgerEntry, type IncrementLedgerEntry as IncrementLedgerEntry, type VoidInitiatedLedgerEntry as VoidInitiatedLedgerEntry, type VoidLedgerEntry as VoidLedgerEntry, type LedgerListResponse as LedgerListResponse, type LedgerCreateEntryResponse as LedgerCreateEntryResponse, type LedgerCreateEntryByExternalIDResponse as LedgerCreateEntryByExternalIDResponse, type LedgerListByExternalIDResponse as LedgerListByExternalIDResponse, LedgerListResponsesPage as LedgerListResponsesPage, LedgerListByExternalIDResponsesPage as LedgerListByExternalIDResponsesPage, type LedgerListParams as LedgerListParams, type LedgerCreateEntryParams as LedgerCreateEntryParams, type LedgerCreateEntryByExternalIDParams as LedgerCreateEntryByExternalIDParams, type LedgerListByExternalIDParams as LedgerListByExternalIDParams, };
-    export { TopUps as TopUps, type TopUpInvoiceSettings as TopUpInvoiceSettings, type TopUpCreateResponse as TopUpCreateResponse, type TopUpListResponse as TopUpListResponse, type TopUpCreateByExternalIDResponse as TopUpCreateByExternalIDResponse, type TopUpListByExternalIDResponse as TopUpListByExternalIDResponse, TopUpListResponsesPage as TopUpListResponsesPage, TopUpListByExternalIDResponsesPage as TopUpListByExternalIDResponsesPage, type TopUpCreateParams as TopUpCreateParams, type TopUpListParams as TopUpListParams, type TopUpCreateByExternalIDParams as TopUpCreateByExternalIDParams, type TopUpListByExternalIDParams as TopUpListByExternalIDParams, };
+    export { type CreditListResponse as CreditListResponse, type CreditListByExternalIDResponse as CreditListByExternalIDResponse, type CreditListResponsesPage as CreditListResponsesPage, type CreditListByExternalIDResponsesPage as CreditListByExternalIDResponsesPage, type CreditListParams as CreditListParams, type CreditListByExternalIDParams as CreditListByExternalIDParams, };
+    export { Ledger as Ledger, type AffectedBlock as AffectedBlock, type AmendmentLedgerEntry as AmendmentLedgerEntry, type CreditBlockExpiryLedgerEntry as CreditBlockExpiryLedgerEntry, type DecrementLedgerEntry as DecrementLedgerEntry, type ExpirationChangeLedgerEntry as ExpirationChangeLedgerEntry, type IncrementLedgerEntry as IncrementLedgerEntry, type VoidInitiatedLedgerEntry as VoidInitiatedLedgerEntry, type VoidLedgerEntry as VoidLedgerEntry, type LedgerListResponse as LedgerListResponse, type LedgerCreateEntryResponse as LedgerCreateEntryResponse, type LedgerCreateEntryByExternalIDResponse as LedgerCreateEntryByExternalIDResponse, type LedgerListByExternalIDResponse as LedgerListByExternalIDResponse, type LedgerListResponsesPage as LedgerListResponsesPage, type LedgerListByExternalIDResponsesPage as LedgerListByExternalIDResponsesPage, type LedgerListParams as LedgerListParams, type LedgerCreateEntryParams as LedgerCreateEntryParams, type LedgerCreateEntryByExternalIDParams as LedgerCreateEntryByExternalIDParams, type LedgerListByExternalIDParams as LedgerListByExternalIDParams, };
+    export { TopUps as TopUps, type TopUpInvoiceSettings as TopUpInvoiceSettings, type TopUpCreateResponse as TopUpCreateResponse, type TopUpListResponse as TopUpListResponse, type TopUpCreateByExternalIDResponse as TopUpCreateByExternalIDResponse, type TopUpListByExternalIDResponse as TopUpListByExternalIDResponse, type TopUpListResponsesPage as TopUpListResponsesPage, type TopUpListByExternalIDResponsesPage as TopUpListByExternalIDResponsesPage, type TopUpCreateParams as TopUpCreateParams, type TopUpListParams as TopUpListParams, type TopUpDeleteParams as TopUpDeleteParams, type TopUpCreateByExternalIDParams as TopUpCreateByExternalIDParams, type TopUpDeleteByExternalIDParams as TopUpDeleteByExternalIDParams, type TopUpListByExternalIDParams as TopUpListByExternalIDParams, };
 }
 //# sourceMappingURL=credits.d.ts.map