The offer object

Example offer object

{
  "id": "23235424-4a35-43bd-bb6a-f67d01d5790e",
  "object": "offer",
  "coverage": ["theft"],
  "coverage_id": "1",
  "currency": "EUR",
  "required_products": "exactly_one",
  "payment_type": "one_time",
  "policy_id": "7f3baf0f-5282-4381-961b-4a8dcb056990",
  "price": 1000,
  "term": 12,
  "offer_designation": "insurance"
}

{
  "id": "23235424-4a35-43bd-bb6a-f67d01d5790e",
  "object": "offer",
  "coverage": ["theft"],
  "coverage_id": "1",
  "currency": "EUR",
  "recurring_interval": "month",
  "required_products": "any",
  "payment_type": "subscription",
  "policy_id": "7f3baf0f-5282-4381-961b-4a8dcb056990",
  "price": 1000,
  "total_price": 12000,
  "annualized_price": 12000,
  "term": 12,
  "offer_designation": "insurance"
}

Attributes


id	string	The identifier for this offer. It refers to the insurance plan that this offer was mapped to.
object	string, value is `"offer"`	String representing the object’s type. Objects of the same type share the same value.
offer_designation	enum	`insurance` or `service`
coverage	array of strings	Array of coverage options of this offer. See below for available coverage options (eg. `extended_warranty`, `theft`).
coverage_id	string	Identifier for this coverage combination. May be used to retrieve the corresponding coverage copy language in locale.
currency	string	Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.
recurring_interval	enum	String enum representing the recurrence of a subscription. Values include: `month`, `year`. This field is only present when `payment_type` is `subscription`.
required_products	enum	String enum representing how many products are required to be included in the `products` field when submitting an order tied to this offer. Values include: `exactly_one` when only one product is required, `at_least_one` when at least one product is required, and `any` when any number of products can be set including none.
payment_type	enum	String enum representing the payment type for this offer. Values can either be `one_time` or `subscription`.
policy_id	string	The stable identifier for this policy referred to by this offer.
price	integer	A positive integer representing the price of the offer in cents (e.g., 1999 cents to specify 19.99€).
total_price	integer	A positive integer representing the overall payment made throughout the duration of a subscription term (e.g., if a monthly recurring subscription costs 10.00€ and the subscription lasts for 12 months, the total price paid would be 120.00€). For recurring offers that have no term, this value is set to 0.
annualized_price	integer	A positive integer representing the overall payment made throughout a whole year of a subscription (e.g., if a monthly recurring subscription costs 10.00€ and the subscription lasts for 24 months, the annualized price paid would be 120.00€).
term	integer	A positive integer representing the term length of the insurance offer in months.
store_id	string	The unique identifier of the store this offer belongs to.
embedded	boolean	Indicates if an offer is of the type embedded, wherein coverage is automatically included with a product or service and the partner is the final entity responsible for payment.

Coverage options

Enum type	Description
`accidental_loss`	Accidental loss - Covers products against accidental loss.
`adh`	Accidental Damage from Handling - Covers products from damage resulting from accidents.
`cutting_error`	Cutting error - Covers products such as worktops and windows against errors during the cutting process.
`extended_warranty`	Extended warranty - Extends your manufacturer’s warranty by a number of years. Typically excludes normal wear & tear and damage caused by accidents.
`installation_damage`	Installation damage - Covers products against damage resulting from their installation.
`measurement_error`	Measurement error - Covers products against measurement errors made by the customer.
`stains`	Stains - Covers products against any mark of a foreign, soiling and indelible substance.
`theft`	Theft - Covers losses from burglary, robbery, and other types of theft.
`transport_damage`	Transport damage - Covers products against damage which occurred before delivery.
`oxidation`	Oxidation - Covers damages caused by oxidation or corrosion, typically after electronic devices are exposed to moisture or liquids containing water.