The plan object

Example plan object

{
  "id": "53ef16c8-d13f-4687-9727-593e60e98685",
  "object": "plan",
  "currency": "EUR",
  "product_price_range_min": 10000,
  "product_price_range_max": 20000,
  "price": {
    "amount": 2000,
    "recurring_interval": "month",
  },
  "commission": {
    "operator": 500,
    "tax1": 150,
    "tax2": 0,
    "tax3": 0,
  },
  "created_at": "2025-01-01T12:34:56.000000Z",
  "active": true,
  "market": "FR",
  "store_id": "9ba8d8e1-7f14-46bf-9148-ad705a4ec95c",
  "policy_id": "a749b6df-5c59-4f08-9e44-4bbc15c14704",
  "policy": {
    "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 plan.
object	string, value is `"plan"`	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.
product_price_range_min	integer	A nonnegative integer representing the lower bound (inclusive) of the range of product price covered by this plan, in cents.
product_price_range_max	integer	A positive integer representing the upper bound (exclusive) of the range of product price covered by this plan, in cents (e.g., `product_price_range_min: 10000` together with `product_price_range_max 20000` means that this plan applies to products whose price is between 100.00€ and 199.99€).
price	price dictionary	A nested object containing information about the plan's premium price. See below.
commission	commission dictionary	A nested object containing information about the commissions and taxes. See below.
created_at	timestamp	Time at which the plan was created. Formatted as a RFC 3339 timestamp, with up to nanosecond precision.
active	boolean	A boolean representing whether the plan's policy is currently active.
market	string	A two-letter code representing the market that this plan belongs to, e.g. `FR`.
store_id	string	The unique identifier of the store that this plan belongs to.
policy_id	string	The identifier of the insurance policy that this plan refers to.
policy	object, expanded resource	The expanded Policy resource associated with this plan. This is the full representation of the policy referenced by `policy_id`. It is included for convenience and context, but is not part of the Plan's data model — it remains a separate resource.

Price dictionary


amount	integer	A positive integer representing the premium price of the plan in cents (e.g., 1999 cents to specify 19.99€).
recurring_interval	enum	String enum representing the recurrence of a subscription. Values include: `month`, `year`. It is null if the plan is not a subscription.

Commission dictionary


operator	integer	A positive integer representing the operator's commission, in cents (e.g., 499 cents to specify 4.99€).
tax1	integer	A nonnegative integer representing a market-specific tax amount, in cents.
tax2	integer	A nonnegative integer representing a market-specific tax amount, in cents.
tax3	integer	A nonnegative integer representing a market-specific tax amount, in cents.