# Modify Booking

## Get Booking

> Retrieve detailed information about an existing booking including policy details, quotes, policyholder information, and current status. This is typically the first step in the modification workflow to retrieve current booking state before making changes. Use this endpoint to obtain the INS number (booking ID), quote IDs, price paid, or current policy details for subsequent operations like modifications or cancellations.

```json
{"openapi":"3.0.0","info":{"title":"Offers API","version":"1.0.0"},"servers":[{"url":"https://api.xcover.com/x"}],"security":[{"CustomAPISignature":[]}],"components":{"securitySchemes":{"CustomAPISignature":{"type":"apiKey","name":"Authorization","in":"header","description":"**Composite Authentication Scheme (Client Key, Date, and Signature)**\n\nThis scheme requires the client to provide **three** mandatory headers in every request:\n\n### 1. X-Api-Key (Client Key)\n* **Purpose:** Public identifier for the API consumer.\n* **Example:** `X-Api-Key: a1b2c3d4e5f6g7h8`\n\n### 2. Date (Timestamp)\n* **Purpose:** Timestamp used for generating the signature and preventing replay attacks.\n* **Format:** RFC 7231 format (e.g., in GMT).\n* **Example:** `Date: Sun, 09 Nov 2025 04:04:00 GMT`\n\n### 3. Authorization (Computed Signature)\n* **Purpose:** The cryptographic signature that verifies the request's authenticity and integrity.\n* **Format:** `SIGNATURE [authHeader]`\n\n**Signature Generation Logic:**\nThe `authHeader` value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the `Date` header), signed with the private **Client Secret**.\n"}}},"paths":{"/partners/{partner_code}/bookings/{booking_id}/":{"get":{"summary":"Get Booking","description":"Retrieve detailed information about an existing booking including policy details, quotes, policyholder information, and current status. This is typically the first step in the modification workflow to retrieve current booking state before making changes. Use this endpoint to obtain the INS number (booking ID), quote IDs, price paid, or current policy details for subsequent operations like modifications or cancellations.","tags":["Modify Booking"],"responses":{"200":{"description":"OK","headers":{"Date":{"schema":{"type":"string"}},"Transfer-Encoding":{"schema":{"type":"string"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Content-Encoding":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object"},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object"},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"nullable":true},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true}}}}}},"403":{"description":"Forbidden","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}},"Server-Timing":{"schema":{"deprecated":false}},"Cf-Team":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"Not Found","headers":{"Date":{"schema":{"type":"string"}},"Transfer-Encoding":{"schema":{"type":"string"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Content-Encoding":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}}}}}}}
```

## Modify booking

> The modification workflow is used when a customer wants to make changes to their existing policy. This endpoint allows you to update policy details which may result in price adjustments, refunds, or additional fees.

