orb-billing 4.74.0 → 5.0.0

package/src/resources/customers/credits/ledger.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
-import * as InvoicesAPI from '../../invoices';
+import * as Shared from '../../shared';
 import { Page, type PageParams } from '../../../pagination';
 
 export class Ledger extends APIResource {
@@ -468,1557 +468,326 @@ export class LedgerListResponsesPage extends Page<LedgerListResponse> {}
 
 export class LedgerListByExternalIDResponsesPage extends Page<LedgerListByExternalIDResponse> {}
 
-/**
- * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
- * credits within Orb.
- */
-export type LedgerListResponse =
-  | LedgerListResponse.IncrementLedgerEntry
-  | LedgerListResponse.DecrementLedgerEntry
-  | LedgerListResponse.ExpirationChangeLedgerEntry
-  | LedgerListResponse.CreditBlockExpiryLedgerEntry
-  | LedgerListResponse.VoidLedgerEntry
-  | LedgerListResponse.VoidInitiatedLedgerEntry
-  | LedgerListResponse.AmendmentLedgerEntry;
-
-export namespace LedgerListResponse {
-  export interface IncrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: IncrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: IncrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'increment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    /**
-     * If the increment resulted in invoice creation, the list of created invoices
-     */
-    created_invoices?: Array<InvoicesAPI.Invoice> | null;
-  }
-
-  export namespace IncrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface DecrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: DecrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: DecrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'decrement';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
+export interface AffectedBlock {
+  id: string;
 
-    event_id?: string | null;
+  expiry_date: string | null;
 
-    invoice_id?: string | null;
-
-    price_id?: string | null;
-  }
+  per_unit_cost_basis: string | null;
+}
 
-  export namespace DecrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+export interface AmendmentLedgerEntry {
+  id: string;
 
-      expiry_date: string | null;
+  amount: number;
 
-      per_unit_cost_basis: string | null;
-    }
+  created_at: string;
 
-    export interface Customer {
-      id: string;
+  credit_block: AffectedBlock;
 
-      external_customer_id: string | null;
-    }
-  }
+  currency: string;
 
-  export interface ExpirationChangeLedgerEntry {
-    id: string;
+  customer: Shared.CustomerMinified;
 
-    amount: number;
+  description: string | null;
 
-    created_at: string;
+  ending_balance: number;
 
-    credit_block: ExpirationChangeLedgerEntry.CreditBlock;
+  entry_status: 'committed' | 'pending';
 
-    currency: string;
+  entry_type: 'amendment';
 
-    customer: ExpirationChangeLedgerEntry.Customer;
+  ledger_sequence_number: number;
 
-    description: string | 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: Record<string, string>;
 
-    ending_balance: number;
+  starting_balance: number;
+}
 
