Create TariffBookingCredit

POST

api

billing

tariffbookingcredits

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/tariffbookingcredits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "TariffId": 123,
  "Credit": 123,
  "ServiceRenewalTime": 123
}
'

import requests

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

payload = {
    "Name": "<string>",
    "TariffId": 123,
    "Credit": 123,
    "ServiceRenewalTime": 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({Name: '<string>', TariffId: 123, Credit: 123, ServiceRenewalTime: 123})
};

fetch('https://spaces.nexudus.com/api/billing/tariffbookingcredits', 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 TariffBookingCredit represents an amount of credit linked to a plan (Tariff). When a customer’s contract on that plan renews, the credit is automatically released as a CoworkerBookingCredit on the customer’s account. Credit can be configured for two primary uses:

Bookings — set CaneBeUsedForBookings to allow the credit to pay for bookings. Use ElegibleResourceTypes to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
Events — set CaneBeUsedForEvents to allow the credit to pay for event sign-ups. Use EventCategories to restrict to specific event categories; if left empty the credit is valid for all events.

Setting IsUniversalCredit enables the credit for products, time passes, and other charges. Use ElegibleProducts, ElegiblePasses, and AppliesToCharges to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges. Use ServiceRenewalTime to control how often the credit is renewed (e.g. weekly, monthly).

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

Enums

eTimeSpanWeekMonth — ServiceRenewalTime values

Value	Name
1	Week
2	CalendarMonth
3	TariffMonth
4	Year
5	Day

Request Body

Required Fields

string

required

Credit name.

integer

required

ID of the tariff linked to this record.

number

required

Credit amount.

integer

required

Service renewal time period.

Optional Fields

integer[]

List of elegible resource types linked to this record.

integer[]

List of elegible products linked to this record.

integer[]

List of elegible tariffs linked to this record.

boolean

Whether this credit can be used to pay for bookings. Restrict to specific resource types with ElegibleResourceTypes.

boolean

Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with EventCategories.

integer[]

List of event categories linked to this record.

boolean

Whether this is a universal credit applicable to products, time passes and other charges. Restrict with ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.

integer[]

List of elegible passes linked to this record.

boolean

Whether this universal credit applies to other charges.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/tariffbookingcredits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "",
    "TariffId": 0,
    "Credit": 0,
    "ServiceRenewalTime": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'Name': '',
        'TariffId': 0,
        'Credit': 0,
        'ServiceRenewalTime': 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 tariffbookingcredit was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "TariffBookingCredit 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
}

Update TariffBookingCreditUpdate an existing TariffBookingCredit record.

Create TariffBookingCredit

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/tariffbookingcredits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "TariffId": 123,
  "Credit": 123,
  "ServiceRenewalTime": 123
}
'

import requests

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

payload = {
    "Name": "<string>",
    "TariffId": 123,
    "Credit": 123,
    "ServiceRenewalTime": 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({Name: '<string>', TariffId: 123, Credit: 123, ServiceRenewalTime: 123})
};

fetch('https://spaces.nexudus.com/api/billing/tariffbookingcredits', 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