Product Packages By Host Country State

GET {{host}}/api/partner/product/{{product_id}}/host-country/{{host_country_id}}/host-country-state/{{host_country_state_id}}/packages

Get a list of packages available for this product in this country state. Packages contain benefits.

Request URL Parameters

All the below are required.

KeyDescriptionExample
product_idProduct ID. See product reference section.1001
hostcountryidHost country id. See Host Country Index section.25636
hostcountrystate_idHost country state id. See Host Country State Index section.12190

Response Body Parameters

The response will be an array of objects. Each object will have the below parameters:

KeyDescriptionExample
idPackage ID, will be used downstream for pricing, validation, etc.1
nameHuman readable package name.Travel Medical Package
coveragesCoverages associated with the package, see Coverages section below.[
{
id: 1686,
benefit_type: {}
},
]
validationsValidations associated with the package, see Validations section below.

Coverages

KeyDescriptionExample
idCoverage ID.1
benefit_typeBenefit type information related to the coverage, see Benefit Type section below.
limitsLimit information realted to the coverage, see Limits section below[]
has_deductibleIndicating if coverage has deductibletrue / false
deductibleAmount of deductible related to the coverage50

Benefit Type

KeyDescriptionExample
idBenefit type ID.1
nameHuman readable benefit name.Trip Cancellation
keyUseful for creating descriptions across packages without worrying about versioning or name changes.cancellation

Limits

KeyDescriptionExample
idlimit ID1
valueValue of the coverage limits500
value_typeValue type information. See Value Type section below.
typeCoverage limit type information. See Coverage limit type section below

Value Type

KeyDescriptionExample
idCoverage limit Value type id1
nameValue type of the coverage limitflat
symbolSymbol representation of the value$

Coverage Limit Type

KeyDescriptionExample
idCoverage limit type id1
nameName of the coverage limit typeday

Levels

KeyDescriptionExample
idLevel id1
levelName of the levelUnlimited
typeType of level$
is_defaultIf level is applied by defaulttrue
valueValue of level relates to value of the level coverage10000

RESPONSES

status: OK

