Get one TariffSignupProduct

GET

api

billing

tariffsignupproducts

{id}

Get one TariffSignupProduct

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

import requests

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

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Price": 123,
  "Refundable": true,
  "InvoiceDuringOnlineCheckout": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A sign-up product (internally TariffSignupProduct) attaches a one-off deposit or sign-up fee to a plan (internally tariff). Creating a contract on that plan copies every sign-up product into a contract deposit (ContractDeposit), carrying over its price, refundable flag and online-checkout flag, and flags the contract to include the sign-up fee on its first eligible invoice. Sign-up product prices count towards the plan’s total sign-up price but not towards its recurring total price. Changes here affect only contracts created afterwards; contracts that already exist keep the deposits they were created with. Recurring add-ons belong on plan components (TariffProduct) 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 TariffSignupProduct-Read role.

Path Parameters

integer

required

The Id of the TariffSignupProduct record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the plan this sign-up fee belongs to; required, and it determines the owning location. Every contract created afterwards on that plan gets a matching deposit..

string

Display value for Tariff.Name..

integer

ID of the product charged as the sign-up fee or deposit; required, and its own current price is used whenever Price is left null, so reuse an existing product rather than creating a duplicate..

string

Display value for Product.Name..

number

Display value for Product.Price..

string

Display value for Product.Currency.Code..

number

Optional amount charged for this sign-up fee, in the location’s currency; when null the linked product’s own current price is used instead..

boolean

Whether the deposit created from this sign-up fee is refunded when the contract ends, producing an unpaid credit note that can also be used to offset exit or damage fees..

boolean

Whether this fee is charged during the customer’s online checkout instead of waiting for the contract’s first eligible invoice..

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,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": null,
  "ProductCurrencyCode": null,
  "Price": null,
  "Refundable": false,
  "InvoiceDuringOnlineCheckout": false,
  "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": "TariffSignupProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one TariffSignupProduct

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

import requests

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

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Price": 123,
  "Refundable": true,
  "InvoiceDuringOnlineCheckout": true,
  "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