Get one TariffExtraService

GET

api

billing

tariffextraservices

{id}

Get one TariffExtraService

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/tariffextraservices/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceChargePeriod": "<string>",
  "ExtraServiceIsBookingCredit": "<string>",
  "ExtraServiceIsPrintingCredit": "<string>",
  "UsesIncluded": 123,
  "ServiceRenewalTime": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A TariffExtraService links an extra service (booking rate) to a pricing plan (tariff), defining an included allowance of booking time or printing credits for customers on that plan. The UsesIncluded value specifies how much is included.

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

Path Parameters

integer

required

The Id of the TariffExtraService record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tariffextraservices/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/tariffextraservices/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/tariffextraservices/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the tariff linked to this record.

string

Tariff name.

integer

ID of the extra service linked to this record.

string

Extra service name.

string

Extra service charge period.

string

Whether extra service is booking credit.

string

Whether extra service is printing credit.

integer

Number of uses included.

integer

Service renewal time period. See eTimeSpanWeekMonth enum values: 1 = Week, 2 = CalendarMonth, 3 = TariffMonth, 4 = Year, 5 = Day.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "TariffId": 0,
  "TariffName": null,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceChargePeriod": null,
  "ExtraServiceIsBookingCredit": null,
  "ExtraServiceIsPrintingCredit": null,
  "UsesIncluded": 0,
  "ServiceRenewalTime": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "TariffExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple TariffExtraServicesRetrieve multiple TariffExtraService records by their Ids in a single request.

Get one TariffExtraService

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/tariffextraservices/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceChargePeriod": "<string>",
  "ExtraServiceIsBookingCredit": "<string>",
  "ExtraServiceIsPrintingCredit": "<string>",
  "UsesIncluded": 123,
  "ServiceRenewalTime": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200