Search Tariffs - Nexudus Platform

A Tariff (also called a Plan) is a membership plan that customers can sign up to in exchange for access to a coworking space and other benefits. Tariffs are the foundation for contracts — every time a customer signs up to a plan, Nexudus generates a CoworkerContract for that member based on the plan’s settings. Plans define billing frequency (in months or weeks via InvoiceEvery / InvoiceEveryWeeks), pricing, cancellation rules, and limits on check-ins, booking minutes, visitor passes, and hours. Members are invoiced at the end of each billing cycle. Plans can include benefits such as day passes, booking credits, and money credits — these are configured through CoworkerExtraService and Product entities linked to the contract. Use SystemTariffType to categorise the plan (e.g. FullTimeHotDesk, VirtualOffice, Storage). Use Visible to control whether the plan appears on the members portal. Plans can optionally require identity checks before activation, enforce contract terms, support pausing, and define delivery handling preferences for virtual office mail. When you edit a plan, changes impact all members signed up to that plan. To customise settings for an individual member, edit their CoworkerContract 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 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

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

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. 0 for ascending, 1 for descending.

Filters

Tariff_Business

integer

Filter by iD of the business linked to this record.

Tariff_Business_Name

string

Filter by business name.

Tariff_Name

string

Filter by plan name.

Tariff_SystemTariffType

integer

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

Tariff_Price

number

Filter by recurring price charged per billing cycle.

Tariff_DefaultInvoicingDay

integer

Filter by day of the month on which invoices are generated for members on this plan.

Tariff_Visible

boolean

Filter by whether the plan is visible to customers on the members portal and mobile app.

Tariff_AvailableToAi

boolean

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

Tariff_NotesForAi

string

Filter by custom notes provided to the AI assistant when describing this plan.

Tariff_ShowPriceForAi

boolean

Filter by whether to show the plan price to the AI assistant.

Tariff_PriceForAi

number

Filter by custom price shown to the AI assistant instead of the actual price.

Tariff_UseTimePasses

boolean

Filter by whether this plan uses time passes for check-in access.

Tariff_Description

string

Filter by plan description shown to customers.

Tariff_InvoiceLineDisplayAs

string

Filter by custom text shown on the invoice line instead of the plan name.

Filter by one-off fee charged when a customer first signs up to this plan.

Tariff_Currency

integer

Filter by iD of the currency linked to this record.

Tariff_Currency_Code

string

Filter by currency code.

Tariff_TaxRate

integer

Filter by standard tax rate applied to charges on this plan.

Tariff_ReducedTaxRate

integer

Filter by reduced tax rate applied when applicable.

Tariff_ExemptTaxRate

integer

Filter by tax-exempt rate applied when applicable.

Tariff_FinancialAccount

integer

Filter by financial account used for revenue tracking.

Tariff_TermsAndConditions

string

Filter by terms and conditions text that members must accept when signing up.

Tariff_ContractDocumentFileName

string

Filter by file name of the contract document template.

Tariff_NewContractDocumentUrl

string

Filter by uRL to upload a new contract document template.

Tariff_ClearContractDocument

boolean

Filter by set to true to remove the uploaded contract document file.

Tariff_CancellationPeriod

integer

Filter by number of days’ notice required before a contract can be cancelled.

Tariff_DisplayOrder

integer

Filter by display order on the members portal (lower numbers appear first).

Tariff_GroupName

string

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

Tariff_DisablePortalCancellations

boolean

Filter by prevents members from cancelling this plan through the members portal.

Tariff_SubscribersLimit

integer

Filter by maximum number of members that can be signed up to this plan at any time.

Tariff_CancellationLimitDays

integer

Filter by minimum number of days a contract must be active before it can be cancelled.

Tariff_DefaultContractTerm

integer

Filter by default minimum contract term in months for new sign-ups.

Tariff_CancelMemeberAccountAfter

integer

Filter by number of days after contract cancellation before the member account is deactivated.

Tariff_CheckinPricePlanLimit

integer

Filter by maximum number of check-ins included per billing cycle.

Tariff_CheckinMonthLimit

integer

Filter by maximum number of check-ins allowed per month.

Tariff_CheckinWeekLimit

integer

Filter by maximum number of check-ins allowed per week.

Tariff_VisitorMonthLimit

integer

Filter by maximum number of visitor passes allowed per month.

