Item

An Item is directly attached to a subscription. It represents an insured object that can be reimbursed by the insurance company.

info

Properties event_* and holder_* are useful for event cancellation insurance only.

numberstringrequired

Number / unique reference / ticket barcode

Possible values: <= 128 characters

Example: 123456789

labelstringrequired

Description of the item (eg. Cat, Localization etc)

Possible values: <= 100 characters

Example: Gold Ticket

pricefloatrequired

Unit price of the item

Example: 380

insured_amountfloat

Insured amount, if different from price.

refundable_amountfloat

Refundable amount for this item.

insurance_amountfloatrequired

The insurance amount paid by the buyer for this item. Optional in case of global subscription calculation

insurance_discount_amountfloat

Discount applied to the insurance amount.

event_idstring

Existing event ID. You don't need to specify other event_ properties.

event_namestring

Event name / Hotel name

Possible values: <= 100 characters

Example: Best Band Live

event_date_startdate-time

Event start date (ISO 8601)

Example: 2026-02-12T15:19:21+00:00

event_date_enddate-time

Event end date (ISO 8601)

Example: 2026-03-12T15:19:21+00:00

event_addressstringnullable

Event address

Possible values: <= 100 characters

Example: 5 rue du Somewhere 5th Arr.

event_zipcodestringnullable

Event zipcode

Possible values: <= 10 characters

Example: 75005

event_citystringnullable

Event city

Possible values: <= 100 characters

Example: Paris

event_placestringnullable

Event location, place name, precision (e.g Accor Hotel Arena, Staples Center)

Possible values: <= 100 characters

Example: Théatre St Martin

event_typestringnullable

Event type (concert, festival, show...)

Possible values: <= 50 characters

Example: concert

event_tourstringnullable

Event tour

Possible values: <= 100 characters

event_countrystringnullable

ISO 3166 country code (2 chars)

Possible values: <= 2 characters

Example: FR

event_regionstringnullable

ISO 3166-2 subdivision code of the event.

Optional, but strongly recommended for countries spanning several timezones (US, CA, AU, BR, MX, RU, ID, KZ, CD, MN, CL, EC, ES, PT, GL, NZ, KI, FM), where the country code alone is not enough to determine the event timezone.

Possible values: <= 6 characters

Example: TX

holder_namestring

Name of the item holder

Possible values: <= 100 characters

Example: Patrick Smith

holder_emailstring

Email of the item holder

Possible values: <= 100 characters

Example: patrick-smith@exemple.com

holder_date_of_birthdate

Birthdate of the item holder (YYYY-MM-DD)

Example: 1964-01-29

quantityinteger

Quantity of this item

Possible values: >= 1

Default value: 1

packinteger

Pack identifier

Default value: 0

point_of_salestring

Point of sale identifier

supportstring

Support type identifier

additional_dataobject

You can use this parameter to attach any key-value data.

Example: {"key":"value"}

Item

{
  "label": "Gold Ticket",
  "number": 123456789,
  "event_name": "Best Band Live",
  "event_date_start": "2026-02-12T15:19:21+00:00",
  "event_date_end": "2026-03-12T15:19:21+00:00",
  "event_place": "Théatre St Martin",
  "event_zipcode": "75005",
  "event_address": "5 rue du Somewhere 5th Arr.",
  "event_city": "Paris",
  "event_country": "FR",
  "event_type": "concert",
  "insurance_amount": 5,
  "price": 100
}