Set Cancellation Policy

This endpoint override cancellation policies, including tiered fees and date-specific rules, for a VRBO property listing.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/policy/setCancellation

---

Header

app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type: application/json

Header	Type	Required	Description
app-id	string	Yes	Your application ID. Required for authentication.
Authorization	string	Yes	Your API key for authorization. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

---

listing_id string (Required)

VRBO listing ID.

---

name string (Required)

The name of the cancellation policy.

---

default_policies object (Required)

Default cancellation policy rules that apply if no override exists.

---

type string (Required)

Type of cancellation policy.

Supported values: "FIRM", "RELAXED", "STRICT", "CUSTOM", and "NO_REFUND"

---

additional_cancellation_fee object (Optional)

Additional fee applied on top of standard cancellation charges.

---

amount string (Required)

Amount of additional cancellation fee.

---

currency_code string (Required)

Currency code of the additional cancellation fee.

---

tiers array (Optional)

List of tiered cancellation rules based on days before check-in.

---

cutoff string (Required)

Number of days before check-in that this tier applies.

---

percentage string (Required)

Percentage of booking amount charged as cancellation fee.

---

override_policies array (Optional)

Policies that override the default policy for specific date ranges.

---

cancellation_policy object (Required)

Defines the type and details of the override cancellation policy.

---

type string (Required)

Type of cancellation policy.

---

tiers array (Optional)

List of tiered cancellation rules for CUSTOM type override policy.

---

cutoff integer (Required)

Number of days before check-in that this tier applies.

---

percentage string (Required)

Percentage of booking amount charged as cancellation fee.

---

date_ranges array (Required)

Specific date ranges when the override policy is applicable.

---

from string (Required)

Start date of the override policy. Format: "YYYY-MM-DD".

---

to string (Required)

End date of the override policy. Format: "YYYY-MM-DD".

---

Request

{
  "hotel_id": "AWSTEST",
  "listing_id": "73384756",
  "name": "test cancellation policy 2",
  "default_policies": {
    "type": "CUSTOM",
    "additional_cancellation_fee": {
      "amount": "1001",
      "currency_code": "USD"
    },
    "tiers": [
      {
        "cutoff": 6,
        "percentage": 20
      },
      {
        "cutoff": "12",
        "percentage": "10"
      },
      {
        "cutoff": "18",
        "percentage": "5"
      },
      {
        "cutoff": "24",
        "percentage": "5"
      }
    ]
  },
  "override_policies": [
    {
      "cancellation_policy": {
        "type": "STRICT"
      },
      "date_ranges": [
        {
          "from": "2024-06-20",
          "to": "2024-06-30"
        },
        {
          "from": "2024-12-20",
          "to": "2024-12-30"
        }
      ]
    },
    {
      "cancellation_policy": {
        "type": "CUSTOM",
        "tiers": [
          {
            "cutoff": "6",
            "percentage": "20"
          }
        ]
      },
      "date_ranges": [
        {
          "from": "2024-11-01",
          "to": "2024-11-30"
        }
      ]
    },
    {
      "cancellation_policy": {
        "type": "FIRM"
      },
      "date_ranges": [
        {
          "from": "2024-08-01",
          "to": "2024-08-30"
        }
      ]
    },
    {
      "cancellation_policy": {
        "type": "NO_REFUND"
      },
      "date_ranges": [
        {
          "from": "2024-09-01",
          "to": "2024-09-30"
        }
      ]
    },
    {
      "cancellation_policy": {
        "type": "RELAXED"
      },
      "date_ranges": [
        {
          "from": "2024-10-01",
          "to": "2024-10-30"
        }
      ]
    }
  ]
}

---

Response

---

Success Response

{
  "Status": "Success",
  "Data": [],
  "Message": "Cancellation Policy set successfully",
  "Trace-ID": ""
}

---

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Data object

The response data, the root element.

---

Message string

The message in the response.

---

Trace-ID string

Unique ID for tracing the API request.

---

Error Response

Validation Error

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "400",
      "ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
    },
    {
      "Code": "2004",
      "ShortText": "Listing Id is required"
    },
    {
      "Code": "1392",
      "ShortText": "Name is invalid or not found!"
    },
    {
      "Code": "1393",
      "ShortText": "default_policies is invalid or not found!"
    }
  ],
  "Message": "",
  "Trace-ID": ""
}

---

Error Response - Body Elements

Status string

Indicates the result of the API call.

Will be always "Fail" in case of an error response.

---

Errors array

The response error, the root element.

---

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

---

ShortText string

A short description of the error.

---

Message string

The message in the response.

---

Trace-ID string

Unique ID for tracing the API request.