Search ExtraServicePrices

Search and list ExtraServicePrice records with filtering, sorting, and pagination.

GET /api/billing/extraserviceprices

Search ExtraServicePrices

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

An ExtraServicePrice provides an overriding price for an ExtraService (resource price) for members on a specific Tariff (plan).

When a member whose active plan matches TariffId books a resource priced by the linked extra service, the Price (and optional MaximumPrice) from this record are used instead of the default extra service price.

In most cases it is preferred to create additional ExtraService records connected to the same ResourceTypes and restricted to specific plans via ExtraService.Tariffs, rather than using ExtraServicePrice overrides. Use ExtraServicePrice only when you need a simple price override without duplicating the full extra service configuration.

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 ExtraServicePrice-List role.

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ExtraServicePrice_ExtraService · integer

Filter by iD of the extra service linked to this record.

ExtraServicePrice_ExtraService_Name · string

Filter by name of the linked extra service.

ExtraServicePrice_Tariff · integer

Filter by iD of the tariff linked to this record.

ExtraServicePrice_Tariff_Name · string

Filter by name of the linked tariff.

ExtraServicePrice_Price · number

Filter by overriding price charged to members on the specified tariff.

ExtraServicePrice_MaximumPrice · number

Filter by optional maximum price cap for time-based extra services on the specified tariff.

Range Filters

from_ExtraServicePrice_Price · number

Filter by overriding price charged to members on the specified tariff greater than or equal to this value.

to_ExtraServicePrice_Price · number

Filter by overriding price charged to members on the specified tariff less than or equal to this value.

from_ExtraServicePrice_MaximumPrice · number

Filter by optional maximum price cap for time-based extra services on the specified tariff greater than or equal to this value.

to_ExtraServicePrice_MaximumPrice · number

Filter by optional maximum price cap for time-based extra services on the specified tariff less than or equal to this value.

from_ExtraServicePrice_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ExtraServicePrice_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_ExtraServicePrice_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ExtraServicePrice_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/extraserviceprices?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/extraserviceprices?ExtraServicePrice_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/extraserviceprices?from_ExtraServicePrice_UpdatedOn=2025-01-01T00:00&to_ExtraServicePrice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · ExtraServicePrice[]

The list of ExtraServicePrice records matching the query. See the Get one ExtraServicePrice endpoint for the full list of properties returned for each record.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "TariffId": 0,
      "TariffName": null,
      "Price": 0,
      "MaximumPrice": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ExtraServicePrice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}