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

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

A sign-up product (internally TariffSignupProduct) attaches a one-off deposit or sign-up fee to a plan (internally tariff). Creating a contract on that plan copies every sign-up product into a contract deposit (ContractDeposit), carrying over its price, refundable flag and online-checkout flag, and flags the contract to include the sign-up fee on its first eligible invoice. Sign-up product prices count towards the plan's total sign-up price but not towards its recurring total price. Changes here affect only contracts created afterwards; contracts that already exist keep the deposits they were created with. Recurring add-ons belong on plan components (TariffProduct) instead.

## 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 **`TariffSignupProduct-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="TariffSignupProduct_Tariff" type="integer">
  Filter by iD of the plan this sign-up fee belongs to; required, and it determines the owning location. Every contract created afterwards on that plan gets a matching deposit..
</ParamField>

<ParamField query="TariffSignupProduct_Tariff_Name" type="string">
  Filter by display value for Tariff.Name..
</ParamField>

<ParamField query="TariffSignupProduct_Product" type="integer">
  Filter by iD of the product charged as the sign-up fee or deposit; required, and its own current price is used whenever Price is left null, so reuse an existing product rather than creating a duplicate..
</ParamField>

<ParamField query="TariffSignupProduct_Product_Name" type="string">
  Filter by display value for Product.Name..
</ParamField>

<ParamField query="TariffSignupProduct_Product_Price" type="number">
  Filter by display value for Product.Price..
</ParamField>

<ParamField query="TariffSignupProduct_Product_Currency_Code" type="string">
  Filter by display value for Product.Currency.Code..
</ParamField>

<ParamField query="TariffSignupProduct_Price" type="number">
  Filter by optional amount charged for this sign-up fee, in the location's currency; when null the linked product's own current price is used instead..
</ParamField>

<ParamField query="TariffSignupProduct_Refundable" type="boolean">
  Filter by whether the deposit created from this sign-up fee is refunded when the contract ends, producing an unpaid credit note that can also be used to offset exit or damage fees..
</ParamField>

<ParamField query="TariffSignupProduct_InvoiceDuringOnlineCheckout" type="boolean">
  Filter by whether this fee is charged during the customer's online checkout instead of waiting for the contract's first eligible invoice..
</ParamField>

### Range Filters

<ParamField query="from_TariffSignupProduct_ProductPrice" type="number">
  Filter by display value for Product.Price. greater than or equal to this value.
</ParamField>

<ParamField query="to_TariffSignupProduct_ProductPrice" type="number">
  Filter by display value for Product.Price. less than or equal to this value.
</ParamField>

<ParamField query="from_TariffSignupProduct_Price" type="number">
  Filter by optional amount charged for this sign-up fee, in the location's currency; when null the linked product's own current price is used instead. greater than or equal to this value.
</ParamField>

<ParamField query="to_TariffSignupProduct_Price" type="number">
  Filter by optional amount charged for this sign-up fee, in the location's currency; when null the linked product's own current price is used instead. less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_TariffSignupProduct_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/tariffsignupproducts?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/tariffsignupproducts?' + 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/tariffsignupproducts',
      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/tariffsignupproducts?TariffSignupProduct_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/tariffsignupproducts?' + new URLSearchParams({
      TariffSignupProduct_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/tariffsignupproducts',
      params={
          'TariffSignupProduct_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/tariffsignupproducts?from_TariffSignupProduct_UpdatedOn=2025-01-01T00:00&to_TariffSignupProduct_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/tariffsignupproducts?' + new URLSearchParams({
      from_TariffSignupProduct_UpdatedOn: '2025-01-01T00:00',
      to_TariffSignupProduct_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/tariffsignupproducts',
      params={
          'from_TariffSignupProduct_UpdatedOn': '2025-01-01T00:00',
          'to_TariffSignupProduct_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="TariffSignupProduct[]">
  The list of TariffSignupProduct records matching the query. See the [Get one TariffSignupProduct](/rest-api/billing/get-tariffsignupproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<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": [
    {
      "TariffId": 0,
      "TariffName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": null,
      "ProductCurrencyCode": null,
      "Price": null,
      "Refundable": false,
      "InvoiceDuringOnlineCheckout": false,
      "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": "TariffSignupProduct 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
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.