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

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

A **ProductExtraService** links an `ExtraService` to a `Product`. The meaning of `UsesIncluded` depends on the type of the linked extra service:

* **Booking time** (ExtraService with `IsPrintingCredit = false`) — customers receive an allowance of booking time for the resource type(s) associated with that extra service. For example, a product called "Hot Desk Bundle" might include 2 hours of meeting room usage — achieved by linking a "Meeting Room Hourly" extra service with \`\`UsesIncluded` 120`.
* **Printing credit** (ExtraService with `IsPrintingCredit = true`) — customers receive a number of print jobs/pages. `UsesIncluded` is the number of printing credits included. The linked extra service must have `ChargePeriod = 5` (Uses) and `Price = 1`.

Always check `IsPrintingCredit` on the linked extra service before interpreting `UsesIncluded`.

For booking-time extra services, the unit of `UsesIncluded` is determined by the **ChargePeriod** of the linked `ExtraService`:

| ExtraService ChargePeriod | UsesIncluded unit |
| ------------------------- | ----------------- |
| 1 (Minutes)               | Minutes           |
| 2 (Days)                  | Days              |
| 3 (Weeks)                 | Weeks             |
| 4 (Months)                | Months            |
| 5 (Uses)                  | Individual uses   |
| 6 (FourWeekMonths)        | 4-week periods    |

So \`\`UsesIncluded` 60` on a minutes extra service means 60 minutes of booking time included. On a daily extra service it means 60 full days.

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

## 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="ProductExtraService_Product" type="integer">
  Filter by Product Id.
</ParamField>

<ParamField query="ProductExtraService_Product_Name" type="string">
  Filter by product name.
</ParamField>

<ParamField query="ProductExtraService_ExtraService" type="integer">
  Filter by Extra Service Id.
</ParamField>

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

<ParamField query="ProductExtraService_ExtraService_ChargePeriod" type="string">
  Filter by charge period of the linked extra service.
</ParamField>

<ParamField query="ProductExtraService_ExtraService_IsBookingCredit" type="boolean">
  Filter by benefit is booking credit.
</ParamField>

<ParamField query="ProductExtraService_ExtraService_IsPrintingCredit" type="boolean">
  Filter by benefit is printing credit.
</ParamField>

<ParamField query="ProductExtraService_UsesIncluded" type="integer">
  Filter by uses included.
</ParamField>

<ParamField query="ProductExtraService_ExpireTimeInMonths" type="integer">
  Filter by Expire Time In Months.
</ParamField>

<ParamField query="ProductExtraService_ExpireTimeInWeeks" type="integer">
  Filter by Expire Time In Weeks.
</ParamField>

<ParamField query="ProductExtraService_ExpirationType" type="integer">
  Filter by expiration type.
</ParamField>

<ParamField query="ProductExtraService_ExpiresIn" type="integer">
  Filter by expires in.
</ParamField>

### Range Filters

<ParamField query="from_ProductExtraService_UsesIncluded" type="integer">
  Filter by uses included greater than or equal to this value.
</ParamField>

<ParamField query="to_ProductExtraService_UsesIncluded" type="integer">
  Filter by uses included less than or equal to this value.
</ParamField>

<ParamField query="from_ProductExtraService_ExpireTimeInMonths" type="integer">
  Filter by expire time in months greater than or equal to this value.
</ParamField>

<ParamField query="to_ProductExtraService_ExpireTimeInMonths" type="integer">
  Filter by expire time in months less than or equal to this value.
</ParamField>

<ParamField query="from_ProductExtraService_ExpireTimeInWeeks" type="integer">
  Filter by expire time in weeks greater than or equal to this value.
</ParamField>

<ParamField query="to_ProductExtraService_ExpireTimeInWeeks" type="integer">
  Filter by expire time in weeks less than or equal to this value.
</ParamField>

<ParamField query="from_ProductExtraService_ExpiresIn" type="integer">
  Filter by expires in greater than or equal to this value.
</ParamField>

<ParamField query="to_ProductExtraService_ExpiresIn" type="integer">
  Filter by expires in less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_ProductExtraService_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/productextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      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/productextraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by CreatedOn

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices?' + new URLSearchParams({
      ProductExtraService_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      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/productextraservices',
      params={
          'ProductExtraService_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          '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/productextraservices?from_ProductExtraService_UpdatedOn=2025-01-01T00:00&to_ProductExtraService_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/productextraservices?' + new URLSearchParams({
      from_ProductExtraService_UpdatedOn: '2025-01-01T00:00',
      to_ProductExtraService_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/productextraservices',
      params={
          'from_ProductExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_ProductExtraService_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="ProductExtraService[]">
  The list of ProductExtraService records matching the query. See the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-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 ProductExtraService. The following fields are **not populated** in the `Records[]` response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-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": [
    {
      "ProductId": 0,
      "ProductName": null,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceChargePeriod": null,
      "ExtraServiceIsBookingCredit": false,
      "ExtraServiceIsPrintingCredit": false,
      "UsesIncluded": 0,
      "ExpirationType": 0,
      "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": "ProductExtraService 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
}
```