Skip to main content
POST
/
api
/
billing
/
producttimepasses
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
}
'
{
  "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. 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-Create role.

​
Enums

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

​
Request Body

​
Required Fields

​
ProductId
integer
required
ID of the product linked to this record.
​
TimePassId
integer
required
ID of the time pass linked to this record.
​
PassesIncluded
integer
required
Passes included.

​
Optional Fields

​
ExpireTimeInMonths
integer
The expire time in months value for this product time pass.
​
ExpireTimeInWeeks
integer
The expire time in weeks value for this product time pass.
​
ExpirationType
integer
Expiration type. See eRecurrentChargePattern? enum above.
​
ExpiresIn
integer
Expires in.

​
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
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the producttimepass was created successfully.
​
Errors
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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
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
}