Tariff_VisitorWeekLimit

integer

Filter by maximum number of visitor passes allowed per week.

Tariff_VisitorDayLimit

integer

Filter by maximum number of visitor passes allowed per day.

Tariff_HoursPricePlanLimit

integer

Filter by maximum number of hours included per billing cycle.

Tariff_HoursMonthLimit

integer

Filter by maximum number of hours allowed per month.

Tariff_HoursWeekLimit

integer

Filter by maximum number of hours allowed per week.

Tariff_BookingMinuteWeekLimit

integer

Filter by maximum booking minutes allowed per week.

Tariff_BookingMinuteMonthLimit

integer

Filter by maximum booking minutes allowed per month.

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 billing cycle length in months. Set to 0 if billing by weeks instead.

Tariff_InvoiceEveryWeeks

integer

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

Tariff_AutoCancelAfter

integer

Filter by number of days after which the contract is automatically cancelled if not paid.

Tariff_AdvanceInvoiceCycles

integer

Filter by number of billing cycles to invoice in advance.

Tariff_ProrateDayOfMonth

integer

Filter by day of the month used to align billing cycles when prorating.

Tariff_ProrateDaysBefore

integer

Filter by number of days before the prorate day to start prorating.

Tariff_ProrateCancellations

boolean

Filter by whether to prorate the final invoice when a contract is cancelled mid-cycle.

Tariff_ChargeAndExtend

integer

Filter by number of days to extend a contract after payment is received.

Tariff_ExcludeFromInvoice

boolean

Filter by whether to exclude this plan’s charges from member invoices.

Tariff_AutoRaiseInvoices

boolean

Filter by whether to automatically generate invoices at the end of each billing cycle.

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 total amount charged per billing cycle regardless of usage.

Tariff_MinimumPriceIncludeTimePasses

boolean

Filter by whether time pass charges count towards the minimum price.

Tariff_MinimumPriceIncludeExtraServices

boolean

Filter by whether extra service charges count towards the minimum price.

Tariff_MinimumPriceIncludeEvents

boolean

Filter by whether event charges count towards the minimum price.

Tariff_Archived

boolean

Filter by whether the plan is archived and no longer available for new sign-ups.

Tariff_Starred

boolean

Filter by whether the plan is starred (highlighted) on the members portal.

Tariff_KeepNewAccountsOnHold

boolean

Filter by whether new sign-ups are kept on hold until manually approved.

Tariff_CanBePaused

boolean

Filter by whether members can pause their contract on this plan.

Tariff_PauseYearlyLimit

integer

Filter by maximum number of times a contract can be paused per year.

Tariff_PauseCyclesLimit

integer

Filter by maximum number of billing cycles a contract can be paused for.

Tariff_BookingDueDateStrategy

integer

Filter by strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.

Tariff_BookingDueDateDayOfMonth

integer

Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth.

Filter by calculated total price at sign-up including the plan price and sign-up fee.

Tariff_TotalPrice

number

Filter by calculated total recurring price per billing cycle.

Tariff_IsVirtualOffice

boolean

Filter by whether this is a virtual office plan with mail handling features.

Tariff_WaitForIdentityChecksToActivate

boolean

Filter by whether to keep the contract on hold until all required identity checks are completed.

Tariff_RequestAddressIdentityCheck

boolean

Filter by whether to request an address identity check from members signing up to this plan.

Tariff_AddressIdentityCheckDescription

string

Filter by instructions shown to members when completing the address identity check.

Tariff_AddressIdentityCheckProvider

integer

Filter by provider used for address identity checks: Manual or StripeIdentity.

Tariff_KeepPausedIfAddressMismatch

boolean

Filter by whether to keep the contract paused if the address identity check reveals a mismatch.

Tariff_AddressIdentityCheckRepeatPattern

integer

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

Tariff_RequestIdentityCheck

boolean

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

Tariff_IdentityCheckProvider

integer

Filter by provider used for identity checks: Manual or StripeIdentity.

Tariff_IdentityCheckRepeatPattern

integer

Filter by how often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.

Tariff_IdentityCheckDescription

string

Filter by instructions shown to members when completing the identity check.

Tariff_RequestAmlCheck

boolean

Filter by whether to request an AML check from members signing up to this plan.

Tariff_AmlCheckOpenSanctionsEnabled

boolean

