Create TariffProduct

POST

api

billing

tariffproducts

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

import requests

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

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/tariffproducts', 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 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-Create role.

Request Body

Required Fields

integer

required

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

integer

required

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

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/tariffproducts" \
  -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/tariffproducts',
  {
    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/tariffproducts',
    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 tariffproduct was created successfully.

array

null on success.

Example Response

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

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

import requests

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

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/tariffproducts', 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

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Code Examples

Response

200

400