Interface ListCarriersQueryParams

Hierarchy

  • ListCarriersQueryParams

Properties

includeBalance? includeExtendedDetails? isWallet?

Properties

Optional includeBalance

includeBalance?: boolean

Include account balance information in the response.

Default

true

Optional includeExtendedDetails

includeExtendedDetails?: boolean

Include extended carrier details (packages and advanced options) in the response. Setting to false reduces payload size by approximately 80%.

Default

true

Optional isWallet

isWallet?: boolean

Filter carriers by wallet type.

  • true: Returns only wallet carriers (carriers with fundingSourceId)
  • false: Returns only BYOA carriers (carriers without fundingSourceId)
  • undefined: Returns all carriers (default behavior)

Settings

Member Visibility

Theme

Generated using TypeDoc