Cover
Introduction
🔗 For transfer subscriptions methods, see Transfer subscriptions to Meetch
🔗 For transfer premium calculation information, see Premium calculation
API: Main endpoints
🔗 For authentication instructions, see Authentication.
Create an annual subscription
In your system, when a person subscribes to Meetch cancellation insurance, you can send us the information via 2 methods:
-
Send us one by one the subscriptions created:
-
Send us a set of subscriptions (so-called “bulk” method):
Sample Payload :
{
"order_date": "2025-01-01",
"product_id": "",
"order_reference": "62886",
"currency": "EUR",
"preferred_locale": "fr-FR",
"buyer_firstname": "Alfred",
//Firstname owner
"buyer_lastname": "Maison",
//Lastname owner
"buyer_email": "am@mail.fr",
//Email owner
"buyer_address": "Avenue des Champs-Élysées",
//Owner address
"buyer_zipcode": "75008",
"buyer_city": "PARIS",
"buyer_country": "FR",
"items": [
{
"number": "000001",
"label": "House name, Room name, ...",
"event_name": "Event name",
// Event name
"event_address": "",
//House address
"event_zipcode": "",
//House zipcode
"event_city": ""
//House city
}
]
}
Create a subscription with specific contract dates
In your system, when a person subscribes to Meetch cancellation insurance, you can send us the information via 2 methods:
-
Send us one by one the subscriptions created:
-
Send us a set of subscriptions (so-called “bulk” method):
Sample Payload :
{
"order_date": "2025-01-01",
"product_id": "",
"order_reference": "62886",
"currency": "EUR",
"preferred_locale": "fr-FR",
"buyer_firstname": "Alfred",
//Firstname owner
"buyer_lastname": "Maison",
//Lastname owner
"buyer_email": "am@mail.fr",
//Email owner
"buyer_address": "Avenue des Champs-Élysées",
//Owner address
"buyer_zipcode": "75008",
"buyer_city": "PARIS",
"buyer_country": "FR",
"contract_date_start": "2024-11-01T100:00:00",
//First day of the month or start of annual subscription
"contract_date_end": "2024-11-10T100:00:00",
//Last day of the month or end of annual subscription
"items": [
{
"number": "000001",
"label": "House name, Room name, ...",
"event_name": "Event name",
// Event name
"event_address": "",
//House address
"event_zipcode": "",
//House zipcode
"event_city": ""
//House city
}
]
}
Create a subscription for a stay
In your system, when a person subscribes to Meetch cancellation insurance, you can send us the information via 2 methods:
-
Send us one by one the subscriptions created:
-
Send us a set of subscriptions (so-called “bulk” method):
Sample Payload :
{
"order_date": "2025-01-01",
"product_id": "",
"order_reference": "62886",
"currency": "EUR",
"preferred_locale": "fr-FR",
"buyer_firstname": "Alfred",
//Firstname owner
"buyer_lastname": "Maison",
//Lastname owner
"buyer_email": "am@mail.fr",
//Email owner
"buyer_address": "Avenue des Champs-Élysées",
//Owner address
"buyer_zipcode": "75008",
"buyer_city": "PARIS",
"buyer_country": "FR",
"contract_date_start": "2024-11-01T100:00:00",
//Beginning of stay
"contract_date_end": "2024-11-10T100:00:00",
//End of stay
"items": [
{
"number": "000001",
"label": "House name, Room name, ...",
"event_name": "Event name",
// Event name
"event_date_start": "2024-11-01T100:00:00",
//Event start date (ISO 8601) - beginning of stay
"event_date_end": "2024-11-10T100:00:00",
//Event end date (ISO 8601) - end of stay
"event_address": "",
//House address
"event_zipcode": "",
//House zipcode
"event_city": ""
//House city
}
]
}
Specific case: Per-night product & Create a subscription for a stay
In your system, when a person subscribes to Meetch cancellation insurance, you can send us the information via 2 methods:
-
Send us one by one the subscriptions created:
-
Send us a set of subscriptions (so-called “bulk” method):
Sample Payload :
{
"order_date": "2025-01-01",
"product_id": "",
"order_reference": "62886",
"currency": "EUR",
"preferred_locale": "fr-FR",
"buyer_firstname": "Alfred",
//Firstname owner
"buyer_lastname": "Maison",
//Lastname owner
"buyer_email": "am@mail.fr",
//Email owner
"buyer_address": "Avenue des Champs-Élysées",
//Owner address
"buyer_zipcode": "75008",
"buyer_city": "PARIS",
"buyer_country": "FR",
"contract_date_start": "2024-11-01T100:00:00",
//Beginning of stay
"contract_date_end": "2024-11-05T100:00:00",
//End of stay
"items": [
{
"number": "000001",
"label": "House name, Room name, ...",
"event_name": "Event name",
// Event name
"event_date_start": "2024-11-01T100:00:00",
//Event start date (ISO 8601) - beginning of stay
"event_date_end": "2024-11-05T100:00:00",
//Event end date (ISO 8601) - end of stay
"event_address": "",
//House address
"event_zipcode": "",
//House zipcode
"event_city": "",
//House city
"refundable_amount": 5
//Number of night
}
]
}
Deposit on a SFTP server of a CSV file
🔗 For File deposit instructions, see File deposit.
The uploaded file must have the following format:
| Column name | Required ? Y (Yes) N (Non) | Description |
|---|---|---|
| order_reference | Y | Order reference |
| product | Y | Product identifier |
| buyer_company | Y | Hosting name |
| buyer_address | Y | Accommodation address |
| item_label | N | Address complement |
| buyer_zipcode | Y | Zip code |
| buyer_city | City | |
| buyer_lastname | Y | Customer’s last name |
| buyer_firstname | Y | Customer's first name |
| buyer_email | Y | Customer’s email |
| quantity | N | Number of rooms Please specify if hotel or guest house |
| item_refundable_amount | N | Number of night |
| event_date_start | N | Start date of the stay Expected format: YYYY-MM-DD |
| event_date_end | N | End date of the stay Expected format: YYYY-MM-DD |
| contract_date_start | N | Strat date of the insurance contract Expected format: YYYY-MM-DD |
| contract_date_end | N | End date of the insurance contract Expected format: YYYY-MM-DD |
| preferred_locale | N | Customer's preferred language. Example: fr_FR (French) or en_US (English). It is possible to specify only the language without the locale (fr or en) |
| status | N | Indicates whether we are on a subscription creation or update. Possible values: C (create, default value), U (update), A (cancel). In the case of a cancellation on a single item, you can use the “item_cancel” status. |
Any other information deemed useful may be transmitted in additional columns.