Get one ProductTimePass

GET

api

billing

producttimepasses

{id}

Get one ProductTimePass

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

import requests

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

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

{
  "ProductId": 123,
  "ProductName": "<string>",
  "TimePassId": 123,
  "TimePassName": "<string>",
  "PassesIncluded": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

integer

required

The Id of the ProductTimePass record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/producttimepasses/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/producttimepasses/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the product linked to this record.

string

Product name.

integer

ID of the time pass linked to this record.

string

Time pass name.

integer

Passes included.

integer

The expire time in months value for this product time pass.

integer

The expire time in weeks value for this product time pass.

integer

Expiration type.

integer

Expires in.

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get multiple ProductTimePassesRetrieve multiple ProductTimePass records by their Ids in a single request.

Get one ProductTimePass

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

import requests

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

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

{
  "ProductId": 123,
  "ProductName": "<string>",
  "TimePassId": 123,
  "TimePassName": "<string>",
  "PassesIncluded": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200