Skip to main content
GET
Compute pricing for selected tier and perils

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required

Policy ID

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

tierId
string
required

Tier ID, as returned in GET /policies/{policyId}/available-pricing. Tiers are computed per policy, so there is no fixed list.

selectedPerilIds
string[]

Selected peril IDs

policyCustomFieldsInputs
string

Peril parameter values as JSON string (e.g. {"financialLossPerilSelected":true})

branchId
string

Branch ID (optional, defaults to latest)

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
whenAt
string<date-time>

Filter assets active at this date (ISO-8601)

policyCustomFields
string

Policy custom fields as JSON string (e.g. [{"key":"insuredValue","value":"RANGE_0_2500"}])

assetCustomFields
string

Asset custom fields as JSON string (e.g. [{"key":"equineValue","value":5000}])

manualComponentValues
string

Manual component values as a JSON-encoded string, e.g. {"values":{"RETAIL_SUBSCRIPTION_FEE":5000}}.

Response

policy
object
required
assets
object[]
required
breakdown
object

Flat price breakdown

outputCustomFields
object

Custom fields computed from pricing engine outputs