Filter by whether to enable AML checks against the OpenSanctions dataset.

Tariff_AmlCheckPappersEnabled

boolean

Filter by whether to enable AML checks against the Pappers dataset.

Tariff_AmlCheckOpenSanctionsDataset

string

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

Tariff_AmlCheckScoreThreshold

number

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

Tariff_SendOnBoardingFormByEmail

boolean

Filter by whether to email the onboarding form to new members signing up to this plan.

Tariff_FormPage

integer

Filter by iD of the onboarding form page sent to new members.

Tariff_FormPage_Name

string

Filter by form page name.

Tariff_DeliveryPreferencesMail

integer

Filter by allowed handling preferences for mail deliveries (virtual office).

Tariff_DeliveryPreferencesParcels

integer

Filter by allowed handling preferences for parcel deliveries (virtual office).

Tariff_DeliveryPreferencesChecks

integer

Filter by allowed handling preferences for check deliveries (virtual office).

Tariff_DeliveryPreferencesPublicity

integer

Filter by allowed handling preferences for publicity deliveries (virtual office).

Tariff_DeliveryPreferencesOther

integer

Filter by allowed handling preferences for other deliveries (virtual office).

Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum number of days deliveries are stored before being returned (virtual office).

Tariff_MaximumCompanyAliases

integer

Filter by maximum number of company name aliases allowed for mail handling (virtual office).

Tariff_MaximumRecipients

integer

Filter by maximum number of mail recipients allowed (virtual office).

Tariff_MaximumAddresses

integer

Filter by maximum number of forwarding addresses allowed (virtual office).

Tariff_TransferProductsToContract

boolean

Filter by whether to automatically transfer mail handling products to the member’s contract.

Range Filters

from_Tariff_Price

number

Filter by recurring price charged per billing cycle greater than or equal to this value.

to_Tariff_Price

number

Filter by recurring price charged per billing cycle less than or equal to this value.

from_Tariff_DefaultInvoicingDay

integer

Filter by day of the month on which invoices are generated for members on this plan greater than or equal to this value.

to_Tariff_DefaultInvoicingDay

integer

Filter by day of the month on which invoices are generated for members on this plan less than or equal to this value.

from_Tariff_PriceForAi

number

Filter by custom price shown to the AI assistant instead of the actual price greater than or equal to this value.

to_Tariff_PriceForAi

number

Filter by custom price shown to the AI assistant instead of the actual price less than or equal to this value.

Filter by one-off fee charged when a customer first signs up to this plan greater than or equal to this value.

Filter by one-off fee charged when a customer first signs up to this plan less than or equal to this value.

from_Tariff_CancellationPeriod

integer

Filter by number of days’ notice required before a contract can be cancelled greater than or equal to this value.

to_Tariff_CancellationPeriod

integer

Filter by number of days’ notice required before a contract can be cancelled less than or equal to this value.

from_Tariff_DisplayOrder

integer

Filter by display order on the members portal (lower numbers appear first) greater than or equal to this value.

to_Tariff_DisplayOrder

integer

Filter by display order on the members portal (lower numbers appear first) less than or equal to this value.

from_Tariff_SubscribersLimit

integer

Filter by maximum number of members that can be signed up to this plan at any time greater than or equal to this value.

to_Tariff_SubscribersLimit

integer

Filter by maximum number of members that can be signed up to this plan at any time less than or equal to this value.

from_Tariff_CancellationLimitDays

integer

Filter by minimum number of days a contract must be active before it can be cancelled greater than or equal to this value.

to_Tariff_CancellationLimitDays

integer

Filter by minimum number of days a contract must be active before it can be cancelled less than or equal to this value.

from_Tariff_DefaultContractTerm

integer

Filter by default minimum contract term in months for new sign-ups greater than or equal to this value.

to_Tariff_DefaultContractTerm

integer

Filter by default minimum contract term in months for new sign-ups less than or equal to this value.

from_Tariff_CancelMemeberAccountAfter

integer

Filter by number of days after contract cancellation before the member account is deactivated greater than or equal to this value.

to_Tariff_CancelMemeberAccountAfter

integer

Filter by number of days after contract cancellation before the member account is deactivated less than or equal to this value.

from_Tariff_CheckinPricePlanLimit

integer

Filter by maximum number of check-ins included per billing cycle greater than or equal to this value.

