Get one ExtraService

GET

api

billing

extraservices

{id}

Get one ExtraService

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/extraservices/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Visible": true,
  "DisplayOrder": 123,
  "ResourceTypes": [
    123
  ],
  "Price": 123,
  "CreditPrice": 123,
  "ChargePeriod": 123,
  "MaximumPrice": 123,
  "IsDefaultPrice": true,
  "UsePerNightPricing": true,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FromTime": 123,
  "ToTime": 123,
  "MinLength": 123,
  "MaxLength": 123,
  "OnlyWithinAvailableTimes": true,
  "FixedCostLength": 123,
  "FixedCostPrice": 123,
  "Tariffs": [
    123
  ],
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "IsBookingCredit": true,
  "IsPrintingCredit": true,
  "ApplyChargeToVisitors": true,
  "PriceFactorLowDemand": 123,
  "PriceFactorAverageDemand": 123,
  "PriceFactorHighDemand": 123,
  "PriceFactorLastMinute": 123,
  "LastMinutePeriodMinutes": 123,
  "LastMinuteAdjustmentType": 123,
  "ApplyFrom": "<string>",
  "ApplyTo": "<string>",
  "ResourceTypeNames": "<string>",
  "Teams": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

integer

required

The Id of the ExtraService record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/extraservices/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/extraservices/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/extraservices/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Extra service name.

string

Free-text description of this extra service.

string

Invoice line display text.

boolean

Whether the price is visible on the portal and app.

integer

Display order.

integer[]

List of resource types linked to this record.

number

Unit price amount.

number

Credit price.

integer

Charge period. See eChargePeriod enum values: 1 = Minutes, 2 = Days, 3 = Weeks, 4 = Months, 5 = Uses, 6 = FourWeekMonths.

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 currency linked to this record.

string

Currency code.

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

integer

Last-minute discount type. See eLastMinuteDiscountType enum values: 1 = Disabled, 2 = Fixed, 3 = Gradual.

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.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "InvoiceLineDisplayAs": null,
  "Visible": false,
  "DisplayOrder": 0,
  "ResourceTypes": [],
  "Price": 0,
  "CreditPrice": null,
  "ChargePeriod": 0,
  "MaximumPrice": null,
  "IsDefaultPrice": false,
  "UsePerNightPricing": false,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "FromTime": null,
  "ToTime": null,
  "MinLength": null,
  "MaxLength": null,
  "OnlyWithinAvailableTimes": false,
  "FixedCostLength": null,
  "FixedCostPrice": null,
  "Tariffs": [],
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "IsBookingCredit": false,
  "IsPrintingCredit": false,
  "ApplyChargeToVisitors": false,
  "PriceFactorLowDemand": null,
  "PriceFactorAverageDemand": null,
  "PriceFactorHighDemand": null,
  "PriceFactorLastMinute": null,
  "LastMinutePeriodMinutes": null,
  "LastMinuteAdjustmentType": 0,
  "ApplyFrom": null,
  "ApplyTo": null,
  "ResourceTypeNames": null,
  "Teams": [],
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple ExtraServicesRetrieve multiple ExtraService records by their Ids in a single request.

Get one ExtraService

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/extraservices/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Visible": true,
  "DisplayOrder": 123,
  "ResourceTypes": [
    123
  ],
  "Price": 123,
  "CreditPrice": 123,
  "ChargePeriod": 123,
  "MaximumPrice": 123,
  "IsDefaultPrice": true,
  "UsePerNightPricing": true,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FromTime": 123,
  "ToTime": 123,
  "MinLength": 123,
  "MaxLength": 123,
  "OnlyWithinAvailableTimes": true,
  "FixedCostLength": 123,
  "FixedCostPrice": 123,
  "Tariffs": [
    123
  ],
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "IsBookingCredit": true,
  "IsPrintingCredit": true,
  "ApplyChargeToVisitors": true,
  "PriceFactorLowDemand": 123,
  "PriceFactorAverageDemand": 123,
  "PriceFactorHighDemand": 123,
  "PriceFactorLastMinute": 123,
  "LastMinutePeriodMinutes": 123,
  "LastMinuteAdjustmentType": 123,
  "ApplyFrom": "<string>",
  "ApplyTo": "<string>",
  "ResourceTypeNames": "<string>",
  "Teams": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Setting up hourly pricing

Authentication

Path Parameters

Code Examples

Response

200

​Setting up hourly pricing

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Setting up hourly pricing

Authentication

Path Parameters

Code Examples

Response

200