Subscription

A Subscription represents the creation of an insurance contract by Meetch issued to a customer.

product_idstring

Identifier of the insurance product.

Example: prod_abc123

referencestring

Meetch reference of the subscription

Possible values: >= 8 characters and <= 12 characters

Example: 11223344

order_referencestringrequired

Order reference made on the vendor side

Possible values: <= 128 characters

Example: ORD_123ABC

order_datestringrequired

Date of the order on the vendor side (ISO 8601 preferred)

Example: 2024-11-01 17:35

statusstring

Possible values: [active, archived, waiting_payment, incomplete]

currencystring

ISO 4217 currency code (3 chars)

Default value: EUR

Example: EUR

preferred_localestring

Buyer language (en_US, fr_FR, fr). This locale will be used in emails and insurance certificate.

Example: fr_FR

insurance_amountfloat

The total cost of the insurance paid by the buyer.

Example: 10

order_amountfloatrequired

The total cost of the customer order (insurance + items). This amount is provided for information only and is not used to calculate the refund.

Example: 380

items object[]required

List of insured items.

Array [

numberstringrequired

Number / unique reference / ticket barcode

Possible values: <= 128 characters

Example: 123456789

labelstringrequired

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

Possible values: <= 50 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_startdatetimenullable

Event start date (ISO 8601)

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

event_date_enddatetimenullable

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: <= 50 characters

Example: Paris

event_placestringnullable

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

Possible values: <= 50 characters

Example: Théatre St Martin

event_typestringnullable

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

Possible values: <= 30 characters

Example: concert

event_tourstringnullable

Event tour

Possible values: <= 50 characters

event_countrystringnullable

ISO 3166 country code (2 chars)

Possible values: <= 2 characters

Example: FR

holder_namestring

Name of the item holder

Possible values: <= 50 characters

Example: Patrick Smith

holder_emailstring

Email of the item holder

Possible values: <= 100 characters

Example: patrick-smith@exemple.com

holder_date_of_birthdatetime

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

Example: 1964-01-29

additional_dataobject

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

Example: {"key":"value"}

]

buyer_genderstring

Buyer gender

Possible values: <= 10 characters

Example: M

buyer_firstnamestringrequired

Buyer firstname (optional if buyer_company is set)

Possible values: <= 50 characters

Example: John

buyer_lastnamestringrequired

Buyer lastname (optional if buyer_company is set)

Possible values: <= 50 characters

Example: Doe

buyer_companystring

Buyer company

Possible values: <= 50 characters

Example: Company

buyer_emailemailrequired

Buyer email

Possible values: <= 100 characters

Example: example@meetch.io

buyer_phonestring

Buyer phone

Possible values: <= 20 characters

Example: +33601020304

buyer_addressstring

Buyer address

Possible values: <= 100 characters

Example: Allée Napoléon III

buyer_countrystring

Buyer country code (ISO 3166 2 chars)

Possible values: >= 2 characters and <= 2 characters

Example: FR

buyer_citystring

Buyer city

Possible values: <= 50 characters

Example: Bourges

buyer_zipcodestring

Buyer zipcode

Possible values: <= 10 characters

Example: 18000

buyer_date_of_birthdatetime

Buyer birthdate (ISO 8601)

Example: 1979-06-18

created_atdatetime

Creation date (ISO 8601)

additional_dataobject

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

Example: {"key":"value"}

Subscription

{
  "product_id": "prod_abc123",
  "reference": 11223344,
  "order_reference": "ORD_123ABC",
  "order_date": "2024-11-01 17:35",
  "status": "active",
  "currency": "EUR",
  "preferred_locale": "fr_FR",
  "insurance_amount": 10,
  "order_amount": 380,
  "items": [
    {
      "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
    }
  ],
  "buyer_gender": "M",
  "buyer_firstname": "John",
  "buyer_lastname": "Doe",
  "buyer_company": "Company",
  "buyer_email": "example@meetch.io",
  "buyer_phone": "+33601020304",
  "buyer_address": "Allée Napoléon III",
  "buyer_country": "FR",
  "buyer_city": "Bourges",
  "buyer_zipcode": "18000",
  "buyer_date_of_birth": "1979-06-18",
  "created_at": "string",
  "additional_data": {
    "key": "value"
  }
}