ExtraServices
Get one ExtraService
Retrieve a single ExtraService record by its Id.
GET
An ExtraService serves two distinct purposes:
- Resource-type pricing rule — defines how one or more resource types are billed. A single resource type can have multiple extra services — for example, one per charge period (hourly, half-day, full-day) or one per customer segment.
- Printing credit — when
IsPrintingCreditistrue, the extra service represents a printing allowance rather than booking time. In this caseChargePeriodmust always be5(Uses) andPriceshould be set to1.
- Charge period — hourly, daily, etc. (
ChargePeriod). For printing credit, always use5(Uses). - Customer type — members only (
OnlyForMembers) or contacts only (OnlyForContacts) - Time window — bookings must fall within specific hours (
FromTime,ToTime) - Booking length — minimum/maximum duration (
MinLength,MaxLength) - Fixed-cost slot — charge a flat fee for bookings up to a fixed length (
FixedCostLength,FixedCostPrice) - Dynamic pricing — price factors for low/average/high demand and last-minute bookings
- Date range — apply only between specific dates (
ApplyFrom,ApplyTo)
ExtraService per pricing rule and associate it with the desired resource type(s) using or the resource types assignment. The ResourceTypeNames field on an extra service shows which resource types it currently applies to.
To create a printing credit extra service, set IsPrintingCredit` true`, ChargePeriod 5, and “Price 1. Resource type assignment is not required for printing credit extra services.
Setting up hourly pricing
For hourly pricing, setChargePeriod` 1` (Minutes) and Price“ to the cost of 60 minutes. The system interprets a charge period of 1 minute as hourly billing when the price represents a full hour.
Example — create a $50/hour meeting room pricing rule:
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-Read role.Path Parameters
The Id of the ExtraService record to retrieve.
Code Examples
Response
200
Business Id.
Extra service name.
Description.
Invoice line display text.
Whether the price is visible on the portal and app.
Display order.
Resource Types.
Price.
Credit price.
Charge period. See
eChargePeriod enum values: 1 = Minutes, 2 = Days, 3 = Weeks, 4 = Months, 5 = Uses, 6 = FourWeekMonths.Maximum price cap.
Use as the default price for matched resource types if more than one price applies.
Use per-night pricing.
Currency Id.
Currency code.
Tax Rate Id.
Reduced Tax Rate Id.
Exempt Tax Rate Id.
Financial Account Id.
Start time restriction (minutes from midnight).
End time restriction (minutes from midnight).
Minimum booking length (minutes).
Maximum booking length (minutes).
Only apply within the resource’s available times.
Fixed cost booking length threshold (minutes).
Fixed cost price applied once the threshold is reached.
Tariffs.
Only available for contacts.
Only available for members.
Price uses booking credits.
Price uses printing credits.
Apply charge to visitors.
Price factor for low demand periods.
Price factor for average demand periods.
Price factor for high demand periods.
Price factor for last-minute bookings.
Last-minute period threshold (minutes before booking).
Last-minute discount type. See
eLastMinuteDiscountType enum values: 1 = Disabled, 2 = Fixed, 3 = Gradual.Date from which this price applies.
Date until which this price applies.
Comma-separated names of associated resource types.
Teams.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response