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,
  "TaxRateName": "<string>",
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "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>"
}

Resource Rates (internally Extra services) are pricing rules for resource types (like meeting rooms) that define how resources are billed, including charge periods, dynamic pricing, and customer restrictions

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 location this resource rate belongs to.

string

Resource rate name.

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

Sort position of this resource rate; lower values appear first.

integer[]

List of resource types priced by this rate. At least one resource type is required.

number

Base price in the selected currency per charge period; minute-based rates are prorated as an hourly price.

number

Optional alternative price used when the customer pays using time credit; null uses the base price.

integer

Unit used to calculate the booking cost: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths. See eChargePeriod enum values: 1 = Minutes, 2 = Days, 3 = Weeks, 4 = Months, 5 = Uses, 6 = FourWeekMonths.

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 currency used for prices charged by this resource rate.

string

Display value for Currency.Code..

integer

ID of the standard tax rate applied to charges; may be required by location settings for rates that are not booking credits.

string

Display value for TaxRate.Name..

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.

string

Display value for FinancialAccount.Name..

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.

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.

integer

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. See eLastMinuteDiscountType enum values: 1 = Disabled, 2 = Fixed, 3 = Gradual.

string

Optional date and time from which this rate is valid, inclusive.

string

Optional date and time until which this rate is valid, exclusive.

string

Read-only resource type names generated from ResourceTypes.

integer[]

List of teams whose customers can use this rate; empty means no team restriction.

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,
  "TaxRateName": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "FinancialAccountName": 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 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,
  "TaxRateName": "<string>",
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "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

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200