Skip to main content
GET
Retrieve a product by name

Authorizations

X-API-Key
string
header
required

Path Parameters

product_name
string
required

Response

Product details

Serializer for the Product model

id
string<uuid>
required
read-only

Unique identifier for the package

name
string
required

Name of the package offered by the insurance provider

Maximum string length: 255
product_type
enum<string>
required

Type of insurance package

  • Life - Life Insurance
  • Health - Health Insurance
  • Auto - Auto Insurance
  • Cargo - Cargo (Shipment) Insurance
  • Gadget - Gadget Insurance
  • Travel - Travel Insurance
  • Home - Home Insurance
  • Student_Protection - Student Protection
  • Accident - Accident Insurance
  • Personal_Accident - Personal Accident Insurance
  • CreditLife - Credit Life Insurance
  • PetCare - PetCare Insurance
  • General - General Insurance
  • Other - Other
Available options:
Life,
Health,
Auto,
Cargo,
Gadget,
Travel,
Home,
Student_Protection,
Accident,
Personal_Accident,
CreditLife,
PetCare,
General,
Other
product_plan
string | null
required

The plan or tier of the product (e.g., Basic, Premium, or any custom plan)

Maximum string length: 255
coverages
object[]
required
pricing
object
required

Serializer for the Price model with limited fields (only amount and currency)

provider
object
required
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string | null

Description of the package

base_premium
string<decimal>

Base premium (Estimate) price if no tiers or tenures are defined

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$