Releases: Q1 2024

Upcoming releases and changes

Note that Herald aims to continuously add new information to our responses to enable new features. We try our best to avoid high impact changes. In some of the examples below, we hope to deprecate old information with new, more robust information. But no information will ever be removed without notice and approval.

Below we are documenting some new features and changes to our API. There are new fields that will be released to sandbox and production, and existing fields that we aim to deprecate at a later date.

New fields released to Sandbox: January 17th, 2024
New fields released to Production: January 17th, 2024
Old fields deprecated: Later in Q1, date to be determined and communicated well in advance
Old fields deprecated: Later in Q1, date to be determined and communicated well in advance

New fields are highlighted in green with a +. Old fields, that will be deprecated later, are highlighted in red with a -.

The new price_details object

GET /quotes/{quote_id}

```json { ..., "product_id": "prd_0051_herald_cyber_surplus", ..., - "prices": { "premium_before_taxes_and_fees": 3984.01, "premium_with_taxes_and_fees": 4014.26, "details": [...] }, + "price_details": { "premium": { "total": 3984.01, "breakdown": [ { "amount": 3944.57, "text": "Premium", "type": "premium" }, { "amount": 39.44, "text": "TRIA", "type": "premium_tria" } ] }, "institution_surcharges": { "total": null, "breakdown": [ { "amount": 30.25, "text": "Embedded fee", "type": "fee" } ] } } }, ```

Summary:
1. The new price_details object will replace the pricesobject returned with GET /quotes/{quote_id} and GET /policies/{policy_id} (adding object to policy response delayed).

2. The new price_details object has a premium and institution_surcharges object. Each with a total and breakdown.

3. The new objects premium total value corresponds to the existing premium_before_taxes_and_fees value. We aim to always return a numerical value.

4. We will no longer return broker and government surcharges, which were previously returned in the details array when available.

5. The new object does not have a value corresponding to the existing premium_with_taxes_and_fees value. This value was a sum of the premium_before_taxes_and_fees and all surcharges, which was not consistent across products.

6. The total and breakdown value may be null if we are unable to return a non-null value in the response.

Impact: This is totally new info and your integration should not be impacted today! However, we are planning to deprecate the existing prices object later in Q1. Make any necessary updates to avoid interruptions to your integration.