```json
{"openapi":"3.0.0","info":{"title":"Offers API","version":"1.0.0"},"servers":[{"url":"https://api.xcover.com/x"}],"security":[{"CustomAPISignature":[]}],"components":{"securitySchemes":{"CustomAPISignature":{"type":"apiKey","name":"Authorization","in":"header","description":"**Composite Authentication Scheme (Client Key, Date, and Signature)**\n\nThis scheme requires the client to provide **three** mandatory headers in every request:\n\n### 1. X-Api-Key (Client Key)\n* **Purpose:** Public identifier for the API consumer.\n* **Example:** `X-Api-Key: a1b2c3d4e5f6g7h8`\n\n### 2. Date (Timestamp)\n* **Purpose:** Timestamp used for generating the signature and preventing replay attacks.\n* **Format:** RFC 7231 format (e.g., in GMT).\n* **Example:** `Date: Sun, 09 Nov 2025 04:04:00 GMT`\n\n### 3. Authorization (Computed Signature)\n* **Purpose:** The cryptographic signature that verifies the request's authenticity and integrity.\n* **Format:** `SIGNATURE [authHeader]`\n\n**Signature Generation Logic:**\nThe `authHeader` value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the `Date` header), signed with the private **Client Secret**.\n"}}},"paths":{"/partners/{partner_code}/bookings/{booking_id}/":{"patch":{"summary":"Modify booking","description":"The modification workflow is used when a customer wants to make changes to their existing policy. This endpoint allows you to update policy details which may result in price adjustments, refunds, or additional fees.","tags":["Modify Booking"],"responses":{"200":{"description":"OK","headers":{"Date":{"schema":{"type":"string"}},"Transfer-Encoding":{"schema":{"type":"string"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"content-security-policy":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Content-Encoding":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object","properties":{"benefit-text-test":{"type":"string"},"benefit_rich_text_test":{"type":"string"}}},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object","properties":{"destination_region":{"type":"string"},"seller_entity":{"type":"string"},"age_brackets":{"type":"string"},"desitnation_sanctions":{"type":"array","items":{}},"sanctioned_distination_countries":{"type":"array","items":{"type":"string"}},"test_underwrting_rule":{"type":"boolean"}}},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"nullable":true},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string","format":"utc-millisec"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true}}}}}},"403":{"description":"Forbidden","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}},"Server-Timing":{"schema":{"deprecated":false}},"Cf-Team":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}},"422":{"description":"Unprocessable Entity","headers":{"Date":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string"},"update_fields":{"type":"object","properties":{"insured":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"}}}}}}},"required":["id","update_fields"]}}}}}}}}}}}
```

## Modify Booking - preview

