Search Tariffs

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

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

Tariff_Business

integer

Filter by Business Id.

Tariff_Business_Name

string

Filter by business name.

Tariff_Name

string

Filter by tariff name.

Tariff_SystemTariffType

integer

Filter by system tariff type.

Tariff_Price

number

Filter by price.

Tariff_DefaultInvoicingDay

integer

Filter by default invoicing day.

Tariff_Visible

boolean

Filter by whether the tariff is visible.

Tariff_UseTimePasses

boolean

Filter by whether to use time passes.

Tariff_Description

string

Filter by description.

Tariff_InvoiceLineDisplayAs

string

Filter by invoice line display text.

Filter by sign-up fee.

Tariff_Currency

integer

Filter by Currency Id.

Tariff_Currency_Code

string

Filter by currency code.

Tariff_TaxRate

integer

Filter by Tax Rate Id.

Tariff_ReducedTaxRate

integer

Filter by Reduced Tax Rate Id.

Tariff_ExemptTaxRate

integer

Filter by Exempt Tax Rate Id.

Tariff_FinancialAccount

integer

Filter by Financial Account Id.

Tariff_TermsAndConditions

string

Filter by terms and conditions.

Tariff_ContractDocumentFileName

string

Filter by Contract Document File Name.

Tariff_NewContractDocumentUrl

string

Filter by New Contract Document Url.

Tariff_ClearContractDocument

boolean

Filter by Clear Contract Document File.

Tariff_CancellationPeriod

integer

Filter by cancellation period in days.

Tariff_DisplayOrder

integer

Filter by display order.

Tariff_GroupName

string

Filter by group name.

Tariff_DisablePortalCancellations

boolean

Filter by disable portal cancellations.

Tariff_SubscribersLimit

integer

Filter by subscribers limit.

Tariff_CancellationLimitDays

integer

Filter by cancellation limit in days.

Tariff_DefaultContractTerm

integer

Filter by default contract term in months.

Tariff_CancelMemeberAccountAfter

integer

Filter by cancel member account after days.

Tariff_CheckinPricePlanLimit

integer

Filter by check-in price plan limit.

Tariff_CheckinMonthLimit

integer

Filter by check-in month limit.

Tariff_CheckinWeekLimit

integer

Filter by check-in week limit.

Tariff_VisitorMonthLimit

integer

Filter by visitor month limit.

Tariff_VisitorWeekLimit

integer

Filter by visitor week limit.

Tariff_VisitorDayLimit

integer

Filter by visitor day limit.

Tariff_HoursPricePlanLimit

integer

Filter by hours price plan limit.

Tariff_HoursMonthLimit

integer

Filter by hours month limit.

Tariff_HoursWeekLimit

integer

Filter by hours week limit.

Tariff_BookingMinuteWeekLimit

integer

Filter by booking minute week limit.

Tariff_BookingMinuteMonthLimit

integer

Filter by booking minute month limit.

Tariff_DiscountExtraServices

number

Filter by discount percentage for extra services.

Tariff_DiscountTimePasses

number

Filter by discount percentage for time passes.

Tariff_DiscountCharges

number

Filter by discount percentage for charges.

Tariff_InvoiceEvery

integer

Filter by invoice every N months.

Tariff_InvoiceEveryWeeks

integer

Filter by invoice every N weeks.

Tariff_AutoCancelAfter

integer

Filter by auto cancel after days.

Tariff_AdvanceInvoiceCycles

integer

Filter by advance invoice cycles.

Tariff_ProrateDayOfMonth

integer

Filter by prorate day of month.

Tariff_ProrateDaysBefore

integer

Filter by prorate days before.

Tariff_ProrateCancellations

boolean

Filter by prorate cancellations.

Tariff_ChargeAndExtend

integer

Filter by charge and extend days.

Tariff_ExcludeFromInvoice

boolean

Filter by Exclude From Invoice.

Tariff_AutoRaiseInvoices

boolean

Filter by auto raise invoices.

