Get one Product

Retrieve a single Product record by its Id.

GET /api/billing/products/{id}

Get one Product

cURL

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

200

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "SystemProductType": 123,
  "Description": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Sku": "<string>",
  "Tags": "<string>",
  "DisplayOrder": 123,
  "Price": 123,
  "Visible": true,
  "VisibleInKiosk": true,
  "AvailableToAi": true,
  "NotesForAi": "<string>",
  "ShowPriceForAi": true,
  "PriceForAi": 123,
  "SyncToSquare": true,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "AvailableAs": 123,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Archived": true,
  "Starred": true,
  "TrackStock": true,
  "AllowNegativeStock": true,
  "CurrentStock": 123,
  "StockAlertLevel": 123,
  "ApplyProRating": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "InvoiceCoworker": true,
  "SyncToNexKiosk": true,
  "CreateDeliveryWhenPurchased": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

id · integer · required

The Id of the Product record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/products/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId · integer

ID of the business linked to this record.

BusinessName · string

Business name.

Name · string

Product name.

SystemProductType · integer

Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other. See eProductType enum values: 0 = None, 1 = DayPass, 2 = CreditBundle, 3 = Stationery, 4 = BookingFeature, 5 = BookingProducts, 99 = Other.

Description · string

Product description.

InvoiceLineDisplayAs · string

Custom text shown on the invoice line instead of the product name.

Sku · string

SKU code.

Tags · string

Comma-separated tags for categorising and filtering.

DisplayOrder · integer

Display order.

Price · number

Product price.

Visible · boolean

Whether the product is visible to customers on the members portal and mobile app.

VisibleInKiosk · boolean

Whether the product is visible to customers in the NexKiosk app.

AvailableToAi · boolean

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

NotesForAi · string

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

ShowPriceForAi · boolean

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

PriceForAi · number

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

SyncToSquare · boolean

Sync to Square Point of Sale.

CurrencyId · integer

ID of the currency linked to this record.

CurrencyCode · string

Currency code.

TaxRateId · integer

ID of the tax rate linked to this record.

ReducedTaxRateId · integer

ID of the reduced tax rate linked to this record.

ExemptTaxRateId · integer

ID of the exempt tax rate linked to this record.

FinancialAccountId · integer

ID of the financial account linked to this record.

AvailableAs · integer

Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff). See eRecurrentProductOptions enum values: 0 = None, 1 = RecurrentOrOneOff, 2 = OnlyRecurrent, 3 = OnlyOneOff.

OnlyForContacts · boolean

Restrict purchase to contacts (customers without an active contract).

OnlyForMembers · boolean

Restrict purchase to customers with an active contract (members).

Tariffs · integer[]

List of tariffs linked to this record.

Archived · boolean

Whether the product is archived. Archived products cannot be sold but existing charges remain active.

Starred · boolean

Mark the product as featured or highlighted.

TrackStock · boolean

Enable stock tracking for this product. When enabled, each sale reduces the stock count.

AllowNegativeStock · boolean

Allow sales to continue even when stock reaches zero.

CurrentStock · integer

Current stock level.

StockAlertLevel · integer

Stock level at which a low-stock alert is triggered.

ApplyProRating · boolean

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

ImageFileName · string

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

NewImageUrl · string

URL of a new file to upload as the image.

ClearImageFile · boolean

Set to true to remove the current image file.

InvoiceCoworker · boolean

Whether to invoice the customer directly rather than their company or team.

SyncToNexKiosk · boolean

Sync to NexKiosk.

CreateDeliveryWhenPurchased · boolean

Automatically create a delivery record for the customer when this product is purchased.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "SystemProductType": 0,
  "Description": "",
  "InvoiceLineDisplayAs": null,
  "Sku": null,
  "Tags": null,
  "DisplayOrder": 0,
  "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,
  "AvailableAs": 0,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "Starred": false,
  "TrackStock": false,
  "AllowNegativeStock": false,
  "CurrentStock": null,
  "StockAlertLevel": null,
  "ApplyProRating": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "InvoiceCoworker": false,
  "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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Product Example",
  "LocalizationDetails": null,
  "CustomFields": null
}