PlanSearchFilters

Optional filters to narrow down plan search results. All filters are optional - if not specified, all matching plans are returned.

  • categoryTypes
    Type: array string[] | null

    Filter by component coverage categories. Only returns plans that cover specified categories. Values: "Engine", "TurboSuper", "TransferCase", "Steering", "Transmission", "DriveAxle", "Suspension", "AirCon", "Brakes", "Electricals", "Cooling", "Fuel", "Hybrid", "Body", "Consumables", "Exhaust", "General", "Interior", "Services", "Assist"

  • coverageType
    Type: string · CoverageTypeEnumenum nullable

    Possible values: None (0) - None, Powertrain (1) - Powertrain, PowertrainPlus (2) - PowertrainPlus, MostComprehensive (3) - MostComprehensive

    values
    • None
    • Powertrain
    • PowertrainPlus
    • MostComprehensive
  • coverageTypes
    Type: array string[] | null

    Filter by multiple coverage types simultaneously. Values: "basic" (Basic), "basicplus" (Basic Plus), "best" (Best/Exclusionary)

  • duration
    Type: object · Int32Range nullable

    Defines a range filter with lower and upper bounds.

    • from
      Type: integerFormat: int32

      Lower bound of the range (inclusive). Omit to have no lower bound.

    • to
      Type: integerFormat: int32

      Upper bound of the range (inclusive). Omit to have no upper bound.

  • excludeProviders
    Type: array string[] | null

    Exclude specific providers from the results. Useful when you want all providers except certain ones.

  • miles
    Type: object · Int32Range nullable

    Defines a range filter with lower and upper bounds.

    • from
      Type: integerFormat: int32

      Lower bound of the range (inclusive). Omit to have no lower bound.

    • to
      Type: integerFormat: int32

      Upper bound of the range (inclusive). Omit to have no upper bound.

  • monthlyPrice
    Type: object · DoubleRange nullable

    Defines a range filter with lower and upper bounds.

    • from
      Type: numberFormat: double

      Lower bound of the range (inclusive). Omit to have no lower bound.

    • to
      Type: numberFormat: double

      Upper bound of the range (inclusive). Omit to have no upper bound.

  • numberOfProviders
    Type: integer | nullFormat: int32

    Limit the number of unique providers in the results. For example, set to 3 to get plans from at most 3 different providers.

  • planChaizRating
    Type: object · DecimalRange nullable

    Defines a range filter with lower and upper bounds.

    • from
      Type: numberFormat: double

      Lower bound of the range (inclusive). Omit to have no lower bound.

    • to
      Type: numberFormat: double

      Upper bound of the range (inclusive). Omit to have no upper bound.

  • providers
    Type: array string[] | null

    Filter results to only include plans from specific providers. Use provider names like "NAAC", "Omega", "CAPS", "ServiceContract".

  • returnResults
    Type: integerFormat: int32

    Maximum number of plan results to return. Default varies by partner configuration.

  • totalPrice
    Type: object · DoubleRange nullable

    Defines a range filter with lower and upper bounds.

    • from
      Type: numberFormat: double

      Lower bound of the range (inclusive). Omit to have no lower bound.

    • to
      Type: numberFormat: double

      Upper bound of the range (inclusive). Omit to have no upper bound.