Skip to main content
GET
/
api
/
billing
/
timepasses
/
{id}
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Price": 123,
  "MinutesIncluded": 123,
  "CountsTowardsPlanLimits": true,
  "UseAsPayAsYouGoForMembers": true,
  "UseAsPayAsYouGoForContacts": true,
  "UsePriority": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "Businesses": [
    123
  ],
  "KisiGroupId": "<string>",
  "DoorGuardGroupId": "<string>",
  "AccessControlGroupId": "<string>",
  "AccessControlGroupIds": "<string>",
  "AllowNetworkCheckIn": true,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Archived": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
Passes allow customers to check in to a coworking space. There are two kinds:
  • Day Pass — valid for a single calendar day. Created with MinutesIncluded omitted (null). The customer can check in any number of times during that day.
  • Time Pass — valid across multiple days up to a fixed amount of time. Created with “MinutesIncluded <minutes> set. The customer can check in until the included minutes are exhausted.

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

​
Path Parameters

​
id
integer
required
The Id of the TimePass record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
Business Id.
​
BusinessName
string
Business name.
​
Name
string
Time pass name.
​
InvoiceLineDisplayAs
string
Invoice line display text.
​
Price
number
Price.
​
MinutesIncluded
integer
Minutes included.
​
CountsTowardsPlanLimits
boolean
Counts towards plan limits.
​
UseAsPayAsYouGoForMembers
boolean
Use as pay-as-you-go for members.
​
UseAsPayAsYouGoForContacts
boolean
Use as pay-as-you-go for contacts.
​
UsePriority
integer
Use priority.
​
CurrencyId
integer
Currency Id.
​
CurrencyCode
string
Currency code.
​
TaxRateId
integer
Tax Rate Id.
​
ReducedTaxRateId
integer
Reduced Tax Rate Id.
​
ExemptTaxRateId
integer
Exempt Tax Rate Id.
​
FinancialAccountId
integer
Financial Account Id.
​
Businesses
integer[]
Businesses.
​
KisiGroupId
string
Kisi group ID.
​
DoorGuardGroupId
string
DoorGuard group ID.
​
AccessControlGroupId
string
Access Control Group Id.
​
AccessControlGroupIds
string
Access Control Group Ids.
​
AllowNetworkCheckIn
boolean
Allow network check-in.
​
OnlyForContacts
boolean
Only available for contacts.
​
OnlyForMembers
boolean
Only available for members.
​
Tariffs
integer[]
Tariffs.
​
Archived
boolean
Archived.
​
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": "",
  "InvoiceLineDisplayAs": null,
  "Price": 0,
  "MinutesIncluded": null,
  "CountsTowardsPlanLimits": false,
  "UseAsPayAsYouGoForMembers": false,
  "UseAsPayAsYouGoForContacts": false,
  "UsePriority": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "Businesses": [],
  "KisiGroupId": null,
  "DoorGuardGroupId": null,
  "AccessControlGroupId": null,
  "AccessControlGroupIds": null,
  "AllowNetworkCheckIn": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "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": "TimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}