-    entry_status: 'committed' | 'pending';
+export interface CreditBlockExpiryLedgerEntry {
+  id: string;
 
-    entry_type: 'expiration_change';
+  amount: number;
 
-    ledger_sequence_number: number;
+  created_at: string;
 
-    /**
-     * 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: Record<string, string>;
+  credit_block: AffectedBlock;
 
-    new_block_expiry_date: string | null;
+  currency: string;
 
-    starting_balance: number;
-  }
+  customer: Shared.CustomerMinified;
 
-  export namespace ExpirationChangeLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+  description: string | null;
 
-      expiry_date: string | null;
+  ending_balance: number;
 
-      per_unit_cost_basis: string | null;
-    }
+  entry_status: 'committed' | 'pending';
 
-    export interface Customer {
-      id: string;
+  entry_type: 'credit_block_expiry';
 
-      external_customer_id: string | null;
-    }
-  }
+  ledger_sequence_number: number;
 
-  export interface CreditBlockExpiryLedgerEntry {
-    id: string;
+  /**
+   * 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: Record<string, string>;
 
-    amount: number;
+  starting_balance: number;
+}
 
-    created_at: string;
+export interface DecrementLedgerEntry {
+  id: string;
 
-    credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
+  amount: number;
 
-    currency: string;
+  created_at: string;
 
-    customer: CreditBlockExpiryLedgerEntry.Customer;
+  credit_block: AffectedBlock;
 
-    description: string | null;
+  currency: string;
 
-    ending_balance: number;
+  customer: Shared.CustomerMinified;
 
-    entry_status: 'committed' | 'pending';
+  description: string | null;
 
-    entry_type: 'credit_block_expiry';
+  ending_balance: number;
 
-    ledger_sequence_number: number;
+  entry_status: 'committed' | 'pending';
 
-    /**
-     * 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: Record<string, string>;
+  entry_type: 'decrement';
 
-    starting_balance: number;
-  }
+  ledger_sequence_number: number;
 
-  export namespace CreditBlockExpiryLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+  /**
+   * 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: Record<string, string>;
 
-      expiry_date: string | null;
+  starting_balance: number;
 
-      per_unit_cost_basis: string | null;
-    }
+  event_id?: string | null;
 
-    export interface Customer {
-      id: string;
+  invoice_id?: string | null;
 
-      external_customer_id: string | null;
-    }
-  }
+  price_id?: string | null;
+}
 
-  export interface VoidLedgerEntry {
-    id: string;
+export interface ExpirationChangeLedgerEntry {
+  id: string;
 
-    amount: number;
+  amount: number;
 
-    created_at: string;
+  created_at: string;
 
-    credit_block: VoidLedgerEntry.CreditBlock;
+  credit_block: AffectedBlock;
 
-    currency: string;
+  currency: string;
 
-    customer: VoidLedgerEntry.Customer;
+  customer: Shared.CustomerMinified;
 
-    description: string | null;
+  description: string | null;
 
-    ending_balance: number;
+  ending_balance: number;
 
-    entry_status: 'committed' | 'pending';
+  entry_status: 'committed' | 'pending';
 
-    entry_type: 'void';
+  entry_type: 'expiration_change';
 
-    ledger_sequence_number: number;
+  ledger_sequence_number: number;
 
-    /**
-     * 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: Record<string, string>;
+  /**
+   * 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: Record<string, string>;
 
-    starting_balance: number;
+  new_block_expiry_date: string | null;
 
-    void_amount: number;
+  starting_balance: number;
+}
 
-    void_reason: string | null;
-  }
+export interface IncrementLedgerEntry {
+  id: string;
 
-  export namespace VoidLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+  amount: number;
 
-      expiry_date: string | null;
+  created_at: string;
 
-      per_unit_cost_basis: string | null;
-    }
+  credit_block: AffectedBlock;
 
-    export interface Customer {
-      id: string;
+  currency: string;
 
-      external_customer_id: string | null;
-    }
-  }
+  customer: Shared.CustomerMinified;
 
-  export interface VoidInitiatedLedgerEntry {
-    id: string;
+  description: string | null;
 
-    amount: number;
+  ending_balance: number;
 
-    created_at: string;
+  entry_status: 'committed' | 'pending';
 
-    credit_block: VoidInitiatedLedgerEntry.CreditBlock;
+  entry_type: 'increment';
 
-    currency: string;
+  ledger_sequence_number: number;
 
-    customer: VoidInitiatedLedgerEntry.Customer;
+  /**
+   * 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: Record<string, string>;
 
-    description: string | null;
+  starting_balance: number;
 
-    ending_balance: number;
+  /**
+   * If the increment resulted in invoice creation, the list of created invoices
+   */
+  created_invoices?: Array<Shared.Invoice> | null;
+}
 