Tariff_RaiseInvoiceEvery

integer

Filter by raise invoice every N months.

Tariff_RaiseInvoiceEveryWeeks

integer

Filter by raise invoice every N weeks.

Tariff_MinimumPrice

number

Filter by minimum price.

Tariff_MinimumPriceIncludeTimePasses

boolean

Filter by include time passes in minimum price.

Tariff_MinimumPriceIncludeExtraServices

boolean

Filter by include extra services in minimum price.

Tariff_MinimumPriceIncludeEvents

boolean

Filter by include events in minimum price.

Tariff_Archived

boolean

Filter by whether the tariff is archived.

Tariff_Starred

boolean

Filter by whether the tariff is starred.

Tariff_KeepNewAccountsOnHold

boolean

Filter by keep new accounts on hold.

Tariff_CanBePaused

boolean

Filter by whether the tariff can be paused.

Tariff_PauseYearlyLimit

integer

Filter by pause yearly limit.

Tariff_PauseCyclesLimit

integer

Filter by pause cycles limit.

Tariff_BookingDueDateStrategy

integer

Filter by booking due date strategy.

Tariff_BookingDueDateDayOfMonth

integer

Filter by booking due date day of month.

Filter by total sign-up price.

Tariff_TotalPrice

number

Filter by total price.

Tariff_IsVirtualOffice

boolean

Filter by whether this is a virtual office tariff.

Tariff_RequestAddressIdentityCheck

boolean

Filter by request address identity check.

Tariff_AddressIdentityCheckDescription

string

Filter by address identity check description.

Tariff_AddressIdentityCheckProvider

integer

Filter by address identity check provider.

Tariff_KeepPausedIfAddressMismatch

boolean

Filter by keep paused if address mismatch.

Tariff_AddressIdentityCheckRepeatPattern

integer

Filter by address identity check repeat pattern.

Tariff_RequestIdentityCheck

boolean

Filter by request identity check.

Tariff_IdentityCheckProvider

integer

Filter by identity check provider.

Tariff_IdentityCheckRepeatPattern

integer

Filter by identity check repeat pattern.

Tariff_IdentityCheckDescription

string

Filter by identity check description.

Tariff_SendOnBoardingFormByEmail

boolean

Filter by send onboarding form by email.

Tariff_FormPage

integer

Filter by Form Page Id.

Tariff_FormPage_Name

string

Filter by form page name.

Tariff_DeliveryPreferencesMail

string

Filter by delivery preferences for mail.

Tariff_DeliveryPreferencesParcels

string

Filter by delivery preferences for parcels.

Tariff_DeliveryPreferencesChecks

string

Filter by delivery preferences for checks.

Tariff_DeliveryPreferencesPublicity

string

Filter by delivery preferences for publicity.

Tariff_DeliveryPreferencesOther

string

Filter by delivery preferences for other.

Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum delivery storage days.

Tariff_MaximumCompanyAliases

integer

Filter by maximum company aliases.

Tariff_MaximumRecipients

integer

Filter by maximum recipients.

Tariff_MaximumAddresses

integer

Filter by maximum addresses.

Tariff_TransferProductsToContract

boolean

Filter by transfer products to contract.

Range Filters

from_Tariff_Price

number

Filter by price greater than or equal to this value.

to_Tariff_Price

number

Filter by price less than or equal to this value.

from_Tariff_DefaultInvoicingDay

integer

Filter by default invoicing day greater than or equal to this value.

to_Tariff_DefaultInvoicingDay

integer

Filter by default invoicing day less than or equal to this value.

Filter by sign-up fee greater than or equal to this value.

Filter by sign-up fee less than or equal to this value.

from_Tariff_CancellationPeriod

integer

Filter by cancellation period in days greater than or equal to this value.

to_Tariff_CancellationPeriod

integer

Filter by cancellation period in days less than or equal to this value.

from_Tariff_DisplayOrder

integer

Filter by display order greater than or equal to this value.

