Skip to main content
GET
/
api
/
billing
/
producttimepasses
/
{id}
{
  "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

​
id
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"

​
Response

​
200

​
ProductId
integer
Product Id.
​
ProductName
string
Product name.
​
TimePassId
integer
Time Pass Id.
​
TimePassName
string
Time pass name.
​
PassesIncluded
integer
Passes included.
​
ExpireTimeInMonths
integer
Expire Time In Months.
​
ExpireTimeInWeeks
integer
Expire Time In Weeks.
​
ExpirationType
integer
Expiration type.
​
ExpiresIn
integer
Expires in.
​
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
{
  "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
}