Retrieve Existing Quote
GET/v1/quote/:productCode/:quoteId
Retrieve Existing Quote
Request
Path Parameters
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
, hunting-lease-liability
]
Responses
- 200
- 201
- 400
- 401
- 422
Quote updated
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- Array [
- ]
- ]
policy_holder object
partner object
Possible values: [STANDARD
, LIMITED
]
Possible values: [sole_proprietorship
, single_member_llc
, multi_member_llc
, private_partnership
, private_corporation
]
Possible values: [US
, CA
]
Possible values: [ACTIVE
, PENDING_CONFIGURATION
, PENDING_ONBOARDING
, INACTIVE
]
Possible values: [youth_sports
, health_and_wellness
, live_events
, travel
, pets
, education
, collectibles
, events_and_rentals
, camps_and_recreation
, conferences
, generic
]
policy_documents object[]
Possible values: [POLICY
, CERTIFICATE_OF_INSURANCE
, OTHER
]
Possible values: [ACTIVE
, QUOTED
, EXPIRED
, PENDING_CANCELLATION
, CANCELED
, PENDING
, REQUIRES_PAYMENT
, BIND_FAILED
, ENDORSED
]
product object
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
, hunting-lease-liability
]
For an endorsement, the change in price. A positive price change indicates that the price has increased and the customer will need to pay the difference. A negative price change indicates that the new policy is cheaper and that a refund is needed.
subscription_premium object
If this policy supports being billed as a monthly subscription instead of a one-time fee, this field will be present
The number of monthly payments required for this subscription
The monthly premium to be paid for this subscription
Possible values: [USD
, CAD
]
Total cost of the policy in cents. This is the amount that should be displayed and charged during checkout if the user accepts the insurance purchase.
taxes_and_fees object[]
order_item_transaction object
policy object
Possible values: >= 2 characters
and <= 2 characters
state object
customer object
policy_documents object[]
Possible values: [POLICY
, CERTIFICATE_OF_INSURANCE
, OTHER
]
Possible values: [ACTIVE
, QUOTED
, EXPIRED
, PENDING_CANCELLATION
, CANCELED
, PENDING
, REQUIRES_PAYMENT
, BIND_FAILED
, ENDORSED
]
product object
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
, hunting-lease-liability
]
Possible values: >= 50
subscription_premium object
The number of monthly payments required for this subscription
The monthly premium to be paid for this subscription
Possible values: [USD
, CAD
]
metadata object
order object
customer object
subscription object
Possible values: [USD
, CAD
]
Possible values: [REQUIRES_PAYMENT
, COMPLETED
, REFUNDED
, PENDING
, FAILED
, CHARGED_BACK
]
Possible values: [PENDING
, FAILED
, COMPLETED
]
Possible values: [REFUND
, CHARGE
, CHARGEBACK
]
Possible values: [CC
, ACH
]
Possible values: [justifi
, card_connect
, propay
, stripe
, sportsengine
, teamsnap
, insurance_carrier
, stackpay
, invoice
, braintree
]
Possible values: [fee
, tax
]
metadata object
{
"policy_holder": {
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"policy_attributes": {},
"policy_number": "string",
"partner": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "STANDARD",
"legal_business_name": "string",
"dba_name": "string",
"business_structure": "sole_proprietorship",
"email_address": "user@example.com",
"notification_email_address": "user@example.com",
"billing_email_address": "user@example.com",
"tax_identifier": "string",
"tax_identifier_verified": true,
"address": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country": "US",
"phone_number": "string",
"website": "string",
"industry": "string",
"refund_policy_url": "string",
"business_name": "string",
"status": "ACTIVE",
"partner_parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"theme_mode": true,
"portal_purchase_enabled": true,
"pre_transaction_fee_commission": true,
"url_identifier": "string",
"vertical": "youth_sports"
},
"policy_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"master_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "POLICY",
"storage_bucket": "string",
"storage_key": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2024-10-29T16:03:46.147Z",
"expiration_date": "string",
"effective_date": "string",
"quote_date": "2024-10-29T16:03:46.147Z",
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0
},
"currency": "USD",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy": {
"premium_amount_to_show": 0,
"policy_number": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"postal_code": "string",
"country": "string",
"state": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string"
},
"customer": {
"email_address": "user@example.com"
},
"policy_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"master_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "POLICY",
"storage_bucket": "string",
"storage_key": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2024-10-29T16:03:46.147Z",
"expiration_date": "2024-10-29T16:03:46.147Z",
"effective_date": "2024-10-29T16:03:46.147Z",
"quote_date": "2024-10-29T16:03:46.147Z",
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"policy_attributes": {},
"policy_attributes_old": "string",
"premium_amount": 0,
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0
},
"currency": "USD",
"total": 0,
"taxes_and_fees": [
null
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {},
"checkout_url": "string"
},
"order": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer": {
"email_address": "user@example.com"
},
"order_item_transactions": [
null
],
"subscription": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"payment_method": "string",
"payment_provider": "string",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"start_date": "2024-10-29",
"payments_required": 0,
"payment_amount": 0,
"orders": [
null
]
},
"total": 0,
"sub_total": 0,
"taxes_and_fees_total": 0,
"currency": "USD",
"status": "REQUIRES_PAYMENT",
"placed_at": "2024-10-29T16:03:46.148Z",
"created_at": "2024-10-29T16:03:46.148Z",
"updated_at": "2024-10-29T16:03:46.148Z",
"is_test": true
},
"taxes_and_fees": [
null
],
"item_total": 0,
"taxes_and_fees_amount": 0,
"item_sub_total": 0,
"estimated_allocated_transaction_fee": 0,
"chargeback_fee": 0,
"ar_accounting_period": "string",
"co_accounting_period": "string",
"transaction_status": "PENDING",
"transaction_type": "REFUND",
"transaction_amount": 0,
"payment_type": "CC",
"processor": "justifi",
"estimated_processor_transaction_fee": 0,
"processor_payment_method_id": "string",
"processor_payment_id": "string",
"processor_payout_id": "string",
"processor_payout_date": "2024-10-29T16:03:46.148Z",
"created_at": "2024-10-29T16:03:46.148Z",
"updated_at": "2024-10-29T16:03:46.148Z"
},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true
}
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {},
"checkout_url": "string"
}
Quote created
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- Array [
- ]
- ]
policy_holder object
partner object
Possible values: [STANDARD
, LIMITED
]
Possible values: [sole_proprietorship
, single_member_llc
, multi_member_llc
, private_partnership
, private_corporation
]
Possible values: [US
, CA
]
Possible values: [ACTIVE
, PENDING_CONFIGURATION
, PENDING_ONBOARDING
, INACTIVE
]
Possible values: [youth_sports
, health_and_wellness
, live_events
, travel
, pets
, education
, collectibles
, events_and_rentals
, camps_and_recreation
, conferences
, generic
]
policy_documents object[]
Possible values: [POLICY
, CERTIFICATE_OF_INSURANCE
, OTHER
]
Possible values: [ACTIVE
, QUOTED
, EXPIRED
, PENDING_CANCELLATION
, CANCELED
, PENDING
, REQUIRES_PAYMENT
, BIND_FAILED
, ENDORSED
]
product object
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
, hunting-lease-liability
]
For an endorsement, the change in price. A positive price change indicates that the price has increased and the customer will need to pay the difference. A negative price change indicates that the new policy is cheaper and that a refund is needed.
subscription_premium object
If this policy supports being billed as a monthly subscription instead of a one-time fee, this field will be present
The number of monthly payments required for this subscription
The monthly premium to be paid for this subscription
Possible values: [USD
, CAD
]
Total cost of the policy in cents. This is the amount that should be displayed and charged during checkout if the user accepts the insurance purchase.
taxes_and_fees object[]
order_item_transaction object
policy object
Possible values: >= 2 characters
and <= 2 characters
state object
customer object
policy_documents object[]
Possible values: [POLICY
, CERTIFICATE_OF_INSURANCE
, OTHER
]
Possible values: [ACTIVE
, QUOTED
, EXPIRED
, PENDING_CANCELLATION
, CANCELED
, PENDING
, REQUIRES_PAYMENT
, BIND_FAILED
, ENDORSED
]
product object
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
, hunting-lease-liability
]
Possible values: >= 50
subscription_premium object
The number of monthly payments required for this subscription
The monthly premium to be paid for this subscription
Possible values: [USD
, CAD
]
metadata object
order object
customer object
subscription object
Possible values: [USD
, CAD
]
Possible values: [REQUIRES_PAYMENT
, COMPLETED
, REFUNDED
, PENDING
, FAILED
, CHARGED_BACK
]
Possible values: [PENDING
, FAILED
, COMPLETED
]
Possible values: [REFUND
, CHARGE
, CHARGEBACK
]
Possible values: [CC
, ACH
]
Possible values: [justifi
, card_connect
, propay
, stripe
, sportsengine
, teamsnap
, insurance_carrier
, stackpay
, invoice
, braintree
]
Possible values: [fee
, tax
]
metadata object
{
"policy_holder": {
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"policy_attributes": {},
"policy_number": "string",
"partner": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "STANDARD",
"legal_business_name": "string",
"dba_name": "string",
"business_structure": "sole_proprietorship",
"email_address": "user@example.com",
"notification_email_address": "user@example.com",
"billing_email_address": "user@example.com",
"tax_identifier": "string",
"tax_identifier_verified": true,
"address": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country": "US",
"phone_number": "string",
"website": "string",
"industry": "string",
"refund_policy_url": "string",
"business_name": "string",
"status": "ACTIVE",
"partner_parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"theme_mode": true,
"portal_purchase_enabled": true,
"pre_transaction_fee_commission": true,
"url_identifier": "string",
"vertical": "youth_sports"
},
"policy_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"master_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "POLICY",
"storage_bucket": "string",
"storage_key": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2024-10-29T16:03:46.149Z",
"expiration_date": "string",
"effective_date": "string",
"quote_date": "2024-10-29T16:03:46.149Z",
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0
},
"currency": "USD",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy": {
"premium_amount_to_show": 0,
"policy_number": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"postal_code": "string",
"country": "string",
"state": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string"
},
"customer": {
"email_address": "user@example.com"
},
"policy_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"master_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "POLICY",
"storage_bucket": "string",
"storage_key": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2024-10-29T16:03:46.150Z",
"expiration_date": "2024-10-29T16:03:46.150Z",
"effective_date": "2024-10-29T16:03:46.150Z",
"quote_date": "2024-10-29T16:03:46.150Z",
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"policy_attributes": {},
"policy_attributes_old": "string",
"premium_amount": 0,
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0
},
"currency": "USD",
"total": 0,
"taxes_and_fees": [
null
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {},
"checkout_url": "string"
},
"order": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer": {
"email_address": "user@example.com"
},
"order_item_transactions": [
null
],
"subscription": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"payment_method": "string",
"payment_provider": "string",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"start_date": "2024-10-29",
"payments_required": 0,
"payment_amount": 0,
"orders": [
null
]
},
"total": 0,
"sub_total": 0,
"taxes_and_fees_total": 0,
"currency": "USD",
"status": "REQUIRES_PAYMENT",
"placed_at": "2024-10-29T16:03:46.150Z",
"created_at": "2024-10-29T16:03:46.150Z",
"updated_at": "2024-10-29T16:03:46.150Z",
"is_test": true
},
"taxes_and_fees": [
null
],
"item_total": 0,
"taxes_and_fees_amount": 0,
"item_sub_total": 0,
"estimated_allocated_transaction_fee": 0,
"chargeback_fee": 0,
"ar_accounting_period": "string",
"co_accounting_period": "string",
"transaction_status": "PENDING",
"transaction_type": "REFUND",
"transaction_amount": 0,
"payment_type": "CC",
"processor": "justifi",
"estimated_processor_transaction_fee": 0,
"processor_payment_method_id": "string",
"processor_payment_id": "string",
"processor_payout_id": "string",
"processor_payout_date": "2024-10-29T16:03:46.150Z",
"created_at": "2024-10-29T16:03:46.150Z",
"updated_at": "2024-10-29T16:03:46.150Z"
},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true
}
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {},
"checkout_url": "string"
}
Bad request was sent, most likely from a missing parameter.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string",
"message": "string",
"status": 0
}
Either x-api-client-id
or Authorization
header must be provided.
The quote or offer no longer exists but is either a pending or active policy.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string",
"message": "string",
"status": 0
}