Link Search Menu Expand Document

GET /v1/quotes/:id

Use this end point to retrieve an existing quote.

Note, in some cases the response may have the status attribute set to require_authorization. In this case the quote will need to be submitted for authorisation before it can be bound. Please see Quotes: Submit for Authorisation for more details.

Response examples


200 OK

{
  "id": "751831b7-079f-4b1b-9ac2-0fa5c1b7442s",
  "customer_id": null,
  "premium": 1500.0,
  "premium_sales_tax": 150.0,
  "stamp_duty": 165.0,
  "admin_fee": 77.27,
  "admin_fee_sales_tax": 7.73,
  "total_sales_tax": 157.73,
  "grand_total": 1900.0,
  "currency": "AUD",
  "sales_tax_label": "GST",
  "excess": 1000.0,
  "custom_field": null,
  "expires_at": "2019-06-22T23:59:59.999Z",
  "created_at": "2019-05-23T01:08:54.907Z",
  "updated_at": "2019-05-23T01:08:54.907Z",
  "pricing_locked": false,
  "benefits": [
    {
      "title": "List of benefits",
      "description": "Explanation of each benefit..."
    }
  ],
  "product": {
    "name": "CyberCare",
    "pds_url": "http://aperture.pdev/products/cybercare/Agile-CyberCare-PDS.pdf",
    "min_insured_value": 250000,
    "max_insured_value": 10000000,
    "duty_of_disclosure": "# Duty of Disclosure\n## What You must tell Us\nWe will ask You various questions when You apply for cover. When You answer those questions, You must be honest and You have a duty under law to tell Us anything known to You, and which a reasonable person in the circumstances, would include in answer to the question. We will use the answers in deciding whether to insure You, and anyone else to be insured under the Policy, and on what terms. You have this same duty to disclose those matters to Us before You renew, extend, vary or reinstate Your Policy.\n## If You do not tell us\nIf You do not answer Our questions in this way, We may reduce Our liability under contract in respect of a claim or refuse to pay a claim, or cancel the Policy. If You answer Our questions fraudulently, We may refuse to pay a claim and treat the Policy as never having commenced."
  },
  "parameters": {
    "plan": "premium_1",
    "region": "VIC",
    "business_type": "Architect",
    "revenue": 135000.0,
    "name_of_insured": "Mary Smith Accounting Pty Ltd",
    "name": "Mary Smith ",
    "email": "mary@example.com",
    "plan_label": "Premium",
    "region_label": "Victoria"
  }
}