to_Tariff_DisplayOrder

integer

Filter by display order less than or equal to this value.

from_Tariff_SubscribersLimit

integer

Filter by subscribers limit greater than or equal to this value.

to_Tariff_SubscribersLimit

integer

Filter by subscribers limit less than or equal to this value.

from_Tariff_CancellationLimitDays

integer

Filter by cancellation limit in days greater than or equal to this value.

to_Tariff_CancellationLimitDays

integer

Filter by cancellation limit in days less than or equal to this value.

from_Tariff_DefaultContractTerm

integer

Filter by default contract term in months greater than or equal to this value.

to_Tariff_DefaultContractTerm

integer

Filter by default contract term in months less than or equal to this value.

from_Tariff_CancelMemeberAccountAfter

integer

Filter by cancel member account after days greater than or equal to this value.

to_Tariff_CancelMemeberAccountAfter

integer

Filter by cancel member account after days less than or equal to this value.

from_Tariff_CheckinPricePlanLimit

integer

Filter by check-in price plan limit greater than or equal to this value.

to_Tariff_CheckinPricePlanLimit

integer

Filter by check-in price plan limit less than or equal to this value.

from_Tariff_CheckinMonthLimit

integer

Filter by check-in month limit greater than or equal to this value.

to_Tariff_CheckinMonthLimit

integer

Filter by check-in month limit less than or equal to this value.

from_Tariff_CheckinWeekLimit

integer

Filter by check-in week limit greater than or equal to this value.

to_Tariff_CheckinWeekLimit

integer

Filter by check-in week limit less than or equal to this value.

from_Tariff_VisitorMonthLimit

integer

Filter by visitor month limit greater than or equal to this value.

to_Tariff_VisitorMonthLimit

integer

Filter by visitor month limit less than or equal to this value.

from_Tariff_VisitorWeekLimit

integer

Filter by visitor week limit greater than or equal to this value.

to_Tariff_VisitorWeekLimit

integer

Filter by visitor week limit less than or equal to this value.

from_Tariff_VisitorDayLimit

integer

Filter by visitor day limit greater than or equal to this value.

to_Tariff_VisitorDayLimit

integer

Filter by visitor day limit less than or equal to this value.

from_Tariff_HoursPricePlanLimit

integer

Filter by hours price plan limit greater than or equal to this value.

to_Tariff_HoursPricePlanLimit

integer

Filter by hours price plan limit less than or equal to this value.

from_Tariff_HoursMonthLimit

integer

Filter by hours month limit greater than or equal to this value.

to_Tariff_HoursMonthLimit

integer

Filter by hours month limit less than or equal to this value.

from_Tariff_HoursWeekLimit

integer

Filter by hours week limit greater than or equal to this value.

to_Tariff_HoursWeekLimit

integer

Filter by hours week limit less than or equal to this value.

from_Tariff_BookingMinuteWeekLimit

integer

Filter by booking minute week limit greater than or equal to this value.

to_Tariff_BookingMinuteWeekLimit

integer

Filter by booking minute week limit less than or equal to this value.

from_Tariff_BookingMinuteMonthLimit

integer

Filter by booking minute month limit greater than or equal to this value.

to_Tariff_BookingMinuteMonthLimit

integer

Filter by booking minute month limit less than or equal to this value.

from_Tariff_DiscountExtraServices

number

Filter by discount percentage for extra services greater than or equal to this value.

to_Tariff_DiscountExtraServices

number

Filter by discount percentage for extra services less than or equal to this value.

from_Tariff_DiscountTimePasses

number

Filter by discount percentage for time passes greater than or equal to this value.

to_Tariff_DiscountTimePasses

number

Filter by discount percentage for time passes less than or equal to this value.

from_Tariff_DiscountCharges

number

Filter by discount percentage for charges greater than or equal to this value.

to_Tariff_DiscountCharges

number

Filter by discount percentage for charges less than or equal to this value.

from_Tariff_InvoiceEvery

integer

