Update Tariff

PUT

api

billing

tariffs

Update Tariff

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/tariffs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "SystemTariffType": 123,
  "Price": 123,
  "CurrencyId": 123,
  "CancellationPeriod": 123,
  "DisplayOrder": 123,
  "InvoiceEvery": 123,
  "InvoiceEveryWeeks": 123,
  "BookingDueDateStrategy": 123,
  "AddressIdentityCheckProvider": 123,
  "AddressIdentityCheckRepeatPattern": 123,
  "IdentityCheckProvider": 123,
  "IdentityCheckRepeatPattern": 123,
  "DeliveryPreferencesMail": 123,
  "DeliveryPreferencesParcels": 123,
  "DeliveryPreferencesChecks": 123,
  "DeliveryPreferencesPublicity": 123,
  "DeliveryPreferencesOther": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "SystemTariffType": 123,
    "Price": 123,
    "CurrencyId": 123,
    "CancellationPeriod": 123,
    "DisplayOrder": 123,
    "InvoiceEvery": 123,
    "InvoiceEveryWeeks": 123,
    "BookingDueDateStrategy": 123,
    "AddressIdentityCheckProvider": 123,
    "AddressIdentityCheckRepeatPattern": 123,
    "IdentityCheckProvider": 123,
    "IdentityCheckRepeatPattern": 123,
    "DeliveryPreferencesMail": 123,
    "DeliveryPreferencesParcels": 123,
    "DeliveryPreferencesChecks": 123,
    "DeliveryPreferencesPublicity": 123,
    "DeliveryPreferencesOther": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    SystemTariffType: 123,
    Price: 123,
    CurrencyId: 123,
    CancellationPeriod: 123,
    DisplayOrder: 123,
    InvoiceEvery: 123,
    InvoiceEveryWeeks: 123,
    BookingDueDateStrategy: 123,
    AddressIdentityCheckProvider: 123,
    AddressIdentityCheckRepeatPattern: 123,
    IdentityCheckProvider: 123,
    IdentityCheckRepeatPattern: 123,
    DeliveryPreferencesMail: 123,
    DeliveryPreferencesParcels: 123,
    DeliveryPreferencesChecks: 123,
    DeliveryPreferencesPublicity: 123,
    DeliveryPreferencesOther: 123
  })
};

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

Updates an existing Tariff record. You must include the Id of the record to update along with all required fields.

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 Tariff-Edit role.

Enums

eTariffType — SystemTariffType values

Value	Name
1	FullTimePrivateOffice
2	PartTimePrivateOffice
3	FullTimeDedicatedDesk
4	PartTimeDedicatedDesk
5	FullTimeHotDesk
6	PartTimeHotDesk
7	FullTimeOther
8	PartTimeOther
9	Storage
10	VirtualOffice
11	Virtual
99	Other

eTariffBookingDueDateStrategy — BookingDueDateStrategy values

Value	Name
1	RenewalDate
2	BookingEndDate
3	BookingCreationDate
4	NextNthOfMonth

eIdentityCheckProvider — AddressIdentityCheckProvider values

Value	Name
1	Manual
2	StripeIdentity

eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values

Value	Name
1	Never
2	Every3Months
3	Every6Months
4	Every12Months
5	Every24Months

eDeliveryHandlingPreference

Value	Name
1	StoreForCollection
2	Forward
3	OpenScanForward
4	OpenScanRecycle
5	OpenScanShred
6	OpenScanStoreForCollection
7	Recycle
8	ReturnToSender
9	Shred
10	DepositCheck
11	Unknown

Request Body

Required Fields

integer

required

The Id of the Tariff record to update.

integer

required

ID of the business linked to this record.

string

required

Plan name.

integer

required

Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.

number

required

Recurring price charged per billing cycle.

integer

required

ID of the currency linked to this record.

integer

required

Number of days’ notice required before a contract can be cancelled.

integer

required

Display order on the members portal (lower numbers appear first).

integer

required

Billing cycle length in months. Set to 0 if billing by weeks instead.

integer

required

Billing cycle length in weeks. Set to 0 if billing by months instead.

integer

required

Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.

integer

required

Provider used for address identity checks: Manual or StripeIdentity.

integer

required

How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.

integer

required

Provider used for identity checks: Manual or StripeIdentity.

integer

required

How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.

integer

required

Allowed handling preferences for mail deliveries (virtual office).

integer

required

Allowed handling preferences for parcel deliveries (virtual office).

integer

required

Allowed handling preferences for check deliveries (virtual office).

integer

required

Allowed handling preferences for publicity deliveries (virtual office).

integer

required

Allowed handling preferences for other deliveries (virtual office).

Optional Fields

integer

Day of the month on which invoices are generated for members on this plan.

boolean

Whether the plan is visible to customers on the members portal and mobile app.

boolean

Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.

string

Custom notes provided to the AI assistant when describing this plan.

boolean

Whether to show the plan price to the AI assistant.

