Tariffs
Search Tariffs
Search and list Tariff records with filtering, sorting, and pagination.
GET
Search Tariffs
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
eTariffType — SystemTariffType values
eTariffBookingDueDateStrategy — BookingDueDateStrategy values
eTariffBookingDueDateStrategy — BookingDueDateStrategy values
eIdentityCheckProvider — AddressIdentityCheckProvider values
eIdentityCheckProvider — AddressIdentityCheckProvider values
eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values
eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values
eDeliveryHandlingPreference
eDeliveryHandlingPreference
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the business linked to this record.
string
Filter by business name.
string
Filter by plan name.
integer
Filter by category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.
number
Filter by recurring price charged per billing cycle.
integer
Filter by day of the month on which invoices are generated for members on this plan.
boolean
Filter by whether the plan is visible to customers on the members portal and mobile app.
boolean
Filter by whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
string
Filter by custom notes provided to the AI assistant when describing this plan.
boolean
Filter by whether to show the plan price to the AI assistant.
number
Filter by custom price shown to the AI assistant instead of the actual price.
boolean
Filter by whether this plan uses time passes for check-in access.
string
Filter by plan description shown to customers.
string
Filter by custom text shown on the invoice line instead of the plan name.
number
Filter by one-off fee charged when a customer first signs up to this plan.
integer
Filter by iD of the currency linked to this record.
string
Filter by currency code.
integer
Filter by standard tax rate applied to charges on this plan.
integer
Filter by reduced tax rate applied when applicable.
integer
Filter by tax-exempt rate applied when applicable.
integer
Filter by financial account used for revenue tracking.
string
Filter by terms and conditions text that members must accept when signing up.
string
Filter by file name of the contract document template.
string
Filter by uRL to upload a new contract document template.
boolean
Filter by set to true to remove the uploaded contract document file.
integer
Filter by number of days’ notice required before a contract can be cancelled.
integer
Filter by display order on the members portal (lower numbers appear first).
string
Filter by group name used to visually group plans together on the members portal.
boolean
Filter by prevents members from cancelling this plan through the members portal.
integer
Filter by maximum number of members that can be signed up to this plan at any time.
integer
Filter by minimum number of days a contract must be active before it can be cancelled.
integer
Filter by default minimum contract term in months for new sign-ups.
integer
Filter by number of days after contract cancellation before the member account is deactivated.
integer
Filter by maximum number of check-ins included per billing cycle.
integer
Filter by maximum number of check-ins allowed per month.
integer
Filter by maximum number of check-ins allowed per week.
integer
Filter by maximum number of visitor passes allowed per month.
integer
Filter by maximum number of visitor passes allowed per week.
integer
Filter by maximum number of visitor passes allowed per day.
integer
Filter by maximum number of hours included per billing cycle.
integer
Filter by maximum number of hours allowed per month.
integer
Filter by maximum number of hours allowed per week.
integer
Filter by maximum booking minutes allowed per week.
integer
Filter by maximum booking minutes allowed per month.
number
Filter by discount percentage for extra services.
number
Filter by discount percentage for time passes.
number
Filter by discount percentage for charges.
integer
Filter by billing cycle length in months. Set to 0 if billing by weeks instead.
integer
Filter by billing cycle length in weeks. Set to 0 if billing by months instead.
integer
Filter by number of days after which the contract is automatically cancelled if not paid.
integer
Filter by number of billing cycles to invoice in advance.
integer
Filter by day of the month used to align billing cycles when prorating.
integer
Filter by number of days before the prorate day to start prorating.
boolean
Filter by whether to prorate the final invoice when a contract is cancelled mid-cycle.
integer
Filter by number of days to extend a contract after payment is received.
boolean
Filter by whether to exclude this plan’s charges from member invoices.
boolean
Filter by whether to automatically generate invoices at the end of each billing cycle.
integer
Filter by raise invoice every N months.
integer
Filter by raise invoice every N weeks.
number
Filter by minimum total amount charged per billing cycle regardless of usage.
boolean
Filter by whether time pass charges count towards the minimum price.
boolean
Filter by whether extra service charges count towards the minimum price.
boolean
Filter by whether event charges count towards the minimum price.
boolean
Filter by whether the plan is archived and no longer available for new sign-ups.
boolean
Filter by whether the plan is starred (highlighted) on the members portal.
boolean
Filter by whether new sign-ups are kept on hold until manually approved.
boolean
Filter by whether members can pause their contract on this plan.
integer
Filter by maximum number of times a contract can be paused per year.
integer
Filter by maximum number of billing cycles a contract can be paused for.
integer
Filter by strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.
integer
Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth.
number
Filter by calculated total price at sign-up including the plan price and sign-up fee.
number
Filter by calculated total recurring price per billing cycle.
boolean
Filter by whether this is a virtual office plan with mail handling features.
boolean
Filter by whether to keep the contract on hold until all required identity checks are completed.
boolean
Filter by whether to request an address identity check from members signing up to this plan.
string
Filter by instructions shown to members when completing the address identity check.
integer
Filter by provider used for address identity checks: Manual or StripeIdentity.
boolean
Filter by whether to keep the contract paused if the address identity check reveals a mismatch.
integer
Filter by how often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
boolean
Filter by whether to request an identity (ID document) check from members signing up to this plan.
integer
Filter by provider used for identity checks: Manual or StripeIdentity.
integer
Filter by how often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
string
Filter by instructions shown to members when completing the identity check.
boolean
Filter by whether to request an AML check from members signing up to this plan.
boolean
Filter by whether to enable AML checks against the OpenSanctions dataset.
boolean
Filter by whether to enable AML checks against the Pappers dataset.
string
Filter by which OpenSanctions dataset to check against for AML screening (e.g. ‘default’).
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.
boolean
Filter by whether to email the onboarding form to new members signing up to this plan.
integer
Filter by iD of the onboarding form page sent to new members.
string
Filter by form page name.
integer
Filter by allowed handling preferences for mail deliveries (virtual office).
integer
Filter by allowed handling preferences for parcel deliveries (virtual office).
integer
Filter by allowed handling preferences for check deliveries (virtual office).
integer
Filter by allowed handling preferences for publicity deliveries (virtual office).
integer
Filter by allowed handling preferences for other deliveries (virtual office).
integer
Filter by maximum number of days deliveries are stored before being returned (virtual office).
integer
Filter by maximum number of company name aliases allowed for mail handling (virtual office).
integer
Filter by maximum number of mail recipients allowed (virtual office).
integer
Filter by maximum number of forwarding addresses allowed (virtual office).
boolean
Filter by whether to automatically transfer mail handling products to the member’s contract.
Range Filters
number
Filter by recurring price charged per billing cycle greater than or equal to this value.
number
Filter by recurring price charged per billing cycle less than or equal to this value.
integer
Filter by day of the month on which invoices are generated for members on this plan greater than or equal to this value.
integer
Filter by day of the month on which invoices are generated for members on this plan less than or equal to this value.
number
Filter by custom price shown to the AI assistant instead of the actual price greater than or equal to this value.
number
Filter by custom price shown to the AI assistant instead of the actual price less than or equal to this value.
number
Filter by one-off fee charged when a customer first signs up to this plan greater than or equal to this value.
number
Filter by one-off fee charged when a customer first signs up to this plan less than or equal to this value.
integer
Filter by number of days’ notice required before a contract can be cancelled greater than or equal to this value.
integer
Filter by number of days’ notice required before a contract can be cancelled less than or equal to this value.
integer
Filter by display order on the members portal (lower numbers appear first) greater than or equal to this value.
integer
Filter by display order on the members portal (lower numbers appear first) less than or equal to this value.
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.
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.
integer
Filter by minimum number of days a contract must be active before it can be cancelled greater than or equal to this value.
integer
Filter by minimum number of days a contract must be active before it can be cancelled less than or equal to this value.
integer
Filter by default minimum contract term in months for new sign-ups greater than or equal to this value.
integer
Filter by default minimum contract term in months for new sign-ups less than or equal to this value.
integer
Filter by number of days after contract cancellation before the member account is deactivated greater than or equal to this value.
integer
Filter by number of days after contract cancellation before the member account is deactivated less than or equal to this value.
integer
Filter by maximum number of check-ins included per billing cycle greater than or equal to this value.
integer
Filter by maximum number of check-ins included per billing cycle less than or equal to this value.
integer
Filter by maximum number of check-ins allowed per month greater than or equal to this value.
integer
Filter by maximum number of check-ins allowed per month less than or equal to this value.
integer
Filter by maximum number of check-ins allowed per week greater than or equal to this value.
integer
Filter by maximum number of check-ins allowed per week less than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per month greater than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per month less than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per week greater than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per week less than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per day greater than or equal to this value.
integer
Filter by maximum number of visitor passes allowed per day less than or equal to this value.
integer
Filter by maximum number of hours included per billing cycle greater than or equal to this value.
integer
Filter by maximum number of hours included per billing cycle less than or equal to this value.
integer
Filter by maximum number of hours allowed per month greater than or equal to this value.
integer
Filter by maximum number of hours allowed per month less than or equal to this value.
integer
Filter by maximum number of hours allowed per week greater than or equal to this value.
integer
Filter by maximum number of hours allowed per week less than or equal to this value.
integer
Filter by maximum booking minutes allowed per week greater than or equal to this value.
integer
Filter by maximum booking minutes allowed per week less than or equal to this value.
integer
Filter by maximum booking minutes allowed per month greater than or equal to this value.
integer
Filter by maximum booking minutes allowed per month less than or equal to this value.
number
Filter by discount percentage for extra services greater than or equal to this value.
number
Filter by discount percentage for extra services less than or equal to this value.
number
Filter by discount percentage for time passes greater than or equal to this value.
number
Filter by discount percentage for time passes less than or equal to this value.
number
Filter by discount percentage for charges greater than or equal to this value.
number
Filter by discount percentage for charges less than or equal to this value.
integer
Filter by billing cycle length in months. Set to 0 if billing by weeks instead greater than or equal to this value.
integer
Filter by billing cycle length in months. Set to 0 if billing by weeks instead less than or equal to this value.
integer
Filter by billing cycle length in weeks. Set to 0 if billing by months instead greater than or equal to this value.
integer
Filter by billing cycle length in weeks. Set to 0 if billing by months instead less than or equal to this value.
integer
Filter by number of days after which the contract is automatically cancelled if not paid greater than or equal to this value.
integer
Filter by number of days after which the contract is automatically cancelled if not paid less than or equal to this value.
integer
Filter by number of billing cycles to invoice in advance greater than or equal to this value.
integer
Filter by number of billing cycles to invoice in advance less than or equal to this value.
integer
Filter by day of the month used to align billing cycles when prorating greater than or equal to this value.
integer
Filter by day of the month used to align billing cycles when prorating less than or equal to this value.
integer
Filter by number of days before the prorate day to start prorating greater than or equal to this value.
integer
Filter by number of days before the prorate day to start prorating less than or equal to this value.
integer
Filter by number of days to extend a contract after payment is received greater than or equal to this value.
integer
Filter by number of days to extend a contract after payment is received less than or equal to this value.
integer
Filter by raise invoice every N months greater than or equal to this value.
integer
Filter by raise invoice every N months less than or equal to this value.
integer
Filter by raise invoice every N weeks greater than or equal to this value.
integer
Filter by raise invoice every N weeks less than or equal to this value.
number
Filter by minimum total amount charged per billing cycle regardless of usage greater than or equal to this value.
number
Filter by minimum total amount charged per billing cycle regardless of usage less than or equal to this value.
integer
Filter by maximum number of times a contract can be paused per year greater than or equal to this value.
integer
Filter by maximum number of times a contract can be paused per year less than or equal to this value.
integer
Filter by maximum number of billing cycles a contract can be paused for greater than or equal to this value.
integer
Filter by maximum number of billing cycles a contract can be paused for less than or equal to this value.
integer
Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth greater than or equal to this value.
integer
Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth less than or equal to this value.
number
Filter by calculated total price at sign-up including the plan price and sign-up fee greater than or equal to this value.
number
Filter by calculated total price at sign-up including the plan price and sign-up fee less than or equal to this value.
number
Filter by calculated total recurring price per billing cycle greater than or equal to this value.
number
Filter by calculated total recurring price per billing cycle less than or equal to this value.
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.
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.
integer
Filter by maximum number of days deliveries are stored before being returned (virtual office) greater than or equal to this value.
integer
Filter by maximum number of days deliveries are stored before being returned (virtual office) less than or equal to this value.
integer
Filter by maximum number of company name aliases allowed for mail handling (virtual office) greater than or equal to this value.
integer
Filter by maximum number of company name aliases allowed for mail handling (virtual office) less than or equal to this value.
integer
Filter by maximum number of mail recipients allowed (virtual office) greater than or equal to this value.
integer
Filter by maximum number of mail recipients allowed (virtual office) less than or equal to this value.
integer
Filter by maximum number of forwarding addresses allowed (virtual office) greater than or equal to this value.
integer
Filter by maximum number of forwarding addresses allowed (virtual office) less than or equal to this value.
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
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.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search Tariffs