> Preview the price impact of proposed changes to a booking before committing them. This endpoint calculates the price difference (refund or additional charge) for the requested modifications without applying them. Use this to show customers the financial impact before they confirm. The response includes an \`update\_id\` that must be used with the Confirm Update endpoint to apply the changes.

```json
{"openapi":"3.0.0","info":{"title":"Offers API","version":"1.0.0"},"servers":[{"url":"https://api.xcover.com/x"}],"security":[{"CustomAPISignature":[]}],"components":{"securitySchemes":{"CustomAPISignature":{"type":"apiKey","name":"Authorization","in":"header","description":"**Composite Authentication Scheme (Client Key, Date, and Signature)**\n\nThis scheme requires the client to provide **three** mandatory headers in every request:\n\n### 1. X-Api-Key (Client Key)\n* **Purpose:** Public identifier for the API consumer.\n* **Example:** `X-Api-Key: a1b2c3d4e5f6g7h8`\n\n### 2. Date (Timestamp)\n* **Purpose:** Timestamp used for generating the signature and preventing replay attacks.\n* **Format:** RFC 7231 format (e.g., in GMT).\n* **Example:** `Date: Sun, 09 Nov 2025 04:04:00 GMT`\n\n### 3. Authorization (Computed Signature)\n* **Purpose:** The cryptographic signature that verifies the request's authenticity and integrity.\n* **Format:** `SIGNATURE [authHeader]`\n\n**Signature Generation Logic:**\nThe `authHeader` value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the `Date` header), signed with the private **Client Secret**.\n"}}},"paths":{"/partners/{partner_code}/bookings/{booking_id}/quote_for_update":{"patch":{"summary":"Modify Booking - preview","description":"Preview the price impact of proposed changes to a booking before committing them. This endpoint calculates the price difference (refund or additional charge) for the requested modifications without applying them. Use this to show customers the financial impact before they confirm. The response includes an `update_id` that must be used with the Confirm Update endpoint to apply the changes.","tags":["Modify Booking"],"responses":{"200":{"description":"OK","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"content-security-policy":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object","properties":{"benefit-text-test":{"type":"string"},"benefit_rich_text_test":{"type":"string"}}},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object","properties":{"destination_region":{"type":"string"},"seller_entity":{"type":"string"},"age_brackets":{"type":"string"},"desitnation_sanctions":{"type":"array","items":{}},"sanctioned_distination_countries":{"type":"array","items":{"type":"string"}},"test_underwrting_rule":{"type":"boolean"}}},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}},"price_diff":{"type":"integer"},"price_diff_formatted":{"type":"string"}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string","format":"color"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true},"total_price_diff":{"type":"integer"},"total_price_diff_formatted":{"type":"string"},"update_id":{"type":"string"}}}}}},"403":{"description":"Forbidden","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}},"422":{"description":"Unprocessable Entity","headers":{"Date":{"schema":{"deprecated":false}},"Content-Length":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"errors":{"type":"object","properties":{"_non_field_errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string"},"update_fields":{"type":"object","properties":{"insured":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"}}}}}}},"required":["id","update_fields"]}}}}}}}}}}}
```

## Modify Booking - confirm

> Confirm and apply previously previewed booking modifications. This endpoint finalizes the changes calculated by the Preview endpoint. You must provide the \`update\_id\` returned from the Preview endpoint. If there is an additional charge, include the \`xpay\_charge\_id\` from the payment transaction.

```json
{"openapi":"3.0.0","info":{"title":"Offers API","version":"1.0.0"},"servers":[{"url":"https://api.xcover.com/x"}],"security":[{"CustomAPISignature":[]}],"components":{"securitySchemes":{"CustomAPISignature":{"type":"apiKey","name":"Authorization","in":"header","description":"**Composite Authentication Scheme (Client Key, Date, and Signature)**\n\nThis scheme requires the client to provide **three** mandatory headers in every request:\n\n### 1. X-Api-Key (Client Key)\n* **Purpose:** Public identifier for the API consumer.\n* **Example:** `X-Api-Key: a1b2c3d4e5f6g7h8`\n\n### 2. Date (Timestamp)\n* **Purpose:** Timestamp used for generating the signature and preventing replay attacks.\n* **Format:** RFC 7231 format (e.g., in GMT).\n* **Example:** `Date: Sun, 09 Nov 2025 04:04:00 GMT`\n\n### 3. Authorization (Computed Signature)\n* **Purpose:** The cryptographic signature that verifies the request's authenticity and integrity.\n* **Format:** `SIGNATURE [authHeader]`\n\n**Signature Generation Logic:**\nThe `authHeader` value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the `Date` header), signed with the private **Client Secret**.\n"}}},"paths":{"/partners/{partner_code}/bookings/{booking_id}/confirm_update/{update_id}/":{"post":{"summary":"Modify Booking - confirm","description":"Confirm and apply previously previewed booking modifications. This endpoint finalizes the changes calculated by the Preview endpoint. You must provide the `update_id` returned from the Preview endpoint. If there is an additional charge, include the `xpay_charge_id` from the payment transaction.","tags":["Modify Booking"],"responses":{"201":{"description":"Created","headers":{"Date":{"schema":{"deprecated":false}},"Content-Length":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"content-security-policy":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object","properties":{"benefit-text-test":{"type":"string"},"benefit_rich_text_test":{"type":"string"}}},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object","properties":{"destination_region":{"type":"string"},"seller_entity":{"type":"string"},"age_brackets":{"type":"string"},"desitnation_sanctions":{"type":"array","items":{}},"sanctioned_distination_countries":{"type":"array","items":{"type":"string"}},"test_underwrting_rule":{"type":"boolean"}}},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}},"price_diff":{"type":"integer"},"price_diff_formatted":{"type":"string"}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string","format":"color"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true},"total_price_diff":{"type":"integer"},"total_price_diff_formatted":{"type":"string"}}}}}},"403":{"description":"Forbidden","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"Not Found","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}},"422":{"description":"Unprocessable Entity","headers":{"Date":{"schema":{"deprecated":false}},"Content-Length":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"xpay_charge_id":{"type":"string"}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://partner-docs.covergenius.com/offers/api/reference/modify-booking.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.