Search ProductTimePasses - Nexudus Platform

GET

api

billing

producttimepasses

Search ProductTimePasses

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

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

A ProductTimePass links a TimePass to a Product so that customers purchasing the product automatically receive an amount of check-in time. The nature of that time depends on the type of the linked TimePass:

Day Pass (TimePass with MinutesIncluded = null) — PassesIncluded is the number of calendar days. The customer can check in any number of times during each calendar day they hold.
Time Pass (TimePass with MinutesIncluded set) — PassesIncluded is the number of pass instances (each worth MinutesIncluded minutes). Multiply PassesIncluded by MinutesIncluded to get total hours. For example, PassesIncluded = 10 with a 60-minute time pass gives the customer 10 hours of check-in time to use across different dates.

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

Enums

eRecurrentChargePattern

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ProductTimePass_Product

integer

Filter by iD of the product linked to this record.

ProductTimePass_Product_Name

string

Filter by product name.

ProductTimePass_TimePass

integer

Filter by iD of the time pass linked to this record.

ProductTimePass_TimePass_Name

string

Filter by time pass name.

ProductTimePass_PassesIncluded

integer

Filter by passes included.

ProductTimePass_ExpireTimeInMonths

integer

Filter by the expire time in months value for this product time pass.

ProductTimePass_ExpireTimeInWeeks

integer

Filter by the expire time in weeks value for this product time pass.

ProductTimePass_ExpirationType

integer

Filter by expiration type.

ProductTimePass_ExpiresIn

integer

Filter by expires in.

Range Filters

from_ProductTimePass_PassesIncluded

integer

Filter by passes included greater than or equal to this value.

to_ProductTimePass_PassesIncluded

integer

Filter by passes included less than or equal to this value.

from_ProductTimePass_ExpireTimeInMonths

integer

Filter by the expire time in months value for this product time pass greater than or equal to this value.

to_ProductTimePass_ExpireTimeInMonths

integer

Filter by the expire time in months value for this product time pass less than or equal to this value.

from_ProductTimePass_ExpireTimeInWeeks

integer

Filter by the expire time in weeks value for this product time pass greater than or equal to this value.

to_ProductTimePass_ExpireTimeInWeeks

integer

Filter by the expire time in weeks value for this product time pass less than or equal to this value.

from_ProductTimePass_ExpiresIn

integer

Filter by expires in greater than or equal to this value.

to_ProductTimePass_ExpiresIn

integer

Filter by expires in less than or equal to this value.

from_ProductTimePass_CreatedOn

string

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

to_ProductTimePass_CreatedOn

string

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

from_ProductTimePass_UpdatedOn

string

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

to_ProductTimePass_UpdatedOn

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

Filtering by CreatedOn

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

Range filters

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

Response

200

Records

ProductTimePass[]

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

Partial records — The listing endpoint returns a summary representation of each ProductTimePass. 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 ProductTimePass 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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "ProductId": 0,
      "ProductName": null,
      "TimePassId": 0,
      "TimePassName": null,
      "PassesIncluded": 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": "ProductTimePass 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
}

Get one ProductTimePassRetrieve a single ProductTimePass record by its Id.

Search ProductTimePasses

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

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

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200