Get one TariffProduct

GET

api

billing

tariffproducts

{id}

Get one TariffProduct

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

import requests

url = "https://spaces.nexudus.com/api/billing/tariffproducts/{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/tariffproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffTransferProductsToContract": true,
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductBusinessCurrencyCode": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A plan component (internally TariffProduct) adds one product to a plan (internally tariff) so that the product is charged on every invoice raised for contracts on that plan, and its price is added to the plan’s total price. Use it for recurring add-ons such as mail handling, lockers or parking; one-off sign-up charges use sign-up products (TariffSignupProduct) instead.

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

Path Parameters

integer

required

The Id of the TariffProduct record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the plan this component belongs to; required, and every contract on that plan is then charged for the component’s product..

string

Display value for Tariff.Name..

boolean

Display value for Tariff.TransferProductsToContract..

integer

ID of the product charged as the plan component; required, and the product’s own current price is what gets invoiced, so reuse an existing product instead of creating a duplicate..

string

Display value for Product.Name..

number

Display value for Product.Price..

string

Display value for Product.Business.Currency.Code..

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,
  "TariffTransferProductsToContract": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": null,
  "ProductBusinessCurrencyCode": null,
  "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": "TariffProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one TariffProduct

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

import requests

url = "https://spaces.nexudus.com/api/billing/tariffproducts/{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/tariffproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffTransferProductsToContract": true,
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductBusinessCurrencyCode": "<string>",
  "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