For the complete documentation index, see llms.txt. This page is also available as Markdown.

Extras

Retrieve details of a specific extra

get

Retrieve a specific extra's details, including its photos and applicable taxes.

Authorizations
x-sm-api-keystringRequired
Path parameters
propertyUuidstringRequired

UUID for a property.

uuidany ofRequired

UUID for an extra.

string · uuidOptional
or
string · min: 10OptionalPattern: ^[a-zA-Z0-9]+$
Header parameters
x-sm-api-keystringRequired

API key used to authenticate the request.

Responses
200

Successful operation

application/json
uuidstringRequired

Unique identifier for the extra.

namestringRequired

Name of the extra.

descriptionstring · nullableRequired

Description of the extra, null when it has none.

categorystring · enumRequired

How the extra is charged.

Possible values:
mandatorybooleanRequired

Whether the extra is always added to a booking rather than being optional.

amountnumber · nullableRequired

Charge for the extra, per booking / per room / per room per night depending on category. Null for the two per-person categories, where adultRate and childRate apply instead.

adultRatenumber · nullableRequired

Charge per adult, null unless the category is per-person or per-person-per-night.

childRatenumber · nullableRequired

Charge per child, null unless the category is per-person or per-person-per-night.

allowMultiplebooleanRequired

Whether more than one unit of this extra can be added to a single booking.

applicableFromstring · date · nullableRequired

Earliest stay date the extra applies to, null when unbounded.

applicableTostring · date · nullableRequired

Latest stay date the extra applies to, null when unbounded.

get/properties/{propertyUuid}/extras/{uuid}
GET /properties/{propertyUuid}/extras/{uuid} HTTP/1.1
x-sm-api-key: text
Accept: */*
{
  "uuid": "e3e3d0d1-6666-4a3a-9a3a-555555555555",
  "name": "Breakfast Add-on",
  "description": "Continental breakfast served 6:30-10:00.",
  "category": "per-person-per-night",
  "mandatory": false,
  "amount": null,
  "adultRate": 15,
  "childRate": 7.5,
  "allowMultiple": false,
  "applicableFrom": "2026-12-01",
  "applicableTo": "2027-02-28",
  "photos": [
    {
      "url": "https://example.com/attachments/extra_photos/images/9/breakfast.jpg",
      "caption": "Continental spread",
      "sortOrder": 1
    }
  ],
  "taxes": [
    {
      "uuid": "a1a1d0d1-7777-4a3a-9a3a-666666666666",
      "name": "VAT",
      "percentage": 10
    }
  ]
}

Last updated

Was this helpful?