number

Custom price shown to the AI assistant instead of the actual price.

boolean

Whether this plan uses time passes for check-in access.

string

Plan description shown to customers.

string

Custom text shown on the invoice line instead of the plan name.

One-off fee charged when a customer first signs up to this plan.

integer

Standard tax rate applied to charges on this plan.

integer

Reduced tax rate applied when applicable.

integer

Tax-exempt rate applied when applicable.

integer

Financial account used for revenue tracking.

string

Terms and conditions text that members must accept when signing up.

string

URL to upload a new contract document template.

boolean

Set to true to remove the uploaded contract document file.

string

Group name used to visually group plans together on the members portal.

boolean

Prevents members from cancelling this plan through the members portal.

integer

Maximum number of members that can be signed up to this plan at any time.

integer

Minimum number of days a contract must be active before it can be cancelled.

integer

Default minimum contract term in months for new sign-ups.

integer

Number of days after contract cancellation before the member account is deactivated.

integer

Maximum number of check-ins included per billing cycle.

integer

Maximum number of check-ins allowed per month.

integer

Maximum number of check-ins allowed per week.

integer

Maximum number of visitor passes allowed per month.

integer

Maximum number of visitor passes allowed per week.

integer

Maximum number of visitor passes allowed per day.

integer

Maximum number of hours included per billing cycle.

integer

Maximum number of hours allowed per month.

integer

Maximum number of hours allowed per week.

integer

Maximum booking minutes allowed per week.

integer

Maximum booking minutes allowed per month.

number

Discount percentage for extra services.

number

Discount percentage for time passes.

number

Discount percentage for charges.

integer

Number of days after which the contract is automatically cancelled if not paid.

integer

Number of billing cycles to invoice in advance.

integer

Day of the month used to align billing cycles when prorating.

integer

Number of days before the prorate day to start prorating.

boolean

Whether to prorate the final invoice when a contract is cancelled mid-cycle.

integer

Number of days to extend a contract after payment is received.

boolean

Whether to exclude this plan’s charges from member invoices.

boolean

Whether to automatically generate invoices at the end of each billing cycle.

integer

Raise invoice every N months.

integer

Raise invoice every N weeks.

number

Minimum total amount charged per billing cycle regardless of usage.

boolean

Whether time pass charges count towards the minimum price.

boolean

Whether extra service charges count towards the minimum price.

boolean

Whether event charges count towards the minimum price.

boolean

Whether the plan is archived and no longer available for new sign-ups.

boolean

Whether the plan is starred (highlighted) on the members portal.

boolean

Whether new sign-ups are kept on hold until manually approved.

boolean

Whether members can pause their contract on this plan.

integer

Maximum number of times a contract can be paused per year.

integer

Maximum number of billing cycles a contract can be paused for.

integer

Day of the month used when BookingDueDateStrategy is NextNthOfMonth.

boolean

Whether this is a virtual office plan with mail handling features.

boolean

Whether to keep the contract on hold until all required identity checks are completed.

boolean

Whether to request an address identity check from members signing up to this plan.

string

Instructions shown to members when completing the address identity check.

boolean

Whether to keep the contract paused if the address identity check reveals a mismatch.

boolean

Whether to request an identity (ID document) check from members signing up to this plan.

string

Instructions shown to members when completing the identity check.

boolean

Whether to request an AML check from members signing up to this plan.

boolean

Whether to enable AML checks against the OpenSanctions dataset.

boolean

Whether to enable AML checks against the Pappers dataset.

string

Which OpenSanctions dataset to check against for AML screening (e.g. ‘default’).

number

Score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7.

boolean

Whether to email the onboarding form to new members signing up to this plan.

integer

ID of the onboarding form page sent to new members.

integer[]

Product IDs for mail stored for collection (virtual office).

integer[]

The added products store value for this tariff.

integer[]

The removed products store value for this tariff.

integer[]

Product IDs for mail forwarding (virtual office).

integer[]

The added products forward value for this tariff.

integer[]

The removed products forward value for this tariff.

integer[]

Product IDs for mail recycling (virtual office).

integer[]

The added products recycle value for this tariff.

integer[]

The removed products recycle value for this tariff.

integer[]

Product IDs for mail shredding (virtual office).

integer[]

The added products shred value for this tariff.

integer[]

The removed products shred value for this tariff.

integer[]

Product IDs for mail scanning (virtual office).

integer[]

The added products scan value for this tariff.

integer[]

The removed products scan value for this tariff.

integer[]

Product IDs for returning mail to sender (virtual office).

integer[]

The added products return value for this tariff.

integer[]

The removed products return value for this tariff.

integer[]

Product IDs for check deposits (virtual office).

integer[]

The added products deposit value for this tariff.

integer[]

The removed products deposit value for this tariff.

integer[]

Product IDs for mail collection (virtual office).

integer[]

The added products collect value for this tariff.

integer[]

The removed products collect value for this tariff.

