GET
/
products
/
{product_id}

Path Param

product_id
string

The id of the product to be retrieved.
Format: uuid4
Example: 123e4567-e89b-12d3-a456-426614174000

Response

id
string

Product id

label
string

Product label

summary
string

Product summary

marketingDescription
string

Product marketing description

marketingFeatures
string[]

List of strings to be displayed as bullet points in the product marketing page.

purchaseFields
PurchaseField[]
price
Price
category
string
isSubscription
boolean

Indicates if the product is a subscription or not.

subscriptionRecurrency
string

Product subscription recurrency.

insuranceCompanyId
string

Product insurance company id

insuranceCompany
InsuranceCompany

Insurance company that this insurance product is associated with. This company is the one that will receive the payment for the product and is responsible for the product.

availableQuotas
number

Number of quotas available for purchase.

usedQuotas
number

Number of quotas sold.

isActive
boolean

Indicates if the product is active or not. If the product is not active, it will not be available for purchase.

availableTo
string[]

List of companies ids that the product is available to.

expirationDate
string

Last day to purchase the product.

createdAt
string

Date the product was created.

updatedAt
string

Last date there has been an update to the product.