Products APIPlan

Configuration by ID

Path parameters

brandCodeenumRequired
Brand code
Allowed values:
planIdlongRequired

A valid Plan ID - see /underwriters

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

preferredDocumentFileTypestringOptional
langstringOptional
partnerCodestringOptional
effectiveAtstringOptional
The point in time which the response relates to

Response

Success
expirySecondsinteger or null
planIdlong or nullDefaults to 0
codestring or null
namestring or null
insuranceContractIdlong or nullDefaults to 0
policyNumberPrefixstring or null
policyNumberFormatstring or null
underwriterCodestring or null
currencyCodestring or null
homeCountryCodeslist of strings or null
pdsUrlstring or null
purchaseTermsAndConditionslist of objects or null
overrideJurisdictionCountryCodestring or null
overrideJurisdictionProvinceCodestring or null
effectiveFromDatestring or null
effectiveToDatestring or null
availableTranslationsmap from strings to optional strings or null
quoteTypestring or null
brandCodestring or null