PartnerSearchResultPlanViewModel

Represents a vehicle protection plan returned from a plan search. Contains pricing, coverage details, provider information, and unique identifiers for ordering.

  • accreditedBy
    Type: array string[] | null

    Accreditation organizations for the provider.

  • addons
    Type: array object[] | null · PartnerAddonViewModel[]

    Optional add-ons available for this plan. Add-ons provide additional coverage beyond the base plan.

    Optional add-on coverage that can be added to a base plan.

    • description
      Type: string | null

      Detailed description of what the add-on covers.

    • displayName
      Type: string | null

      Display name of the add-on for customer-facing UI.

    • id
      Type: integerFormat: int32

      Unique identifier for the add-on. Use this ID in the selectedAddonIds array when creating an order.

    • includedCategoryIds
      Type: array string[] | null · AddonCategoryIdEnum[]enum

      Addon categories this add-on implicitly covers in addition to its own !:AddonCategoryId. For example, ServiceContract's Commercial Use addon also covers Rideshare.

      values
      • None
      • CommercialUse
      • RideShare
      • LiftKit
      • BrandedTitle
    • isIncludedInPlanPrice
      Type: boolean
    • limitations
      Type: string | null

      Any limitations or exclusions for this add-on.

    • name
      Type: string | null

      Internal name of the add-on.

    • totalAmount
      Type: number | nullFormat: double
  • categories
    Type: object | null

    Dictionary mapping category IDs to category names for covered components.

    • propertyName
      Type: string
  • coverageScores
    Type: array object[] | null · PartnerCoverageScoreViewModel[]

    Coverage scores by category (e.g., Engine, Transmission, Electrical). Indicates how comprehensive the coverage is for each vehicle system.

    Coverage score for a specific vehicle system category.

    • categoryName
      Type: string | null

      Name of the coverage category (e.g., Engine, Transmission, Electrical).

    • categoryTypeId
      Type: integerFormat: int32

      Unique identifier for the coverage category.

    • score
      Type: integerFormat: int32

      Coverage score for this category (0-100 scale). Higher scores indicate more comprehensive coverage.

  • 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. The amount the customer pays out-of-pocket before coverage kicks in.

  • displayProviderName
    Type: string | null

    Display name of the warranty provider.

  • downpayment
    Type: numberFormat: double

    Down payment amount in USD required to activate the plan. For monthly payment plans, this is the initial payment.

  • duration
    Type: integerFormat: int32

    Plan duration in months. Common values: 12, 24, 36, 48, 60 months.

  • limitOfLiability
    Type: string | null

    Maximum limit of liability per claim or contract term. May be expressed as a dollar amount or vehicle value.

  • miles
    Type: integerFormat: int32

    Coverage mileage limit. The plan covers repairs up to this many miles from the purchase odometer reading.

  • monthlyPrice
    Type: numberFormat: double

    Monthly payment amount in USD for installment plans. Only applicable when PaymentOption is set to monthly payments.

  • paymentOptions
    Type: array object[] | null · PaymentOptionWithDiscountsViewModel[]

    Available payment options with pricing details for each. Includes discounts and installment information.

    Payment option details including discounts and installment information.

    • discount
      Type: numberFormat: double

      Base discount amount applied to this payment option in USD.

    • discountForPaymentOption
      Type: numberFormat: double

      Additional discount specific to this payment option in USD. Pay-in-full options often have larger discounts.

    • discountPercentageForPaymentOption
      Type: numberFormat: double

      Discount percentage for this payment option.

    • downpayment
      Type: numberFormat: double

      Down payment amount before any discounts in USD.

    • downpaymentAfterDiscount
      Type: numberFormat: double

      Down payment amount after discounts in USD. This is the actual amount charged initially.

    • downpaymentDiscountAmount
      Type: numberFormat: double

      Discount amount applied specifically to the down payment in USD.

    • installments
      Type: integerFormat: int32

      Number of installment payments. 1 = Pay in full, 12 = Monthly payments.

    • pricePerInstallment
      Type: numberFormat: double

      Monthly payment amount in USD (for installment plans).

    • totalDiscount
      Type: numberFormat: double

      Total combined discount amount in USD.

    • totalPrice
      Type: numberFormat: double

      Total price before any discounts in USD.

    • totalPriceAfterDiscount
      Type: numberFormat: double

      Total price after all discounts in USD. This is the final amount the customer will pay.

  • payout
    Type: string | null

    Claim payout method. Describes how repairs are paid (e.g., direct to shop, reimbursement).

  • planChaizRating
    Type: number | nullFormat: double

    Chaiz quality rating for this plan (0-100 scale). A proprietary score based on coverage quality, value, and provider reliability.

  • planCheckoutUrl
    Type: string | null

    URL to the checkout page for this plan. Partners can redirect customers here to complete purchase.

  • planContractUrl
    Type: string | null

    URL to the full contract/terms document for this plan.

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

    List of plan highlights or badges. These indicate special qualities like "Best Value", "Most Popular", etc.

    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

    Signed 32-bit integers (commonly used integer type).

  • planName
    Type: string | null

    Name of the specific plan.

  • planRatingDescription
    Type: string | null

    Detailed description of why the plan received its rating.

  • planRatingVerdict
    Type: string | null

    Human-readable verdict summarizing the plan quality. Examples: "Excellent", "Good", "Fair"

  • planSummaryUrl
    Type: string | null

    URL to view a summary of plan coverage details.

  • providerId
    Type: integerFormat: int32

    Signed 32-bit integers (commonly used integer type).

  • providerInfo
    Type: string | null

    Additional information about the warranty provider. May include company description, years in business, etc.

  • providerLogoUrl
    Type: string | null

    URL to the provider's logo image.

  • providerRating
    Type: number | nullFormat: double

    Provider's overall rating (0-5 scale). Based on customer reviews and satisfaction scores.

  • recommendationSummary
    Type: string | null

    One-line recommendation summary combining the plan's labels, rating, and highlights. Designed for agent-facing display. Null when no recommendation labels are assigned.

  • 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. Null when no labels apply.

  • score
    Type: numberFormat: double
  • searchId
    Type: stringFormat: uuid

    Unique identifier for the search session that produced this result.

  • searchResultPlanId
    Type: integerFormat: int32

    Unique identifier for this plan result. Required for creating an order. Use this value in the CreateOrder endpoint's searchResultPlanIds array.

  • state
    Type: string | null
  • totalPrice
    Type: numberFormat: double

    Total price of the plan in USD. This is the full cost if paid upfront or the total of all installments.

  • userId
    Type: stringFormat: uuid

    Unique identifier for the user associated with this search.