PartnerSearchResultPlanEssentialViewModel

Slim representation of a partner search result plan, optimized for LLM and lightweight integrations. Contains only the fields needed for plan comparison, selection, and checkout. Returned when the search request specifies {responseDetailLevel=essential}.

  • coverageType
    Type: string · CoverageTypeEnumenum

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

    values
    • None
    • Powertrain
    • PowertrainPlus
    • MostComprehensive
  • deductible
    Type: numberFormat: double

    Deductible amount in USD per claim.

  • displayProviderName
    Type: string | null

    Display name of the warranty provider.

  • downpayment
    Type: numberFormat: double

    Down payment amount in USD required to activate the plan.

  • duration
    Type: integerFormat: int32

    Plan duration in months.

  • miles
    Type: integerFormat: int32

    Coverage mileage limit.

  • monthlyPrice
    Type: numberFormat: double

    Monthly payment amount in USD for installment plans.

  • planChaizRating
    Type: number | nullFormat: double

    Chaiz quality rating for this plan (0-10 scale, one decimal).

  • planCheckoutUrl
    Type: string | null

    URL to the checkout page for this plan.

  • planHighlights
    Type: array object[] | null · PartnerHighlightViewModel[]

    List of plan highlights or badges.

    Represents a plan highlight or badge indicating a special quality.

    • title
      Type: string | null
      read-only

      Human-readable title for the highlight. Derived from the highlight type enum.

    • type
      Type: string · Highlightenum

      Possible values: BestInCategory (1) - Best in category, Bestseller (2) - Bestseller, HiddenGem (3) - Hidden Gem, PremiumChoice (4) - Premium Choice, BestBasicPlus (5) - Best Basic Plus, BestPowertrain (6) - Best Powertrain, Balanced (7) - Balanced, WorkVehicleReady (8) - Work Vehicle Ready, HonestBasic (9) - Honest Basic, ValueChampion (10) - Value champion, MostGenerousProvider (11) - Most generous provider, AddonSelection (12) - Add-on selection, GenerousLimitOfLiability (13) - Generous Limit of liability, Overachiever (14) - Overachiever, GreatAddons (15) - Great Add-ons, MaintenanceIncluded (16) - Maintenance included

      values
      • BestInCategory
      • Bestseller
      • HiddenGem
      • PremiumChoice
      • BestBasicPlus
  • planId
    Type: integerFormat: int32

    Underlying plan identifier, shared across the per-mileage-tier Chaiz.API.Models.Partners.V2.PartnerSearchResultPlanEssentialViewModel.SearchResultPlanId variants of the same plan. Lets lightweight integrations dedup variants down to one plan.

  • planName
    Type: string | null

    Name of the specific plan.

  • planRatingVerdict
    Type: string | null

    Human-readable verdict summarizing the plan quality.

  • planSummaryUrl
    Type: string | null

    URL to view a summary of plan coverage details.

  • recommendationSummary
    Type: string | null

    One-line recommendation summary combining the plan's labels, rating, and highlights.

  • resultLabels
    Type: array string[] | null

    Result-set-relative recommendation labels for this plan. Maximum of 2 labels per plan. Possible values: LOWEST_PRICE, HIGHEST_RATED, BEST_VALUE, BEST_COVERAGE.

  • searchResultPlanId
    Type: integerFormat: int32

    Unique identifier for this plan result. Required for creating an order.

  • totalPrice
    Type: numberFormat: double

    Total price of the plan in USD.