Skip to main content
GET
Get the pricing tiers available for a policy

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

branchId
string

Branch ID (optional, defaults to latest)

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

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

assetCustomFields
string

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

policyCustomFieldsInputs
string

Peril parameters as JSON string (e.g. {"peril-ASSISTANCE":true,"peril-GLASS_BREAKAGE":false})

manualComponentValues
string

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

Response

tiers
object[]
required

Available pricing tiers

defaultTier
string
required

Default tier ID

selectedTier
string

The tier the user actually saved; undefined when no selection has been made

legacyMode
boolean

Legacy mode indicator (true if product not migrated)