Response Objects
Several endpoints return the same nested objects. Each is defined once here. When an endpoint's response table lists a field as a named object type, refer to this section.
Policy object
Returned by: Quote, InstantBooking (subset), Purchase, Status, Update.
Name
string
Product display name.
Code
string
Product code. Pass this as PolicyCode in the Purchase request.
Type
string
Product type.
Excess
float
Excess amount.
GapCoverAmount
float
Gap cover amount included in the product.
Inclusions
string
Product inclusions (HTML).
Description
string
Full product description (HTML).
SellingPoints
string
Key selling points (HTML).
PdsUrl
string
URL to the Product Disclosure Statement (PDS) PDF.
SupplierName
string
Insurer/supplier name.
ModifyUrl
string
URL to modify the policy on RentalCover.com (non-API).
CancelUrl
string
URL to cancel the protection on RentalCover.com (non-API).
ExpressCode
string
ExpressCode from the request, if provided.
RoadsideAssistanceBlob
string
Roadside assistance instructions for CRM systems and email templates. Returned by Purchase only.
Customer object
Returned by: Quote, InstantBooking, Purchase, Status, Update, UpdateCustomer.
CustomerId
integer
Internal RentalCover customer ID.
FirstName
string
Customer first name.
LastName
string
Customer last name.
Email
string
Customer email address.
Phone
string
Customer phone number.
Age
integer
Customer age.
DateOfBirth
string
Customer date of birth (yyyy-mm-dd), if provided.
Country
string
Customer country code (ISO 3166-1 alpha-2).
CountryId
integer
Internal country ID corresponding to Country.
Region
string
Customer state/region/territory code, if provided.
Address1
string
Customer street address line 1.
Address2
string
Customer street address line 2.
City
string
Customer city or suburb.
PostalCode
string
Customer postcode or zip code.
Coupons
object
Available coupons keyed by coupon code. Omitted if no coupons are available. See Customer Coupons below.
Customer coupons
The Coupons field within the Customer object is a JSON object keyed by coupon code:
Title
string
Display name of the coupon.
Value
float
Discount value.
ValueType
string
How the value is applied: percent or amount.
AmountRemaining
float
Remaining balance (for partial-use coupons).
EffectiveFrom
datetime
Date from which the coupon is valid.
EffectiveTo
datetime
Date on which the coupon expires.
Terms
string
Terms and conditions text.
Commission object
Returned by: Quote, Purchase.
TotalCommission
string
Partner commission amount (includes discounts and markups).
TotalCommissionFormatted
string
Formatted partner commission.
SettlementCurrency object
Returned by: Quote. Contains the protection amount in the settlement currency agreed between the partner and RentalCover.
SettlementCurrency
string
Settlement currency code (ISO 4217).
SettlementAmount
float
Protection amount in the settlement currency.
DestinationCountry object
DestinationCountryObject
Returned by: Quote and Status as DestinationCountryObject. Also returned by UpdateCustomer as the Country field, same structure.
Code
string
ISO 3166-1 alpha-2 country code.
Name
string
Full country name.
PhoneCode
string
Country phone prefix.
Booking responses
The canonical response shape returned by Quote, Purchase, Status, and Update. Purchase, Status, and Update each reference this object and document only the fields that differ.
Scalar fields
Reference
string
Unique booking reference ending in -INS. Use this in all subsequent calls. Customers receive this in their confirmation email.
BookingId
integer
Internal booking ID (primary key).
SupplierReference
string
The insurer's own policy reference. Populated after the policy is confirmed with the underwriter.
Expired
boolean
Whether the quote has expired.
FromDate
datetime
Protection start date/time.
ToDate
datetime
Protection end date/time.
CoveredDays
integer
Number of days the customer is covered.
TotalAmount
float
Total premium the customer pays (includes discounts and markups).
TotalAmountFormatted
string
Formatted TotalAmount.
InsuranceCoverAmount
float
Total amount of coverage the product provides.
InsuranceCoverAmountFormatted
string
Formatted InsuranceCoverAmount.
DailyAmountFormatted
string
TotalAmount divided by CoveredDays, formatted.
DiscountFormatted
string
Discount applied, formatted.
Currency
string(3)
ISO 4217 currency code for the booking.
DestinationCountry
string
Full name of the destination country.
VehiclePickupRegion
string
State/region/territory code for the vehicle pickup location, echoed from the request.
QuoteUrl
string
URL to the payment page on RentalCover.com. Embed in confirmation emails for customers who decline at checkout.
PoweredByLogo
string
URL of the RentalCover "Powered By" logo.
Documentation.Ipid
string
URL to the Insurance Product Information Document (IPID). Returned only when applicable.
Disclaimer
string
Policy disclaimer text to display to the customer.
EsimCouponEligible
string
true if the partner and destination are eligible for an eSIM coupon.
Nested objects
Last updated
Was this helpful?