Search ProductTimePasses

GET

api

billing

producttimepasses

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

import requests

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

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/producttimepasses', 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 ProductTimePass links a TimePass to a Product so that customers purchasing the product automatically receive an amount of check-in time. How time is calculated:

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.

When is the time pass released?

Admin sale (via CoworkerProduct): An admin can choose to release the time pass before payment by setting ActivateNow = true when selling the product.
Member purchase (online, active contract): Time passes are released immediately unless the Store.AlwaysInvoice business setting is enabled, in which case they release after payment.
Contact purchase (online, no active contract): Time passes are released after the product is paid.

Use ExpirationType and ExpiresIn to control when the released time pass expires.

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

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 product linked to this time pass record.

string

Filter by display value for Product.Name..

integer

Filter by iD of the time pass linked to this record. The type of time pass determines how time is calculated: Day Pass (MinutesIncluded = null) gives calendar days of check-in access; Time Pass (MinutesIncluded set) gives instances worth MinutesIncluded minutes each.

string

Filter by display value for TimePass.Name..

integer

Filter by number of passes included: for Day Passes this is the number of calendar days the customer can check in; for Time Passes this is the number of pass instances (each worth the TimePass’s MinutesIncluded minutes). Total time = PassesIncluded × MinutesIncluded for time passes.

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead).

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead).

integer

Filter by expiration type for the released time pass: PricePlan (expires at end of billing period of the main contract - customer must have a main contract), Day, Week, Month, Year, or LastDayOfMonth.

integer

Filter by number of periods (of ExpirationType) until the released time pass expires.

Range Filters

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead) greater than or equal to this value.

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead) less than or equal to this value.

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead) greater than or equal to this value.

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead) less than or equal to this value.

integer

Filter by number of periods (of ExpirationType) until the released time pass expires greater than or equal to this value.

integer

Filter by number of periods (of ExpirationType) until the released time pass expires 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/producttimepasses?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

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"

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

const data = await response.json();

import requests

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

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/producttimepasses?' + new URLSearchParams({
    from_ProductTimePass_UpdatedOn: '2025-01-01T00:00',
    to_ProductTimePass_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/producttimepasses',
    params={
        'from_ProductTimePass_UpdatedOn': '2025-01-01T00:00',
        'to_ProductTimePass_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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

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

Search ProductTimePasses

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

import requests

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

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/producttimepasses', 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 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

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200