-    entry_status: 'committed' | 'pending';
+export interface VoidInitiatedLedgerEntry {
+  id: string;
 
-    entry_type: 'void_initiated';
+  amount: number;
 
-    ledger_sequence_number: number;
+  created_at: string;
 
-    /**
-     * 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: Record<string, string>;
+  credit_block: AffectedBlock;
 
-    new_block_expiry_date: string;
+  currency: string;
 
-    starting_balance: number;
+  customer: Shared.CustomerMinified;
 
-    void_amount: number;
+  description: string | null;
 
-    void_reason: string | null;
-  }
+  ending_balance: number;
 
-  export namespace VoidInitiatedLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+  entry_status: 'committed' | 'pending';
 
-      expiry_date: string | null;
+  entry_type: 'void_initiated';
 
-      per_unit_cost_basis: string | null;
-    }
+  ledger_sequence_number: number;
 
-    export interface Customer {
-      id: string;
+  /**
+   * 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: Record<string, string>;
 
-      external_customer_id: string | null;
-    }
-  }
+  new_block_expiry_date: string;
 
-  export interface AmendmentLedgerEntry {
-    id: string;
+  starting_balance: number;
 
-    amount: number;
+  void_amount: number;
 
-    created_at: string;
+  void_reason: string | null;
+}
 
-    credit_block: AmendmentLedgerEntry.CreditBlock;
+export interface VoidLedgerEntry {
+  id: string;
 
-    currency: string;
+  amount: number;
 
-    customer: AmendmentLedgerEntry.Customer;
+  created_at: string;
 
-    description: string | null;
+  credit_block: AffectedBlock;
 
-    ending_balance: number;
+  currency: string;
 
-    entry_status: 'committed' | 'pending';
+  customer: Shared.CustomerMinified;
 
-    entry_type: 'amendment';
+  description: string | null;
 
-    ledger_sequence_number: number;
+  ending_balance: number;
 
-    /**
-     * 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: Record<string, string>;
+  entry_status: 'committed' | 'pending';
 
-    starting_balance: number;
-  }
+  entry_type: 'void';
 
-  export namespace AmendmentLedgerEntry {
-    export interface CreditBlock {
-      id: string;
+  ledger_sequence_number: number;
 
-      expiry_date: string | 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: Record<string, string>;
 
-      per_unit_cost_basis: string | null;
-    }
+  starting_balance: number;
 
-    export interface Customer {
-      id: string;
+  void_amount: number;
 
-      external_customer_id: string | null;
-    }
-  }
+  void_reason: string | null;
 }
 
 /**
  * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
  * credits within Orb.
  */
-export type LedgerCreateEntryResponse =
-  | LedgerCreateEntryResponse.IncrementLedgerEntry
-  | LedgerCreateEntryResponse.DecrementLedgerEntry
-  | LedgerCreateEntryResponse.ExpirationChangeLedgerEntry
-  | LedgerCreateEntryResponse.CreditBlockExpiryLedgerEntry
-  | LedgerCreateEntryResponse.VoidLedgerEntry
-  | LedgerCreateEntryResponse.VoidInitiatedLedgerEntry
-  | LedgerCreateEntryResponse.AmendmentLedgerEntry;
-
-export namespace LedgerCreateEntryResponse {
-  export interface IncrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: IncrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: IncrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'increment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    /**
-     * If the increment resulted in invoice creation, the list of created invoices
-     */
-    created_invoices?: Array<InvoicesAPI.Invoice> | null;
-  }
-
-  export namespace IncrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface DecrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: DecrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: DecrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'decrement';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    event_id?: string | null;
-
-    invoice_id?: string | null;
-
-    price_id?: string | null;
-  }
-
-  export namespace DecrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface ExpirationChangeLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: ExpirationChangeLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: ExpirationChangeLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'expiration_change';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string | null;
-
-    starting_balance: number;
-  }
-
-  export namespace ExpirationChangeLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface CreditBlockExpiryLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: CreditBlockExpiryLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'credit_block_expiry';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace CreditBlockExpiryLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    void_amount: number;
+export type LedgerListResponse =
+  | IncrementLedgerEntry
+  | DecrementLedgerEntry
+  | ExpirationChangeLedgerEntry
+  | CreditBlockExpiryLedgerEntry
+  | VoidLedgerEntry
+  | VoidInitiatedLedgerEntry
+  | AmendmentLedgerEntry;
 
-    void_reason: string | null;
-  }
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
+ */
+export type LedgerCreateEntryResponse =
+  | IncrementLedgerEntry
+  | DecrementLedgerEntry
+  | ExpirationChangeLedgerEntry
+  | CreditBlockExpiryLedgerEntry
+  | VoidLedgerEntry
+  | VoidInitiatedLedgerEntry
+  | AmendmentLedgerEntry;
 
