The policy object

Example policy object

Example policy object

{
  "id": "a749b6df-5c59-4f08-9e44-4bbc15c14704",
  "version": 3,
  "object": "policy",
  "currency": "EUR",
  "term_length": 12,
  "coverage_terms": ["theft"],
  "title": "Theft insurance",
  "required_products": "exactly_one",
  "offer_designation": "insurance",
  "embedded": true,
  "post_purchase_window_days": 0,
  "created_at": "2025-01-01T12:34:56.000000Z",
  "store_id": "9ba8d8e1-7f14-46bf-9148-ad705a4ec95c",
  "operator_product_category_ids": ["100"],
  "contract_coverage_locale_id": "9ba8d8e1-7f14-46bf-9148-ad705a4ec95c_ABCDEF"
}

Attributes

id	string	The identifier for this policy.
version	integer	A positive integer representing the revision number of the policy for a given id. This attribute is planned to be deprecated.
object	string, value is "policy"	String representing the object’s type. Objects of the same type share the same value.
currency	string	Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.
term_length	integer	A positive integer representing the term length of the insurance policy in months.
coverage_terms	array of strings	Array of coverage options of this offer. See below for available coverage options (eg. extended_warranty, theft).
title	string	A human-readable title for the policy. Warning: this field is intended for internal use and is not meant to be displayed to the end user.
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 plan. 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.
offer_designation	enum	insurance or service
embedded	boolean	Indicates if a policy 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.
post_purchase_window_days	integer	A nonnegative integer. For insurance policies that can be purchased separately from the product, it is positive and represents the time window (in days) within which the policy can be purchased. For other policies, it is zero.
created_at	timestamp	Time at which the policy was created. Formatted as a RFC 3339 timestamp, with up to nanosecond precision.
store_id	string	The unique identifier of the store this policy belongs to.
operator_product_category_ids	array of strings	An array of identifiers of the active merchant-provided categories of products that this policy covers.
contract_coverage_locale_id	string	The identifier for the contract coverage locale associated to this policy.

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.