Filter by invoice every N months greater than or equal to this value.

to_Tariff_InvoiceEvery

integer

Filter by invoice every N months less than or equal to this value.

from_Tariff_InvoiceEveryWeeks

integer

Filter by invoice every N weeks greater than or equal to this value.

to_Tariff_InvoiceEveryWeeks

integer

Filter by invoice every N weeks less than or equal to this value.

from_Tariff_AutoCancelAfter

integer

Filter by auto cancel after days greater than or equal to this value.

to_Tariff_AutoCancelAfter

integer

Filter by auto cancel after days less than or equal to this value.

from_Tariff_AdvanceInvoiceCycles

integer

Filter by advance invoice cycles greater than or equal to this value.

to_Tariff_AdvanceInvoiceCycles

integer

Filter by advance invoice cycles less than or equal to this value.

from_Tariff_ProrateDayOfMonth

integer

Filter by prorate day of month greater than or equal to this value.

to_Tariff_ProrateDayOfMonth

integer

Filter by prorate day of month less than or equal to this value.

from_Tariff_ProrateDaysBefore

integer

Filter by prorate days before greater than or equal to this value.

to_Tariff_ProrateDaysBefore

integer

Filter by prorate days before less than or equal to this value.

from_Tariff_ChargeAndExtend

integer

Filter by charge and extend days greater than or equal to this value.

to_Tariff_ChargeAndExtend

integer

Filter by charge and extend days less than or equal to this value.

from_Tariff_RaiseInvoiceEvery

integer

Filter by raise invoice every N months greater than or equal to this value.

to_Tariff_RaiseInvoiceEvery

integer

Filter by raise invoice every N months less than or equal to this value.

from_Tariff_RaiseInvoiceEveryWeeks

integer

Filter by raise invoice every N weeks greater than or equal to this value.

to_Tariff_RaiseInvoiceEveryWeeks

integer

Filter by raise invoice every N weeks less than or equal to this value.

from_Tariff_MinimumPrice

number

Filter by minimum price greater than or equal to this value.

to_Tariff_MinimumPrice

number

Filter by minimum price less than or equal to this value.

from_Tariff_PauseYearlyLimit

integer

Filter by pause yearly limit greater than or equal to this value.

to_Tariff_PauseYearlyLimit

integer

Filter by pause yearly limit less than or equal to this value.

from_Tariff_PauseCyclesLimit

integer

Filter by pause cycles limit greater than or equal to this value.

to_Tariff_PauseCyclesLimit

integer

Filter by pause cycles limit less than or equal to this value.

from_Tariff_BookingDueDateDayOfMonth

integer

Filter by booking due date day of month greater than or equal to this value.

to_Tariff_BookingDueDateDayOfMonth

integer

Filter by booking due date day of month less than or equal to this value.

Filter by total sign-up price greater than or equal to this value.

Filter by total sign-up price less than or equal to this value.

from_Tariff_TotalPrice

number

Filter by total price greater than or equal to this value.

to_Tariff_TotalPrice

number

Filter by total price less than or equal to this value.

from_Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum delivery storage days greater than or equal to this value.

to_Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum delivery storage days less than or equal to this value.

from_Tariff_MaximumCompanyAliases

integer

Filter by maximum company aliases greater than or equal to this value.

to_Tariff_MaximumCompanyAliases

integer

Filter by maximum company aliases less than or equal to this value.

from_Tariff_MaximumRecipients

integer

Filter by maximum recipients greater than or equal to this value.

to_Tariff_MaximumRecipients

integer

Filter by maximum recipients less than or equal to this value.

from_Tariff_MaximumAddresses

integer

Filter by maximum addresses greater than or equal to this value.

to_Tariff_MaximumAddresses

integer

Filter by maximum addresses less than or equal to this value.

from_Tariff_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Tariff_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_Tariff_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Tariff_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tariffs?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tariffs?Tariff_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tariffs?from_Tariff_UpdatedOn=2025-01-01T00:00&to_Tariff_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

