Skip to main content
PUT
Update ExtraService
Updates an existing ExtraService record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

Request Body

Required Fields

integer
required
The Id of the ExtraService record to update.
integer
required
ID of the location this resource rate belongs to.
string
required
Resource rate name.
integer
required
Sort position of this resource rate; lower values appear first.
number
required
Base price in the selected currency per charge period; minute-based rates are prorated as an hourly price.
integer
required
Unit used to calculate the booking cost: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths.
integer
required
ID of the currency used for prices charged by this resource rate.
integer
required
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.

Optional Fields

string
Optional description of this resource rate.
string
Custom text shown on invoice lines instead of the resource rate name.
boolean
Whether this resource rate is listed on the website. Not currently used..
integer[]
List of resource types priced by this rate. At least one resource type is required.
integer[]
IDs added to the ResourceTypes relationship..
integer[]
IDs removed from the ResourceTypes relationship..
number
Optional alternative price used when the customer pays using time credit; null uses the base price.
number
Optional maximum amount this rate can charge for a booking after length-based calculation.
boolean
Whether this rate is preferred when multiple valid rates match the same resource and charge period.
boolean
Whether day-based booking length is calculated by nights rather than elapsed 24-hour periods.
integer
ID of the standard tax rate applied to charges; may be required by location settings for rates that are not booking credits.
integer
ID of the reduced tax rate applied when the customer qualifies for reduced taxation.
integer
ID of the tax rate applied when the customer is tax exempt.
integer
ID of the financial account used to record revenue; may be required by location settings for rates that are not booking credits.
integer
Legacy start hour restriction; manage availability through time slots instead.
integer
Legacy end hour restriction; manage availability through time slots instead.
integer
Optional minimum booking length expressed in the selected charge period.
integer
Optional maximum booking length expressed in the selected charge period.
boolean
Legacy availability enforcement flag; availability is determined by the configured time slots.
integer
Optional initial booking duration in minutes charged at FixedCostPrice; requires FixedCostPrice.
number
Fixed amount charged for the initial FixedCostLength minutes; requires FixedCostLength.
integer[]
List of plans whose active members can use this rate; empty means no plan restriction.
integer[]
IDs added to the Tariffs relationship..
integer[]
IDs removed from the Tariffs relationship..
boolean
Whether this rate is restricted to contacts without an active contract; cannot be true together with OnlyForMembers.
boolean
Whether this rate is restricted to customers with an active contract; cannot be true together with OnlyForContacts.
boolean
Whether this record defines a time credit type rather than a chargeable resource rate.
boolean
Whether this record defines a printing credit type used by printing integrations.
boolean
Whether the booking charge is multiplied by the number of visitors linked to the booking.
number
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
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
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
Optional signed percentage adjustment for bookings made within LastMinutePeriodMinutes; negative values discount and positive values increase the price.
integer
Number of minutes before a booking starts during which PriceFactorLastMinute applies.
string
Optional date and time from which this rate is valid, inclusive.
string
Optional date and time until which this rate is valid, exclusive.
integer[]
List of teams whose customers can use this rate; empty means no team restriction.
integer[]
IDs added to the Teams relationship..
integer[]
IDs removed from the Teams relationship..

Children

object[]
The days and times this extra service price is available for booking. The year, month and day component of FromTime/ToTime is always 1976-01-01.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the extraservice was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response