to_Tariff_CheckinPricePlanLimit

integer

Filter by maximum number of check-ins included per billing cycle less than or equal to this value.

from_Tariff_CheckinMonthLimit

integer

Filter by maximum number of check-ins allowed per month greater than or equal to this value.

to_Tariff_CheckinMonthLimit

integer

Filter by maximum number of check-ins allowed per month less than or equal to this value.

from_Tariff_CheckinWeekLimit

integer

Filter by maximum number of check-ins allowed per week greater than or equal to this value.

to_Tariff_CheckinWeekLimit

integer

Filter by maximum number of check-ins allowed per week less than or equal to this value.

from_Tariff_VisitorMonthLimit

integer

Filter by maximum number of visitor passes allowed per month greater than or equal to this value.

to_Tariff_VisitorMonthLimit

integer

Filter by maximum number of visitor passes allowed per month less than or equal to this value.

from_Tariff_VisitorWeekLimit

integer

Filter by maximum number of visitor passes allowed per week greater than or equal to this value.

to_Tariff_VisitorWeekLimit

integer

Filter by maximum number of visitor passes allowed per week less than or equal to this value.

from_Tariff_VisitorDayLimit

integer

Filter by maximum number of visitor passes allowed per day greater than or equal to this value.

to_Tariff_VisitorDayLimit

integer

Filter by maximum number of visitor passes allowed per day less than or equal to this value.

from_Tariff_HoursPricePlanLimit

integer

Filter by maximum number of hours included per billing cycle greater than or equal to this value.

to_Tariff_HoursPricePlanLimit

integer

Filter by maximum number of hours included per billing cycle less than or equal to this value.

from_Tariff_HoursMonthLimit

integer

Filter by maximum number of hours allowed per month greater than or equal to this value.

to_Tariff_HoursMonthLimit

integer

Filter by maximum number of hours allowed per month less than or equal to this value.

from_Tariff_HoursWeekLimit

integer

Filter by maximum number of hours allowed per week greater than or equal to this value.

to_Tariff_HoursWeekLimit

integer

Filter by maximum number of hours allowed per week less than or equal to this value.

from_Tariff_BookingMinuteWeekLimit

integer

Filter by maximum booking minutes allowed per week greater than or equal to this value.

to_Tariff_BookingMinuteWeekLimit

integer

Filter by maximum booking minutes allowed per week less than or equal to this value.

from_Tariff_BookingMinuteMonthLimit

integer

Filter by maximum booking minutes allowed per month greater than or equal to this value.

to_Tariff_BookingMinuteMonthLimit

integer

Filter by maximum booking minutes allowed per month 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 billing cycle length in months. Set to 0 if billing by weeks instead greater than or equal to this value.

to_Tariff_InvoiceEvery

integer

Filter by billing cycle length in months. Set to 0 if billing by weeks instead less than or equal to this value.

from_Tariff_InvoiceEveryWeeks

integer

Filter by billing cycle length in weeks. Set to 0 if billing by months instead greater than or equal to this value.

to_Tariff_InvoiceEveryWeeks

integer

Filter by billing cycle length in weeks. Set to 0 if billing by months instead less than or equal to this value.

from_Tariff_AutoCancelAfter

integer

Filter by number of days after which the contract is automatically cancelled if not paid greater than or equal to this value.

to_Tariff_AutoCancelAfter

integer

Filter by number of days after which the contract is automatically cancelled if not paid less than or equal to this value.

from_Tariff_AdvanceInvoiceCycles

integer

Filter by number of billing cycles to invoice in advance greater than or equal to this value.

to_Tariff_AdvanceInvoiceCycles

integer

Filter by number of billing cycles to invoice in advance less than or equal to this value.

from_Tariff_ProrateDayOfMonth

integer

Filter by day of the month used to align billing cycles when prorating greater than or equal to this value.

to_Tariff_ProrateDayOfMonth

integer

Filter by day of the month used to align billing cycles when prorating less than or equal to this value.

from_Tariff_ProrateDaysBefore

integer

Filter by number of days before the prorate day to start prorating greater than or equal to this value.

to_Tariff_ProrateDaysBefore

integer

Filter by number of days before the prorate day to start prorating less than or equal to this value.

from_Tariff_ChargeAndExtend

integer

Filter by number of days to extend a contract after payment is received greater than or equal to this value.

