Skip to main content
POST
/
api
/
billing
/
tarifftimepasses
Create TariffTimePass
curl --request POST \
  --url https://spaces.nexudus.com/api/billing/tarifftimepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TariffId": 123,
  "TimePassId": 123,
  "PassesIncluded": 123,
  "PassRenewalTime": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A TariffTimePass links a time pass to a pricing plan (tariff), defining an included allowance of time passes for customers on that plan. The renewal time controls how often the allowance resets.

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

Enums

ValueName
1Week
2CalendarMonth
3TariffMonth
4Year
5Day

Request Body

Required Fields

TariffId
integer
required
ID of the tariff linked to this record.
TimePassId
integer
required
ID of the time pass linked to this record.
PassesIncluded
integer
required
Number of passes included.
PassRenewalTime
integer
required
Pass renewal time period.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/tarifftimepasses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "TariffId": 0,
    "TimePassId": 0,
    "PassesIncluded": 0,
    "PassRenewalTime": 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 tarifftimepass was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "TariffTimePass 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": "PassRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PassRenewalTime"
    }
  ],
  "WasSuccessful": false
}