PartnerAddonViewModel

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

    Additional add-on categories this add-on implicitly covers, beyond its own addonCategoryId. For example, a Commercial Use add-on may also cover Rideshare, so selecting the one gives the customer both.

    values
    • None
    • CommercialUse
    • RideShare
    • LiftKit
    • BrandedTitle
    • Type: string · AddonCategoryIdEnumenum

      Possible values: None (0) - None, CommercialUse (1) - CommercialUse, RideShare (2) - RideShare, LiftKit (3) - LiftKit, BrandedTitle (4) - BrandedTitle, SealsAndGaskets (5) - SealsAndGaskets, EmissionsPackage (6) - EmissionsPackage, EnhancedElectronics (7) - EnhancedElectronics, Mobility (8) - Mobility, SafetyAndConvenience (9) - SafetyAndConvenience, HybridBattery (10) - HybridBattery, Hybrid (11) - Hybrid, CanadianVehicle (12) - CanadianVehicle, EnhancedLabour (13) - EnhancedLabour, AirConditioningCompressor (14) - AirConditioningCompressor, Electrical (15) - Electrical, ExtendedCoverage (16) - ExtendedCoverage

      values
      • None
      • CommercialUse
      • RideShare
      • LiftKit
      • BrandedTitle
  • isIncludedInPlanPrice
    Type: boolean

    true when this add-on is already covered by the plan price, so selecting it costs the customer nothing extra. false when totalAmount is added to the plan price.

  • 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 | null Format: double

    Extra cost of this add-on in USD, on top of the plan price. Null when there is no separate charge. Ignore it when isIncludedInPlanPrice is true.