Search Products

GET

api

billing

products

Search Products

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

import requests

url = "https://spaces.nexudus.com/api/billing/products"

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/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A Product represents an item that can be sold to customers. Products can be sold via contracts (ContractProduct entity), added to bookings (BookingProduct entity), or purchased directly (CoworkerProduct entity). Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using ContractProduct to associate the sale directly with a specific contract rather than relying on the customer’s MainContract. Use AvailableAs to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The SystemProductType field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other). Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.

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

Enums

eProductType — SystemProductType values

Value	Name
0	None
1	DayPass
2	CreditBundle
3	Stationery
4	BookingFeature
5	BookingProducts
99	Other

eRecurrentProductOptions — AvailableAs values

Value	Name
0	None
1	RecurrentOrOneOff
2	OnlyRecurrent
3	OnlyOneOff

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business linked to this record.

string

Filter by business name.

string

Filter by product name.

integer

Filter by category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.

string

Filter by product description.

string

Filter by custom text shown on the invoice line instead of the product name.

string

Filter by sKU code.

string

Filter by comma-separated tags for categorising and filtering.

integer

Filter by display order.

number

Filter by product price.

boolean

Filter by whether the product is visible to customers on the members portal and mobile app.

boolean

Filter by whether the product is visible to customers in the NexKiosk app.

boolean

Filter by whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.

string

Filter by additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.

boolean

Filter by whether to show the price of this product in AI channel recommendations and responses based on users’ budget preferences.

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used).

boolean

Filter by sync to Square Point of Sale.

integer

Filter by iD of the currency linked to this record.

string

Filter by currency code.

integer

Filter by iD of the tax rate linked to this record.

integer

Filter by iD of the reduced tax rate linked to this record.

integer

Filter by iD of the exempt tax rate linked to this record.

integer

Filter by iD of the financial account linked to this record.

integer

Filter by controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).

boolean

Filter by restrict purchase to contacts (customers without an active contract).

boolean

Filter by restrict purchase to customers with an active contract (members).

boolean

Filter by whether the product is archived. Archived products cannot be sold but existing charges remain active.

boolean

Filter by mark the product as featured or highlighted.

boolean

Filter by enable stock tracking for this product. When enabled, each sale reduces the stock count.

boolean

Filter by allow sales to continue even when stock reaches zero.

integer

Filter by current stock level.

integer

Filter by stock level at which a low-stock alert is triggered.

boolean

Filter by whether to pro-rate the price when the product is added or removed part-way through a billing period.

string

Filter by current file name of the image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the image.

boolean

Filter by set to true to remove the current image file.

boolean

Filter by whether to invoice the customer directly rather than their company or team.

boolean

Filter by sync to NexKiosk.

boolean

Filter by automatically create a delivery record for the customer when this product is purchased.

Range Filters

integer

Filter by display order greater than or equal to this value.

integer

Filter by display order less than or equal to this value.

number

Filter by product price greater than or equal to this value.

number

Filter by product price less than or equal to this value.

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used) greater than or equal to this value.

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used) less than or equal to this value.

integer

Filter by current stock level greater than or equal to this value.

integer

Filter by current stock level less than or equal to this value.

integer

Filter by stock level at which a low-stock alert is triggered greater than or equal to this value.

integer

Filter by stock level at which a low-stock alert is triggered less than or equal to this value.

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Name

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/products?' + new URLSearchParams({
    from_Product_UpdatedOn: '2025-01-01T00:00',
    to_Product_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

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

data = response.json()

Response

200

Product[]

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

Partial records — The listing endpoint returns a summary representation of each Product. The following fields are not populated in the Records[] response: DisplayOrder, AvailableAs, OnlyForContacts, OnlyForMembers, InvoiceCoworker.To get all fields, fetch the full record using the Get one Product 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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "SystemProductType": 0,
      "Description": "",
      "InvoiceLineDisplayAs": null,
      "Sku": null,
      "Tags": null,
      "Price": 0,
      "Visible": false,
      "VisibleInKiosk": false,
      "AvailableToAi": false,
      "NotesForAi": null,
      "ShowPriceForAi": false,
      "PriceForAi": null,
      "SyncToSquare": false,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "Tariffs": [],
      "Archived": false,
      "Starred": false,
      "TrackStock": false,
      "AllowNegativeStock": false,
      "CurrentStock": null,
      "StockAlertLevel": null,
      "ApplyProRating": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "SyncToNexKiosk": false,
      "CreateDeliveryWhenPurchased": 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": "Product 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
}

Get one ProductRetrieve a single Product record by its Id.

Search Products

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

import requests

url = "https://spaces.nexudus.com/api/billing/products"

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/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200