{"data":[{"id":2153,"alias":"trip_cost_package","name":"Trip Cost Coverage","coverages":[{"id":3026,"benefit_type":{"id":137,"benefit_type_id":3,"name":"Trip Interruption","description":null,"key":"trip_interruption","limits":[]},"limits":[{"id":3146,"value":150,"value_type":{"id":2,"name":"fixed","symbol":"%","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0},{"id":3027,"benefit_type":{"id":138,"benefit_type_id":1,"name":"Trip Cancellation","description":null,"key":"trip_cancellation","limits":[]},"limits":[{"id":3147,"value":20000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[],"levels":[],"attributes":[]},{"id":2161,"alias":"rental_vehicle_damage","name":"Rental Vehicle Damage","coverages":[{"id":3035,"benefit_type":{"id":141,"benefit_type_id":12,"name":"Rental Vehicle Damage","description":null,"key":"rental_vehicle_damage","limits":[]},"limits":[{"id":3155,"value":35000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[{"id":2949,"product_package_validation_type":{"id":13,"name":"Package Combination Minimum","description":"The minimum premium for Combination (two or more) of packages."},"value":"0"},{"id":2950,"product_package_validation_type":{"id":15,"name":"Package Standalone Minimum","description":"The Package that should apply minimum if only one package selected."},"value":"0"}],"levels":[],"attributes":[{"id":1,"name":"Calculate once per order","description":"Include this package in calculations only once per order","key":"calculate_once_per_order"}]},{"id":2183,"alias":"vacation_rental_damage","name":"Vacation Rental Damage Package","coverages":[{"id":3057,"benefit_type":{"id":142,"benefit_type_id":11,"name":"Vacation Rental Damage","description":null,"key":"vacation_rental_damage","limits":[{"value":"1000","limit_type":{"type":"benefit_limit","label":"Benefit Limit"}},{"value":"3000","limit_type":{"type":"benefit_limit","label":"Benefit Limit"}},{"value":"5000","limit_type":{"type":"benefit_limit","label":"Benefit Limit"}}]},"limits":[{"id":3201,"value":1000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]},{"id":3202,"value":3000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]},{"id":3203,"value":5000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[],"levels":[],"attributes":[{"id":1,"name":"Calculate once per order","description":"Include this package in calculations only once per order","key":"calculate_once_per_order"}]},{"id":2196,"alias":"pet_travel_package","name":"Pet Travel Package","coverages":[{"id":3077,"benefit_type":{"id":143,"benefit_type_id":20,"name":"Pet Return","description":null,"key":"pet_return","limits":[]},"limits":[{"id":3233,"value":2000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":100},{"id":3078,"benefit_type":{"id":144,"benefit_type_id":21,"name":"Pet Medical","description":null,"key":"pet_medical","limits":[]},"limits":[{"id":3234,"value":500,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[{"id":2983,"product_package_validation_type":{"id":13,"name":"Package Combination Minimum","description":"The minimum premium for Combination (two or more) of packages."},"value":"0"},{"id":2984,"product_package_validation_type":{"id":15,"name":"Package Standalone Minimum","description":"The Package that should apply minimum if only one package selected."},"value":"0"}],"levels":[],"attributes":[{"id":1,"name":"Calculate once per order","description":"Include this package in calculations only once per order","key":"calculate_once_per_order"}]},{"id":2214,"alias":"travel_medical_package","name":"Travel Medical Package","coverages":[{"id":3121,"benefit_type":{"id":145,"benefit_type_id":22,"name":"Travel Medical","description":null,"key":"travel_medical","limits":[]},"limits":[{"id":3277,"value":100000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":true,"deductible":50},{"id":3122,"benefit_type":{"id":146,"benefit_type_id":44,"name":"Emergency Dental","description":null,"key":"dental","limits":[]},"limits":[{"id":3278,"value":750,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":true,"deductible":0},{"id":3123,"benefit_type":{"id":147,"benefit_type_id":23,"name":"Emergency Evacuation \u0026 Repatriation","description":null,"key":"emergency_evacuation_and_repatriation_of_remains","limits":[]},"limits":[{"id":3279,"value":500000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[{"id":3022,"product_package_validation_type":{"id":13,"name":"Package Combination Minimum","description":"The minimum premium for Combination (two or more) of packages."},"value":"0"},{"id":3023,"product_package_validation_type":{"id":15,"name":"Package Standalone Minimum","description":"The Package that should apply minimum if only one package selected."},"value":"0"}],"levels":[],"attributes":[]},{"id":2232,"alias":"baggage_package","name":"Baggage Package","coverages":[{"id":3167,"benefit_type":{"id":148,"benefit_type_id":14,"name":"Baggage and Personal Effects","description":null,"key":"baggage_and_personal_effects","limits":[]},"limits":[{"id":3331,"value":2500,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]},{"id":3332,"value":1250,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":true,"deductible":100},{"id":3168,"benefit_type":{"id":149,"benefit_type_id":15,"name":"Baggage Delay","description":null,"key":"baggage_delay","limits":[]},"limits":[{"id":3333,"value":500,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[{"id":3058,"product_package_validation_type":{"id":13,"name":"Package Combination Minimum","description":"The minimum premium for Combination (two or more) of packages."},"value":"0"},{"id":3059,"product_package_validation_type":{"id":15,"name":"Package Standalone Minimum","description":"The Package that should apply minimum if only one package selected."},"value":"0"}],"levels":[],"attributes":[]},{"id":2250,"alias":"delay_package","name":"Delay Package","coverages":[{"id":3203,"benefit_type":{"id":150,"benefit_type_id":6,"name":"Trip Delay","description":null,"key":"trip_delay","limits":[]},"limits":[{"id":3385,"value":2500,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]},{"id":3386,"value":200,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0},{"id":3204,"benefit_type":{"id":151,"benefit_type_id":8,"name":"Missed Connection","description":null,"key":"missed_connection","limits":[]},"limits":[{"id":3387,"value":1000,"value_type":{"id":1,"name":"flat","symbol":"$","created_at":"2023-06-29T12:54:45.000000Z","updated_at":"2023-06-29T12:54:45.000000Z"},"type":[{"id":1,"name":"trip"}]}],"has_deductible":false,"deductible":0}],"validations":[{"id":3094,"product_package_validation_type":{"id":13,"name":"Package Combination Minimum","description":"The minimum premium for Combination (two or more) of packages."},"value":"0"},{"id":3095,"product_package_validation_type":{"id":15,"name":"Package Standalone Minimum","description":"The Package that should apply minimum if only one package selected."},"value":"0"}],"levels":[],"attributes":[]}]}