> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search ExtraServices

> Search and list ExtraService records with filtering, sorting, and pagination.

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

<Note>
  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-List`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eLastMinuteDiscountType — LastMinuteAdjustmentType values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Disabled |
  | 2     | Fixed    |
  | 3     | Gradual  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="ExtraService_Business" type="integer">
  Filter by Business Id.
</ParamField>

<ParamField query="ExtraService_Name" type="string">
  Filter by extra service name.
</ParamField>

<ParamField query="ExtraService_Description" type="string">
  Filter by description.
</ParamField>

<ParamField query="ExtraService_InvoiceLineDisplayAs" type="string">
  Filter by invoice line display text.
</ParamField>

<ParamField query="ExtraService_Visible" type="boolean">
  Filter by whether the price is visible on the portal and app.
</ParamField>

<ParamField query="ExtraService_DisplayOrder" type="integer">
  Filter by display order.
</ParamField>

<ParamField query="ExtraService_Price" type="number">
  Filter by price.
</ParamField>

<ParamField query="ExtraService_CreditPrice" type="number">
  Filter by credit price.
</ParamField>

<ParamField query="ExtraService_ChargePeriod" type="integer">
  Filter by charge period.
</ParamField>

<ParamField query="ExtraService_MaximumPrice" type="number">
  Filter by maximum price cap.
</ParamField>

<ParamField query="ExtraService_IsDefaultPrice" type="boolean">
  Filter by use as the default price for matched resource types if more than one price applies.
</ParamField>

<ParamField query="ExtraService_UsePerNightPricing" type="boolean">
  Filter by use per-night pricing.
</ParamField>

<ParamField query="ExtraService_Currency" type="integer">
  Filter by Currency Id.
</ParamField>

<ParamField query="ExtraService_Currency_Code" type="string">
  Filter by currency code.
</ParamField>

<ParamField query="ExtraService_TaxRate" type="integer">
  Filter by Tax Rate Id.
</ParamField>

<ParamField query="ExtraService_ReducedTaxRate" type="integer">
  Filter by Reduced Tax Rate Id.
</ParamField>

<ParamField query="ExtraService_ExemptTaxRate" type="integer">
  Filter by Exempt Tax Rate Id.
</ParamField>

<ParamField query="ExtraService_FinancialAccount" type="integer">
  Filter by Financial Account Id.
</ParamField>

<ParamField query="ExtraService_FromTime" type="integer">
  Filter by start time restriction (minutes from midnight).
</ParamField>

<ParamField query="ExtraService_ToTime" type="integer">
  Filter by end time restriction (minutes from midnight).
</ParamField>

<ParamField query="ExtraService_MinLength" type="integer">
  Filter by minimum booking length (minutes).
</ParamField>

<ParamField query="ExtraService_MaxLength" type="integer">
  Filter by maximum booking length (minutes).
</ParamField>

<ParamField query="ExtraService_OnlyWithinAvailableTimes" type="boolean">
  Filter by only apply within the resource's available times.
</ParamField>

<ParamField query="ExtraService_FixedCostLength" type="integer">
  Filter by fixed cost booking length threshold (minutes).
</ParamField>

<ParamField query="ExtraService_FixedCostPrice" type="number">
  Filter by fixed cost price applied once the threshold is reached.
</ParamField>

<ParamField query="ExtraService_OnlyForContacts" type="boolean">
  Filter by only available for contacts.
</ParamField>

<ParamField query="ExtraService_OnlyForMembers" type="boolean">
  Filter by only available for members.
</ParamField>

<ParamField query="ExtraService_IsBookingCredit" type="boolean">
  Filter by price uses booking credits.
</ParamField>

<ParamField query="ExtraService_IsPrintingCredit" type="boolean">
  Filter by price uses printing credits.
</ParamField>

<ParamField query="ExtraService_ApplyChargeToVisitors" type="boolean">
  Filter by apply charge to visitors.
</ParamField>

<ParamField query="ExtraService_PriceFactorLowDemand" type="number">
  Filter by price factor for low demand periods.
</ParamField>

<ParamField query="ExtraService_PriceFactorAverageDemand" type="number">
  Filter by price factor for average demand periods.
</ParamField>

<ParamField query="ExtraService_PriceFactorHighDemand" type="number">
  Filter by price factor for high demand periods.
</ParamField>

<ParamField query="ExtraService_PriceFactorLastMinute" type="number">
  Filter by price factor for last-minute bookings.
</ParamField>

<ParamField query="ExtraService_LastMinutePeriodMinutes" type="integer">
  Filter by last-minute period threshold (minutes before booking).
</ParamField>

<ParamField query="ExtraService_LastMinuteAdjustmentType" type="integer">
  Filter by last-minute discount type.
</ParamField>

<ParamField query="ExtraService_ApplyFrom" type="string">
  Filter by date from which this price applies.
</ParamField>

<ParamField query="ExtraService_ApplyTo" type="string">
  Filter by date until which this price applies.
</ParamField>

<ParamField query="ExtraService_ResourceTypeNames" type="string">
  Filter by comma-separated names of associated resource types.
</ParamField>

### Range Filters

<ParamField query="from_ExtraService_DisplayOrder" type="integer">
  Filter by display order greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_DisplayOrder" type="integer">
  Filter by display order less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_Price" type="number">
  Filter by price greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_Price" type="number">
  Filter by price less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_CreditPrice" type="number">
  Filter by credit price greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_CreditPrice" type="number">
  Filter by credit price less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_MaximumPrice" type="number">
  Filter by maximum price cap greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_MaximumPrice" type="number">
  Filter by maximum price cap less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_FromTime" type="integer">
  Filter by start time restriction (minutes from midnight) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_FromTime" type="integer">
  Filter by start time restriction (minutes from midnight) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_ToTime" type="integer">
  Filter by end time restriction (minutes from midnight) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_ToTime" type="integer">
  Filter by end time restriction (minutes from midnight) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_MinLength" type="integer">
  Filter by minimum booking length (minutes) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_MinLength" type="integer">
  Filter by minimum booking length (minutes) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_MaxLength" type="integer">
  Filter by maximum booking length (minutes) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_MaxLength" type="integer">
  Filter by maximum booking length (minutes) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_FixedCostLength" type="integer">
  Filter by fixed cost booking length threshold (minutes) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_FixedCostLength" type="integer">
  Filter by fixed cost booking length threshold (minutes) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_FixedCostPrice" type="number">
  Filter by fixed cost price applied once the threshold is reached greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_FixedCostPrice" type="number">
  Filter by fixed cost price applied once the threshold is reached less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_PriceFactorLowDemand" type="number">
  Filter by price factor for low demand periods greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_PriceFactorLowDemand" type="number">
  Filter by price factor for low demand periods less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_PriceFactorAverageDemand" type="number">
  Filter by price factor for average demand periods greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_PriceFactorAverageDemand" type="number">
  Filter by price factor for average demand periods less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_PriceFactorHighDemand" type="number">
  Filter by price factor for high demand periods greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_PriceFactorHighDemand" type="number">
  Filter by price factor for high demand periods less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_PriceFactorLastMinute" type="number">
  Filter by price factor for last-minute bookings greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_PriceFactorLastMinute" type="number">
  Filter by price factor for last-minute bookings less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_LastMinutePeriodMinutes" type="integer">
  Filter by last-minute period threshold (minutes before booking) greater than or equal to this value.
</ParamField>

<ParamField query="to_ExtraService_LastMinutePeriodMinutes" type="integer">
  Filter by last-minute period threshold (minutes before booking) less than or equal to this value.
</ParamField>

<ParamField query="from_ExtraService_ApplyFrom" type="string">
  Filter by date from which this price applies greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ExtraService_ApplyFrom" type="string">
  Filter by date from which this price applies less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ExtraService_ApplyTo" type="string">
  Filter by date until which this price applies greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ExtraService_ApplyTo" type="string">
  Filter by date until which this price applies less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ExtraService_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ExtraService_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ExtraService_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ExtraService_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?ExtraService_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      ExtraService_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'ExtraService_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?from_ExtraService_UpdatedOn=2025-01-01T00:00&to_ExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      from_ExtraService_UpdatedOn: '2025-01-01T00:00',
      to_ExtraService_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'from_ExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_ExtraService_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ExtraService[]">
  The list of ExtraService records matching the query. See the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ExtraService. The following fields are **not populated** in the `Records[]` response: `Description`, `Visible`, `DisplayOrder`, `CreditPrice`, `FromTime`, `ToTime`, `MinLength`, `MaxLength`, `OnlyWithinAvailableTimes`, `FixedCostLength`, `FixedCostPrice`, `IsBookingCredit`, `IsPrintingCredit`, `ApplyChargeToVisitors`.

  To get all fields, fetch the full record using the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "InvoiceLineDisplayAs": null,
      "ResourceTypes": [],
      "Price": 0,
      "ChargePeriod": 0,
      "MaximumPrice": null,
      "IsDefaultPrice": false,
      "UsePerNightPricing": false,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "Tariffs": [],
      "OnlyForContacts": false,
      "OnlyForMembers": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```