-  export namespace VoidLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidInitiatedLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidInitiatedLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidInitiatedLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void_initiated';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string;
-
-    starting_balance: number;
-
-    void_amount: number;
-
-    void_reason: string | null;
-  }
-
-  export namespace VoidInitiatedLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface AmendmentLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: AmendmentLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: AmendmentLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'amendment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace AmendmentLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-}
-
-/**
- * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
- * credits within Orb.
- */
-export type LedgerCreateEntryByExternalIDResponse =
-  | LedgerCreateEntryByExternalIDResponse.IncrementLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.DecrementLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.ExpirationChangeLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.CreditBlockExpiryLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.VoidLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.VoidInitiatedLedgerEntry
-  | LedgerCreateEntryByExternalIDResponse.AmendmentLedgerEntry;
-
-export namespace LedgerCreateEntryByExternalIDResponse {
-  export interface IncrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: IncrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: IncrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'increment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    /**
-     * If the increment resulted in invoice creation, the list of created invoices
-     */
-    created_invoices?: Array<InvoicesAPI.Invoice> | null;
-  }
-
-  export namespace IncrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface DecrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: DecrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: DecrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'decrement';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    event_id?: string | null;
-
-    invoice_id?: string | null;
-
-    price_id?: string | null;
-  }
-
-  export namespace DecrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface ExpirationChangeLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: ExpirationChangeLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: ExpirationChangeLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'expiration_change';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string | null;
-
-    starting_balance: number;
-  }
-
-  export namespace ExpirationChangeLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface CreditBlockExpiryLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: CreditBlockExpiryLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'credit_block_expiry';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace CreditBlockExpiryLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    void_amount: number;
-
-    void_reason: string | null;
-  }
-
-  export namespace VoidLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidInitiatedLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidInitiatedLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidInitiatedLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void_initiated';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string;
-
-    starting_balance: number;
-
-    void_amount: number;
-
-    void_reason: string | null;
-  }
-
-  export namespace VoidInitiatedLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface AmendmentLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: AmendmentLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: AmendmentLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'amendment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace AmendmentLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-}
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
+ */
+export type LedgerCreateEntryByExternalIDResponse =
+  | IncrementLedgerEntry
+  | DecrementLedgerEntry
+  | ExpirationChangeLedgerEntry
+  | CreditBlockExpiryLedgerEntry
+  | VoidLedgerEntry
+  | VoidInitiatedLedgerEntry
+  | AmendmentLedgerEntry;
 
 /**
  * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
  * credits within Orb.
  */
 export type LedgerListByExternalIDResponse =
-  | LedgerListByExternalIDResponse.IncrementLedgerEntry
-  | LedgerListByExternalIDResponse.DecrementLedgerEntry
-  | LedgerListByExternalIDResponse.ExpirationChangeLedgerEntry
-  | LedgerListByExternalIDResponse.CreditBlockExpiryLedgerEntry
-  | LedgerListByExternalIDResponse.VoidLedgerEntry
-  | LedgerListByExternalIDResponse.VoidInitiatedLedgerEntry
-  | LedgerListByExternalIDResponse.AmendmentLedgerEntry;
-
-export namespace LedgerListByExternalIDResponse {
-  export interface IncrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: IncrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: IncrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'increment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    /**
-     * If the increment resulted in invoice creation, the list of created invoices
-     */
-    created_invoices?: Array<InvoicesAPI.Invoice> | null;
-  }
-
-  export namespace IncrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface DecrementLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: DecrementLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: DecrementLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'decrement';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    event_id?: string | null;
-
-    invoice_id?: string | null;
-
-    price_id?: string | null;
-  }
-
-  export namespace DecrementLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface ExpirationChangeLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: ExpirationChangeLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: ExpirationChangeLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'expiration_change';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string | null;
-
-    starting_balance: number;
-  }
-
-  export namespace ExpirationChangeLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface CreditBlockExpiryLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: CreditBlockExpiryLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'credit_block_expiry';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace CreditBlockExpiryLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-
-    void_amount: number;
-
-    void_reason: string | null;
-  }
-
-  export namespace VoidLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface VoidInitiatedLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: VoidInitiatedLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: VoidInitiatedLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'void_initiated';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    new_block_expiry_date: string;
-
-    starting_balance: number;
-
-    void_amount: number;
-
-    void_reason: string | null;
-  }
-
-  export namespace VoidInitiatedLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface AmendmentLedgerEntry {
-    id: string;
-
-    amount: number;
-
-    created_at: string;
-
-    credit_block: AmendmentLedgerEntry.CreditBlock;
-
-    currency: string;
-
-    customer: AmendmentLedgerEntry.Customer;
-
-    description: string | null;
-
-    ending_balance: number;
-
-    entry_status: 'committed' | 'pending';
-
-    entry_type: 'amendment';
-
-    ledger_sequence_number: number;
-
-    /**
-     * 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: Record<string, string>;
-
-    starting_balance: number;
-  }
-
-  export namespace AmendmentLedgerEntry {
-    export interface CreditBlock {
-      id: string;
-
-      expiry_date: string | null;
-
-      per_unit_cost_basis: string | null;
-    }
-
-    export interface Customer {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-}
+  | IncrementLedgerEntry
+  | DecrementLedgerEntry
+  | ExpirationChangeLedgerEntry
+  | CreditBlockExpiryLedgerEntry
+  | VoidLedgerEntry
+  | VoidInitiatedLedgerEntry
+  | AmendmentLedgerEntry;
 
 export interface LedgerListParams extends PageParams {
   'created_at[gt]'?: string | null;
@@ -2585,6 +1354,14 @@ Ledger.LedgerListByExternalIDResponsesPage = LedgerListByExternalIDResponsesPage
 
 export declare namespace Ledger {
   export {
+    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,