Plans

See how to quote using plans in an appropriate manner. The resource are important because is has a pre-defined set of assists, coverages and options to help proponent quote more easily.

At this point, you may have in your integration flow a quote_request like this, containing a list of plans available to quote:

{
  ...
  "plans": []
}

Some plans already have a premium amount or installments defined. But you still need to call the requests for quote.

Plan spec from Quote Request

The plan returned from quote request has a JSON structured like this:

ParameterDescription
idThe ID of the Plan
namePlan name
assistsList of assists for this Plan
coveragesList of coverages for this Plan
installmentsList of installments for this Plan
{
  "id": "string",
  "name": "string",
  "assists": [],
  "coverages": [],
  "installments": []
}

Use Plans at Quote

Given a quote_request allowing you to use plans, you can send a body at quote the JSON structured like this:

ParameterDescription
plan_idThe ID of the Plan chosenRequired
{
  ...
  "plan_id": "string"
}