Skip to main content
POST
/
api
/
billing
/
extraservices
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
An ExtraService serves two distinct purposes:
  1. 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.
  2. Printing credit — when IsPrintingCredit is true, the extra service represents a printing allowance rather than booking time. In this case ChargePeriod must always be 5 (Uses) and Price should be set to 1.
CRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates) Restrictions available on each extra service include:
  • Charge period — hourly, daily, etc. (ChargePeriod). For printing credit, always use 5 (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)
To set up pricing for a resource type, create one 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, set ChargePeriod` 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-Create role.

Enums

ValueName
1Minutes
2Days
3Weeks
4Months
5Uses
6FourWeekMonths
ValueName
1Disabled
2Fixed
3Gradual

Request Body

Required Fields

BusinessId
integer
required
Business Id.
Name
string
required
Extra service name.
DisplayOrder
integer
required
Display order. Defaults to 0.
Price
number
required
Price.
CurrencyId
integer
required
Currency Id.

Optional Fields

Description
string
Description.
InvoiceLineDisplayAs
string
Invoice line display text.
Visible
boolean
Whether the price is visible on the portal and app. Defaults to true.
ResourceTypes
integer[]
Resource Types.
CreditPrice
number
Credit price.
ChargePeriod
integer
Charge period. Defaults to eChargePeriod.Minutes. See eChargePeriod enum above.
MaximumPrice
number
Maximum price cap.
IsDefaultPrice
boolean
Use as the default price for matched resource types if more than one price applies.
UsePerNightPricing
boolean
Use per-night pricing.
TaxRateId
integer
Tax Rate Id.
ReducedTaxRateId
integer
Reduced Tax Rate Id.
ExemptTaxRateId
integer
Exempt Tax Rate Id.
FinancialAccountId
integer
Financial Account Id.
FromTime
integer
Start time restriction (minutes from midnight).
ToTime
integer
End time restriction (minutes from midnight).
MinLength
integer
Minimum booking length (minutes).
MaxLength
integer
Maximum booking length (minutes).
OnlyWithinAvailableTimes
boolean
Only apply within the resource’s available times.
FixedCostLength
integer
Fixed cost booking length threshold (minutes).
FixedCostPrice
number
Fixed cost price applied once the threshold is reached.
Tariffs
integer[]
Tariffs.
OnlyForContacts
boolean
Only available for contacts.
OnlyForMembers
boolean
Only available for members.
IsBookingCredit
boolean
Price uses booking credits.
IsPrintingCredit
boolean
Price uses printing credits.
ApplyChargeToVisitors
boolean
Apply charge to visitors.
PriceFactorLowDemand
number
Price factor for low demand periods.
PriceFactorAverageDemand
number
Price factor for average demand periods.
PriceFactorHighDemand
number
Price factor for high demand periods.
PriceFactorLastMinute
number
Price factor for last-minute bookings.
LastMinutePeriodMinutes
integer
Last-minute period threshold (minutes before booking).
LastMinuteAdjustmentType
integer
Last-minute discount type. Defaults to eLastMinuteDiscountType.Gradual. See eLastMinuteDiscountType enum above.
ApplyFrom
string
Date from which this price applies.
ApplyTo
string
Date until which this price applies.
ResourceTypeNames
string
Comma-separated names of associated resource types.
Teams
integer[]
Teams.

Children

TimeSlots
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

curl -X POST \
  "https://spaces.nexudus.com/api/billing/extraservices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "DisplayOrder": 0,
    "Price": 0,
    "CurrencyId": 0,
    "TimeSlots": [
        {
            "DayOfWeek": 0,
            "FromTime": "2025-01-15T10:30:00Z",
            "ToTime": "2025-01-15T10:30:00Z",
            "Available": null
        }
    ]
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the creation.
Value
object
Contains the Id of the newly created record.
WasSuccessful
boolean
true if the extraservice was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "ExtraService was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}