Create ExtraService

POST

api

billing

extraservices

Create ExtraService

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/extraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "DisplayOrder": 123,
  "Price": 123,
  "ChargePeriod": 123,
  "CurrencyId": 123,
  "LastMinuteAdjustmentType": 123,
  "FromTime": 123,
  "ToTime": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/extraservices"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "DisplayOrder": 123,
    "Price": 123,
    "ChargePeriod": 123,
    "CurrencyId": 123,
    "LastMinuteAdjustmentType": 123,
    "FromTime": 123,
    "ToTime": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    DisplayOrder: 123,
    Price: 123,
    ChargePeriod: 123,
    CurrencyId: 123,
    LastMinuteAdjustmentType: 123,
    FromTime: 123,
    ToTime: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/extraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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 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

eChargePeriod — ChargePeriod values

Value	Name
1	Minutes
2	Days
3	Weeks
4	Months
5	Uses
6	FourWeekMonths

eLastMinuteDiscountType — LastMinuteAdjustmentType values

Value	Name
1	Disabled
2	Fixed
3	Gradual

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Extra service name.

integer

required

Display order. Defaults to 0.

number

required

Unit price amount.

integer

required

Charge period. Defaults to eChargePeriod.Minutes.

integer

required

ID of the currency linked to this record.

integer

required

Last-minute discount type. Defaults to eLastMinuteDiscountType.Gradual.

Optional Fields

string

Free-text description of this extra service.

string

Invoice line display text.

boolean

Whether the price is visible on the portal and app. Defaults to true.

integer[]

List of resource types linked to this record.

number

Credit price.

number

Maximum price cap.

boolean

Use as the default price for matched resource types if more than one price applies.

boolean

Use per-night pricing.

integer

ID of the tax rate linked to this record.

integer

ID of the reduced tax rate linked to this record.

integer

ID of the exempt tax rate linked to this record.

integer

ID of the financial account linked to this record.

integer

Start time restriction (minutes from midnight).

integer

End time restriction (minutes from midnight).

integer

Minimum booking length (minutes).

integer

Maximum booking length (minutes).

boolean

Only apply within the resource’s available times.

integer

Fixed cost booking length threshold (minutes).

number

Fixed cost price applied once the threshold is reached.

integer[]

List of tariffs linked to this record.

boolean

Only available for contacts.

boolean

Only available for members.

boolean

Price uses booking credits.

boolean

Price uses printing credits.

boolean

Apply charge to visitors.

number

Price factor for low demand periods.

number

Price factor for average demand periods.

number

Price factor for high demand periods.

number

Price factor for last-minute bookings.

integer

Last-minute period threshold (minutes before booking).

string

Date from which this price applies.

string

Date until which this price applies.

string

Comma-separated names of associated resource types.

integer[]

List of teams linked to this record.

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.

Show child attributes

integer

required

The day of week value for this extra service time slot.

string

required

Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..

string

required

End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..

boolean

Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..

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,
    "ChargePeriod": 0,
    "CurrencyId": 0,
    "LastMinuteAdjustmentType": 0,
    "TimeSlots": [
        {
            "DayOfWeek": 0,
            "FromTime": "2025-01-15T10:30:00Z",
            "ToTime": "2025-01-15T10:30:00Z",
            "Available": null
        }
    ]
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/extraservices',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      DisplayOrder: 0,
      Price: 0,
      ChargePeriod: 0,
      CurrencyId: 0,
      LastMinuteAdjustmentType: 0,
      TimeSlots: [object Object]
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/extraservices',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'DisplayOrder': 0,
        'Price': 0,
        'ChargePeriod': 0,
        'CurrencyId': 0,
        'LastMinuteAdjustmentType': 0,
        'TimeSlots': [object Object]
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the extraservice was created successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update ExtraServiceUpdate an existing ExtraService record.

Create ExtraService

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/extraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "DisplayOrder": 123,
  "Price": 123,
  "ChargePeriod": 123,
  "CurrencyId": 123,
  "LastMinuteAdjustmentType": 123,
  "FromTime": 123,
  "ToTime": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/extraservices"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "DisplayOrder": 123,
    "Price": 123,
    "ChargePeriod": 123,
    "CurrencyId": 123,
    "LastMinuteAdjustmentType": 123,
    "FromTime": 123,
    "ToTime": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    DisplayOrder: 123,
    Price: 123,
    ChargePeriod: 123,
    CurrencyId: 123,
    LastMinuteAdjustmentType: 123,
    FromTime: 123,
    ToTime: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/extraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Setting up hourly pricing

Authentication

Enums

Request Body

Required Fields

Optional Fields

Children

Code Examples

Response

200

400

​Setting up hourly pricing

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Children

​Code Examples

​Response

​200

​400

Setting up hourly pricing

Authentication

Enums

Request Body

Required Fields

Optional Fields

Children

Code Examples

Response

200

400