integer

Maximum number of days deliveries are stored before being returned (virtual office).

integer

Maximum number of company name aliases allowed for mail handling (virtual office).

integer

Maximum number of mail recipients allowed (virtual office).

integer

Maximum number of forwarding addresses allowed (virtual office).

boolean

Whether to automatically transfer mail handling products to the member’s contract.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/tariffs" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "SystemTariffType": 0,
    "Price": 0,
    "CurrencyId": 0,
    "CancellationPeriod": 0,
    "DisplayOrder": 0,
    "InvoiceEvery": 0,
    "InvoiceEveryWeeks": 0,
    "BookingDueDateStrategy": 0,
    "AddressIdentityCheckProvider": 0,
    "AddressIdentityCheckRepeatPattern": 0,
    "IdentityCheckProvider": 0,
    "IdentityCheckRepeatPattern": 0,
    "DeliveryPreferencesMail": 0,
    "DeliveryPreferencesParcels": 0,
    "DeliveryPreferencesChecks": 0,
    "DeliveryPreferencesPublicity": 0,
    "DeliveryPreferencesOther": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/tariffs',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      SystemTariffType: 0,
      Price: 0,
      CurrencyId: 0,
      CancellationPeriod: 0,
      DisplayOrder: 0,
      InvoiceEvery: 0,
      InvoiceEveryWeeks: 0,
      BookingDueDateStrategy: 0,
      AddressIdentityCheckProvider: 0,
      AddressIdentityCheckRepeatPattern: 0,
      IdentityCheckProvider: 0,
      IdentityCheckRepeatPattern: 0,
      DeliveryPreferencesMail: 0,
      DeliveryPreferencesParcels: 0,
      DeliveryPreferencesChecks: 0,
      DeliveryPreferencesPublicity: 0,
      DeliveryPreferencesOther: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/tariffs',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'SystemTariffType': 0,
        'Price': 0,
        'CurrencyId': 0,
        'CancellationPeriod': 0,
        'DisplayOrder': 0,
        'InvoiceEvery': 0,
        'InvoiceEveryWeeks': 0,
        'BookingDueDateStrategy': 0,
        'AddressIdentityCheckProvider': 0,
        'AddressIdentityCheckRepeatPattern': 0,
        'IdentityCheckProvider': 0,
        'IdentityCheckRepeatPattern': 0,
        'DeliveryPreferencesMail': 0,
        'DeliveryPreferencesParcels': 0,
        'DeliveryPreferencesChecks': 0,
        'DeliveryPreferencesPublicity': 0,
        'DeliveryPreferencesOther': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the tariff was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Tariff was successfully updated.",
  "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
}

Delete TariffDelete an existing Tariff record by its Id.

Update Tariff

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/tariffs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "SystemTariffType": 123,
  "Price": 123,
  "CurrencyId": 123,
  "CancellationPeriod": 123,
  "DisplayOrder": 123,
  "InvoiceEvery": 123,
  "InvoiceEveryWeeks": 123,
  "BookingDueDateStrategy": 123,
  "AddressIdentityCheckProvider": 123,
  "AddressIdentityCheckRepeatPattern": 123,
  "IdentityCheckProvider": 123,
  "IdentityCheckRepeatPattern": 123,
  "DeliveryPreferencesMail": 123,
  "DeliveryPreferencesParcels": 123,
  "DeliveryPreferencesChecks": 123,
  "DeliveryPreferencesPublicity": 123,
  "DeliveryPreferencesOther": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "SystemTariffType": 123,
    "Price": 123,
    "CurrencyId": 123,
    "CancellationPeriod": 123,
    "DisplayOrder": 123,
    "InvoiceEvery": 123,
    "InvoiceEveryWeeks": 123,
    "BookingDueDateStrategy": 123,
    "AddressIdentityCheckProvider": 123,
    "AddressIdentityCheckRepeatPattern": 123,
    "IdentityCheckProvider": 123,
    "IdentityCheckRepeatPattern": 123,
    "DeliveryPreferencesMail": 123,
    "DeliveryPreferencesParcels": 123,
    "DeliveryPreferencesChecks": 123,
    "DeliveryPreferencesPublicity": 123,
    "DeliveryPreferencesOther": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    SystemTariffType: 123,
    Price: 123,
    CurrencyId: 123,
    CancellationPeriod: 123,
    DisplayOrder: 123,
    InvoiceEvery: 123,
    InvoiceEveryWeeks: 123,
    BookingDueDateStrategy: 123,
    AddressIdentityCheckProvider: 123,
    AddressIdentityCheckRepeatPattern: 123,
    IdentityCheckProvider: 123,
    IdentityCheckRepeatPattern: 123,
    DeliveryPreferencesMail: 123,
    DeliveryPreferencesParcels: 123,
    DeliveryPreferencesChecks: 123,
    DeliveryPreferencesPublicity: 123,
    DeliveryPreferencesOther: 123
  })
};

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400