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: Format: int32enum

    Type of coverage provided by this plan: 1 Powertrain, 2 PowertrainPlus, 3 MostComprehensive.

    values
    0 = None1 = Powertrain2 = PowertrainPlus3 = 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.

  • hasMaintenanceProgram
    Type: boolean

    Whether the plan bundles a prepaid maintenance program (oil changes, brake service and the like). Request the Full shape for the program's maintenanceProgram details.

  • 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:

    List of plan highlights or badges.

    Properties: 2
  • planId
    Type: integerFormat: int32

    Underlying plan identifier, shared across the per-mileage-tier searchResultPlanId variants of the same plan. By default the search returns one variant per planId; with planVariant=all it returns every variant, and they share this value.

  • 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 of 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

    Identifies this plan at this price. Embedded in planSummaryUrl and planCheckoutUrl.

  • totalPrice
    Type: numberFormat: double

    Total price of the plan in USD.

Previous
PartnerPlanSearchCriteriaViewModel
Next
PartnerHighlightViewModel