Create ProductTimePass

POST

api

billing

producttimepasses

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/producttimepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ProductId": 123,
  "TimePassId": 123,
  "PassesIncluded": 123
}
'

import requests

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

payload = {
    "ProductId": 123,
    "TimePassId": 123,
    "PassesIncluded": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ProductId: 123, TimePassId: 123, PassesIncluded: 123})
};

fetch('https://spaces.nexudus.com/api/billing/producttimepasses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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

Enums

eRecurrentChargePattern

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

Request Body

Required Fields

integer

required

ID of the product linked to this time pass record.

integer

required

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.

integer

required

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.

Optional Fields

integer

Expiration period in months (legacy field, use ExpiresIn with ExpirationType instead).

integer

Expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead).

integer

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. See eRecurrentChargePattern? enum above.

integer

Number of periods (of ExpirationType) until the released time pass expires.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/producttimepasses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ProductId": 0,
    "TimePassId": 0,
    "PassesIncluded": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/producttimepasses',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      ProductId: 0,
      TimePassId: 0,
      PassesIncluded: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/producttimepasses',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'ProductId': 0,
        'TimePassId': 0,
        'PassesIncluded': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the producttimepass was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProductTimePass was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create ProductTimePass

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/producttimepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ProductId": 123,
  "TimePassId": 123,
  "PassesIncluded": 123
}
'

import requests

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

payload = {
    "ProductId": 123,
    "TimePassId": 123,
    "PassesIncluded": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ProductId: 123, TimePassId: 123, PassesIncluded: 123})
};

fetch('https://spaces.nexudus.com/api/billing/producttimepasses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400