ExtraServices
Search ExtraServices
Search and list ExtraService records with filtering, sorting, and pagination.
GET
Search ExtraServices
Resource Rates (internally Extra services) are pricing rules for resource types (like meeting rooms) that define how resources are billed, including charge periods, dynamic pricing, and customer restrictions
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ExtraService-List role.Enums
eChargePeriod — ChargePeriod values
eChargePeriod — ChargePeriod values
eLastMinuteDiscountType — LastMinuteAdjustmentType values
eLastMinuteDiscountType — LastMinuteAdjustmentType values
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the location this resource rate belongs to.
string
Filter by resource rate name.
string
Filter by optional description of this resource rate.
string
Filter by custom text shown on invoice lines instead of the resource rate name.
boolean
Filter by whether this resource rate is listed on the website. Not currently used..
integer
Filter by sort position of this resource rate; lower values appear first.
number
Filter by base price in the selected currency per charge period; minute-based rates are prorated as an hourly price.
number
Filter by optional alternative price used when the customer pays using time credit; null uses the base price.
integer
Filter by unit used to calculate the booking cost: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths.
number
Filter by optional maximum amount this rate can charge for a booking after length-based calculation.
boolean
Filter by whether this rate is preferred when multiple valid rates match the same resource and charge period.
boolean
Filter by whether day-based booking length is calculated by nights rather than elapsed 24-hour periods.
integer
Filter by iD of the currency used for prices charged by this resource rate.
string
Filter by display value for Currency.Code..
integer
Filter by iD of the standard tax rate applied to charges; may be required by location settings for rates that are not booking credits.
string
Filter by display value for TaxRate.Name..
integer
Filter by iD of the reduced tax rate applied when the customer qualifies for reduced taxation.
integer
Filter by iD of the tax rate applied when the customer is tax exempt.
integer
Filter by iD of the financial account used to record revenue; may be required by location settings for rates that are not booking credits.
string
Filter by display value for FinancialAccount.Name..
integer
Filter by legacy start hour restriction; manage availability through time slots instead.
integer
Filter by legacy end hour restriction; manage availability through time slots instead.
integer
Filter by optional minimum booking length expressed in the selected charge period.
integer
Filter by optional maximum booking length expressed in the selected charge period.
boolean
Filter by legacy availability enforcement flag; availability is determined by the configured time slots.
integer
Filter by optional initial booking duration in minutes charged at FixedCostPrice; requires FixedCostPrice.
number
Filter by fixed amount charged for the initial FixedCostLength minutes; requires FixedCostLength.
boolean
Filter by whether this rate is restricted to contacts without an active contract; cannot be true together with OnlyForMembers.
boolean
Filter by whether this rate is restricted to customers with an active contract; cannot be true together with OnlyForContacts.
boolean
Filter by whether this record defines a time credit type rather than a chargeable resource rate.
boolean
Filter by whether this record defines a printing credit type used by printing integrations.
boolean
Filter by whether the booking charge is multiplied by the number of visitors linked to the booking.
number
Filter by optional signed percentage adjustment for low demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor.
number
Filter by optional signed percentage adjustment for average demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor.
number
Filter by optional signed percentage adjustment for high demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor.
number
Filter by optional signed percentage adjustment for bookings made within LastMinutePeriodMinutes; negative values discount and positive values increase the price.
integer
Filter by number of minutes before a booking starts during which PriceFactorLastMinute applies.
integer
Filter by how the last-minute adjustment is applied: Fixed applies the full factor throughout the period; Gradual increases it from zero at the period boundary to the full factor near the start time; Disabled turns it off.
string
Filter by optional date and time from which this rate is valid, inclusive.
string
Filter by optional date and time until which this rate is valid, exclusive.
string
Filter by read-only resource type names generated from ResourceTypes.
Range Filters
integer
Filter by sort position of this resource rate; lower values appear first greater than or equal to this value.
integer
Filter by sort position of this resource rate; lower values appear first less than or equal to this value.
number
Filter by base price in the selected currency per charge period; minute-based rates are prorated as an hourly price greater than or equal to this value.
number
Filter by base price in the selected currency per charge period; minute-based rates are prorated as an hourly price less than or equal to this value.
number
Filter by optional alternative price used when the customer pays using time credit; null uses the base price greater than or equal to this value.
number
Filter by optional alternative price used when the customer pays using time credit; null uses the base price less than or equal to this value.
number
Filter by optional maximum amount this rate can charge for a booking after length-based calculation greater than or equal to this value.
number
Filter by optional maximum amount this rate can charge for a booking after length-based calculation less than or equal to this value.
integer
Filter by legacy start hour restriction; manage availability through time slots instead greater than or equal to this value.
integer
Filter by legacy start hour restriction; manage availability through time slots instead less than or equal to this value.
integer
Filter by legacy end hour restriction; manage availability through time slots instead greater than or equal to this value.
integer
Filter by legacy end hour restriction; manage availability through time slots instead less than or equal to this value.
integer
Filter by optional minimum booking length expressed in the selected charge period greater than or equal to this value.
integer
Filter by optional minimum booking length expressed in the selected charge period less than or equal to this value.
integer
Filter by optional maximum booking length expressed in the selected charge period greater than or equal to this value.
integer
Filter by optional maximum booking length expressed in the selected charge period less than or equal to this value.
integer
Filter by optional initial booking duration in minutes charged at FixedCostPrice; requires FixedCostPrice greater than or equal to this value.
integer
Filter by optional initial booking duration in minutes charged at FixedCostPrice; requires FixedCostPrice less than or equal to this value.
number
Filter by fixed amount charged for the initial FixedCostLength minutes; requires FixedCostLength greater than or equal to this value.
number
Filter by fixed amount charged for the initial FixedCostLength minutes; requires FixedCostLength less than or equal to this value.
number
Filter by optional signed percentage adjustment for low demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor greater than or equal to this value.
number
Filter by optional signed percentage adjustment for low demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor less than or equal to this value.
number
Filter by optional signed percentage adjustment for average demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor greater than or equal to this value.
number
Filter by optional signed percentage adjustment for average demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor less than or equal to this value.
number
Filter by optional signed percentage adjustment for high demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor greater than or equal to this value.
number
Filter by optional signed percentage adjustment for high demand; for example 10 increases the price by 10% and -10 discounts it by 10%. Overrides the location-wide factor less than or equal to this value.
number
Filter by optional signed percentage adjustment for bookings made within LastMinutePeriodMinutes; negative values discount and positive values increase the price greater than or equal to this value.
number
Filter by optional signed percentage adjustment for bookings made within LastMinutePeriodMinutes; negative values discount and positive values increase the price less than or equal to this value.
integer
Filter by number of minutes before a booking starts during which PriceFactorLastMinute applies greater than or equal to this value.
integer
Filter by number of minutes before a booking starts during which PriceFactorLastMinute applies less than or equal to this value.
string
Filter by optional date and time from which this rate is valid, inclusive greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional date and time from which this rate is valid, inclusive less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional date and time until which this rate is valid, exclusive greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional date and time until which this rate is valid, exclusive less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
ExtraService[]
The list of ExtraService records matching the query. See the Get one ExtraService endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response