to_Tariff_ChargeAndExtend

integer

Filter by number of days to extend a contract after payment is received 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 total amount charged per billing cycle regardless of usage greater than or equal to this value.

to_Tariff_MinimumPrice

number

Filter by minimum total amount charged per billing cycle regardless of usage less than or equal to this value.

from_Tariff_PauseYearlyLimit

integer

Filter by maximum number of times a contract can be paused per year greater than or equal to this value.

to_Tariff_PauseYearlyLimit

integer

Filter by maximum number of times a contract can be paused per year less than or equal to this value.

from_Tariff_PauseCyclesLimit

integer

Filter by maximum number of billing cycles a contract can be paused for greater than or equal to this value.

to_Tariff_PauseCyclesLimit

integer

Filter by maximum number of billing cycles a contract can be paused for less than or equal to this value.

from_Tariff_BookingDueDateDayOfMonth

integer

Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth greater than or equal to this value.

to_Tariff_BookingDueDateDayOfMonth

integer

Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth less than or equal to this value.

Filter by calculated total price at sign-up including the plan price and sign-up fee greater than or equal to this value.

Filter by calculated total price at sign-up including the plan price and sign-up fee less than or equal to this value.

from_Tariff_TotalPrice

number

Filter by calculated total recurring price per billing cycle greater than or equal to this value.

to_Tariff_TotalPrice

number

Filter by calculated total recurring price per billing cycle less than or equal to this value.

from_Tariff_AmlCheckScoreThreshold

number

Filter by 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 greater than or equal to this value.

to_Tariff_AmlCheckScoreThreshold

number

Filter by 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 less than or equal to this value.

from_Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum number of days deliveries are stored before being returned (virtual office) greater than or equal to this value.

to_Tariff_MaximumDeliveryStorageDays

integer

Filter by maximum number of days deliveries are stored before being returned (virtual office) less than or equal to this value.

from_Tariff_MaximumCompanyAliases

integer

Filter by maximum number of company name aliases allowed for mail handling (virtual office) greater than or equal to this value.

to_Tariff_MaximumCompanyAliases

integer

Filter by maximum number of company name aliases allowed for mail handling (virtual office) less than or equal to this value.

from_Tariff_MaximumRecipients

integer

Filter by maximum number of mail recipients allowed (virtual office) greater than or equal to this value.

to_Tariff_MaximumRecipients

integer

Filter by maximum number of mail recipients allowed (virtual office) less than or equal to this value.

from_Tariff_MaximumAddresses

integer

Filter by maximum number of forwarding addresses allowed (virtual office) greater than or equal to this value.

to_Tariff_MaximumAddresses

integer

Filter by maximum number of forwarding addresses allowed (virtual office) 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=0" \
  -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=0" \
  -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=0" \
  -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 populated 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 (0 = 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,
      "AvailableToAi": false,
      "NotesForAi": null,
      "ShowPriceForAi": false,
      "PriceForAi": null,
      "UseTimePasses": false,
      "InvoiceLineDisplayAs": null,
      "SignUpFee": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": 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,
      "WaitForIdentityChecksToActivate": false,
      "RequestAddressIdentityCheck": false,
      "AddressIdentityCheckProvider": 0,
      "KeepPausedIfAddressMismatch": false,
      "AddressIdentityCheckRepeatPattern": 0,
      "RequestIdentityCheck": false,
      "IdentityCheckProvider": 0,
      "IdentityCheckRepeatPattern": 0,
      "RequestAmlCheck": false,
      "AmlCheckOpenSanctionsEnabled": false,
      "AmlCheckPappersEnabled": false,
      "AmlCheckOpenSanctionsDataset": null,
      "AmlCheckScoreThreshold": null,
      "SendOnBoardingFormByEmail": false,
      "FormPageId": null,
      "FormPageName": null,
      "ProductsStore": [],
      "ProductsForward": [],
      "ProductsRecycle": [],
      "ProductsShred": [],
      "ProductsScan": [],
      "ProductsReturn": [],
      "ProductsDeposit": [],
      "ProductsCollect": [],
      "DeliveryPreferencesMail": 0,
      "DeliveryPreferencesParcels": 0,
      "DeliveryPreferencesChecks": 0,
      "DeliveryPreferencesPublicity": 0,
      "DeliveryPreferencesOther": 0,
      "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
}

​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