Tariff[]

The list of Tariff records matching the query. See the Get one Tariff endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Tariff. The following fields are not included in the Records[] response: Description, TermsAndConditions, AddressIdentityCheckDescription, IdentityCheckDescription.To get all fields, fetch the full record using the Get one Tariff endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (1 = ascending, -1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "SystemTariffType": 0,
      "Price": 0,
      "DefaultInvoicingDay": null,
      "Visible": false,
      "UseTimePasses": false,
      "Description": null,
      "InvoiceLineDisplayAs": null,
      "SignUpFee": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "TermsAndConditions": null,
      "ContractDocumentFileName": null,
      "NewContractDocumentUrl": null,
      "ClearContractDocumentFile": null,
      "CancellationPeriod": 0,
      "DisplayOrder": 0,
      "GroupName": null,
      "DisablePortalCancellations": false,
      "SubscribersLimit": null,
      "CancellationLimitDays": null,
      "DefaultContractTerm": null,
      "CancelMemeberAccountAfter": null,
      "CheckinPricePlanLimit": null,
      "CheckinMonthLimit": null,
      "CheckinWeekLimit": null,
      "VisitorMonthLimit": null,
      "VisitorWeekLimit": null,
      "VisitorDayLimit": null,
      "HoursPricePlanLimit": null,
      "HoursMonthLimit": null,
      "HoursWeekLimit": null,
      "BookingMinuteWeekLimit": null,
      "BookingMinuteMonthLimit": null,
      "DiscountExtraServices": null,
      "DiscountTimePasses": null,
      "DiscountCharges": null,
      "InvoiceEvery": 0,
      "InvoiceEveryWeeks": 0,
      "AutoCancelAfter": null,
      "AdvanceInvoiceCycles": null,
      "ProrateDayOfMonth": null,
      "ProrateDaysBefore": null,
      "ProrateCancellations": false,
      "ChargeAndExtend": null,
      "ExcludeFromInvoice": null,
      "AutoRaiseInvoices": false,
      "RaiseInvoiceEvery": null,
      "RaiseInvoiceEveryWeeks": null,
      "MinimumPrice": null,
      "MinimumPriceIncludeTimePasses": false,
      "MinimumPriceIncludeExtraServices": false,
      "MinimumPriceIncludeEvents": false,
      "Archived": false,
      "Starred": false,
      "KeepNewAccountsOnHold": false,
      "CanBePaused": false,
      "PauseYearlyLimit": null,
      "PauseCyclesLimit": null,
      "BookingDueDateStrategy": 0,
      "BookingDueDateDayOfMonth": null,
      "TotalSignUpPrice": 0,
      "TotalPrice": 0,
      "IsVirtualOffice": false,
      "RequestAddressIdentityCheck": false,
      "AddressIdentityCheckDescription": null,
      "AddressIdentityCheckProvider": 0,
      "KeepPausedIfAddressMismatch": false,
      "AddressIdentityCheckRepeatPattern": 0,
      "RequestIdentityCheck": false,
      "IdentityCheckProvider": 0,
      "IdentityCheckRepeatPattern": 0,
      "IdentityCheckDescription": null,
      "SendOnBoardingFormByEmail": false,
      "FormPageId": null,
      "FormPageName": null,
      "ProductsStore": [],
      "ProductsForward": [],
      "ProductsRecycle": [],
      "ProductsShred": [],
      "ProductsScan": [],
      "ProductsReturn": [],
      "ProductsDeposit": [],
      "ProductsCollect": [],
      "DeliveryPreferencesMail": null,
      "DeliveryPreferencesParcels": null,
      "DeliveryPreferencesChecks": null,
      "DeliveryPreferencesPublicity": null,
      "DeliveryPreferencesOther": null,
      "MaximumDeliveryStorageDays": null,
      "MaximumCompanyAliases": null,
      "MaximumRecipients": null,
      "MaximumAddresses": null,
      "TransferProductsToContract": 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": "Tariff Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200