Create TariffSignupProduct

POST

api

billing

tariffsignupproducts

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

import requests

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

payload = {
    "TariffId": 123,
    "ProductId": 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, ProductId: 123})
};

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

Request Body

Required Fields

integer

required

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

integer

required

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

Optional Fields

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

Code Examples

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

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

const data = await response.json();

import requests

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

array

null on success.

Example Response

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

Create TariffSignupProduct

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

import requests

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

payload = {
    "TariffId": 123,
    "ProductId": 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, ProductId: 123})
};

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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400