Create TariffExtraService

POST

api

billing

tariffextraservices

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

import requests

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

payload = {
    "TariffId": 123,
    "ExtraServiceId": 123,
    "UsesIncluded": 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({TariffId: 123, ExtraServiceId: 123, UsesIncluded: 123, ServiceRenewalTime: 123})
};

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

Plan time credit (internally TariffExtraService) links an time credit type (internally ExtraService) to a plan (internally Tariff), defining an included allowance of booking time or printing credits for customers on that plan. The UsesIncluded value specifies how much is included. The renewal time controls how often the credit expires and 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 TariffExtraService-Create role.

Enums

eTimeSpanWeekMonth — ServiceRenewalTime values

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

Request Body

Required Fields

integer

required

ID of the plan linked to this record.

integer

required

ID of the time credit type linked to this record. An ExtraService with IsBookingCredit = true associated with the type of resources this time credit is valid for. .

integer

required

Number of uses included in the unit associated with the selected time credit type (ExtraService.ChargePeriod). ExtraServiceChargePeriod in this entity. Minutes = 1, Days = 2, Weeks = 3, Months = 4, Uses = 5, FourWeekMonths = 6.

integer

required

How often will this credit amount will expire and be issued again. Most common option is TariffMonth, which follows the plan renewal cycle..

Code Examples

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

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

const data = await response.json();

import requests

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

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "TariffExtraService 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": "ServiceRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ServiceRenewalTime"
    }
  ],
  "WasSuccessful": false
}

Create TariffExtraService

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

import requests

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

payload = {
    "TariffId": 123,
    "ExtraServiceId": 123,
    "UsesIncluded": 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({TariffId: 123, ExtraServiceId: 123, UsesIncluded: 123, ServiceRenewalTime: 123})
};

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

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400