> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search Tariffs > Search and list Tariff records with filtering, sorting, and pagination. ## 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 | 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 | | Value | Name | | ----- | ------------------- | | 1 | RenewalDate | | 2 | BookingEndDate | | 3 | BookingCreationDate | | 4 | NextNthOfMonth | | Value | Name | | ----- | -------------- | | 1 | Manual | | 2 | StripeIdentity | | Value | Name | | ----- | ------------- | | 1 | Never | | 2 | Every3Months | | 3 | Every6Months | | 4 | Every12Months | | 5 | Every24Months | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Business Id. Filter by business name. Filter by tariff name. Filter by system tariff type. Filter by price. Filter by default invoicing day. Filter by whether the tariff is visible. Filter by whether to use time passes. Filter by description. Filter by invoice line display text. Filter by sign-up fee. Filter by Currency Id. Filter by currency code. Filter by Tax Rate Id. Filter by Reduced Tax Rate Id. Filter by Exempt Tax Rate Id. Filter by Financial Account Id. Filter by terms and conditions. Filter by Contract Document File Name. Filter by New Contract Document Url. Filter by Clear Contract Document File. Filter by cancellation period in days. Filter by display order. Filter by group name. Filter by disable portal cancellations. Filter by subscribers limit. Filter by cancellation limit in days. Filter by default contract term in months. Filter by cancel member account after days. Filter by check-in price plan limit. Filter by check-in month limit. Filter by check-in week limit. Filter by visitor month limit. Filter by visitor week limit. Filter by visitor day limit. Filter by hours price plan limit. Filter by hours month limit. Filter by hours week limit. Filter by booking minute week limit. Filter by booking minute month limit. Filter by discount percentage for extra services. Filter by discount percentage for time passes. Filter by discount percentage for charges. Filter by invoice every N months. Filter by invoice every N weeks. Filter by auto cancel after days. Filter by advance invoice cycles. Filter by prorate day of month. Filter by prorate days before. Filter by prorate cancellations. Filter by charge and extend days. Filter by Exclude From Invoice. Filter by auto raise invoices. Filter by raise invoice every N months. Filter by raise invoice every N weeks. Filter by minimum price. Filter by include time passes in minimum price. Filter by include extra services in minimum price. Filter by include events in minimum price. Filter by whether the tariff is archived. Filter by whether the tariff is starred. Filter by keep new accounts on hold. Filter by whether the tariff can be paused. Filter by pause yearly limit. Filter by pause cycles limit. Filter by booking due date strategy. Filter by booking due date day of month. Filter by total sign-up price. Filter by total price. Filter by whether this is a virtual office tariff. Filter by request address identity check. Filter by address identity check description. Filter by address identity check provider. Filter by keep paused if address mismatch. Filter by address identity check repeat pattern. Filter by request identity check. Filter by identity check provider. Filter by identity check repeat pattern. Filter by identity check description. Filter by send onboarding form by email. Filter by Form Page Id. Filter by form page name. Filter by delivery preferences for mail. Filter by delivery preferences for parcels. Filter by delivery preferences for checks. Filter by delivery preferences for publicity. Filter by delivery preferences for other. Filter by maximum delivery storage days. Filter by maximum company aliases. Filter by maximum recipients. Filter by maximum addresses. Filter by transfer products to contract. ### Range Filters Filter by price greater than or equal to this value. Filter by price less than or equal to this value. Filter by default invoicing day greater than or equal to this value. 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. Filter by cancellation period in days greater than or equal to this value. Filter by cancellation period in days less than or equal to this value. Filter by display order greater than or equal to this value. Filter by display order less than or equal to this value. Filter by subscribers limit greater than or equal to this value. Filter by subscribers limit less than or equal to this value. Filter by cancellation limit in days greater than or equal to this value. Filter by cancellation limit in days less than or equal to this value. Filter by default contract term in months greater than or equal to this value. Filter by default contract term in months less than or equal to this value. Filter by cancel member account after days greater than or equal to this value. Filter by cancel member account after days less than or equal to this value. Filter by check-in price plan limit greater than or equal to this value. Filter by check-in price plan limit less than or equal to this value. Filter by check-in month limit greater than or equal to this value. Filter by check-in month limit less than or equal to this value. Filter by check-in week limit greater than or equal to this value. Filter by check-in week limit less than or equal to this value. Filter by visitor month limit greater than or equal to this value. Filter by visitor month limit less than or equal to this value. Filter by visitor week limit greater than or equal to this value. Filter by visitor week limit less than or equal to this value. Filter by visitor day limit greater than or equal to this value. Filter by visitor day limit less than or equal to this value. Filter by hours price plan limit greater than or equal to this value. Filter by hours price plan limit less than or equal to this value. Filter by hours month limit greater than or equal to this value. Filter by hours month limit less than or equal to this value. Filter by hours week limit greater than or equal to this value. Filter by hours week limit less than or equal to this value. Filter by booking minute week limit greater than or equal to this value. Filter by booking minute week limit less than or equal to this value. Filter by booking minute month limit greater than or equal to this value. Filter by booking minute month limit less than or equal to this value. Filter by discount percentage for extra services greater than or equal to this value. Filter by discount percentage for extra services less than or equal to this value. Filter by discount percentage for time passes greater than or equal to this value. Filter by discount percentage for time passes less than or equal to this value. Filter by discount percentage for charges greater than or equal to this value. Filter by discount percentage for charges less than or equal to this value. Filter by invoice every N months greater than or equal to this value. Filter by invoice every N months less than or equal to this value. Filter by invoice every N weeks greater than or equal to this value. Filter by invoice every N weeks less than or equal to this value. Filter by auto cancel after days greater than or equal to this value. Filter by auto cancel after days less than or equal to this value. Filter by advance invoice cycles greater than or equal to this value. Filter by advance invoice cycles less than or equal to this value. Filter by prorate day of month greater than or equal to this value. Filter by prorate day of month less than or equal to this value. Filter by prorate days before greater than or equal to this value. Filter by prorate days before less than or equal to this value. Filter by charge and extend days greater than or equal to this value. Filter by charge and extend days less than or equal to this value. Filter by raise invoice every N months greater than or equal to this value. Filter by raise invoice every N months less than or equal to this value. Filter by raise invoice every N weeks greater than or equal to this value. Filter by raise invoice every N weeks less than or equal to this value. Filter by minimum price greater than or equal to this value. Filter by minimum price less than or equal to this value. Filter by pause yearly limit greater than or equal to this value. Filter by pause yearly limit less than or equal to this value. Filter by pause cycles limit greater than or equal to this value. Filter by pause cycles limit less than or equal to this value. Filter by booking due date day of month greater than or equal to this value. 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. Filter by total price greater than or equal to this value. Filter by total price less than or equal to this value. Filter by maximum delivery storage days greater than or equal to this value. Filter by maximum delivery storage days less than or equal to this value. Filter by maximum company aliases greater than or equal to this value. Filter by maximum company aliases less than or equal to this value. Filter by maximum recipients greater than or equal to this value. Filter by maximum recipients less than or equal to this value. Filter by maximum addresses greater than or equal to this value. Filter by maximum addresses less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/tariffs?page=1&size=15&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({ page: 1, size: 15, orderBy: 'Name', dir: 1 // Ascending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/tariffs', params={ 'page': 1, 'size': 15, 'orderBy': 'Name', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Filtering by Name ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/tariffs?Tariff_Name=example-value&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({ Tariff_Name: 'example-value', orderBy: 'Name', dir: 1 }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/tariffs', params={ 'Tariff_Name': 'example-value', 'orderBy': 'Name', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Range filters ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({ from_Tariff_UpdatedOn: '2025-01-01T00:00', to_Tariff_UpdatedOn: '2025-12-31T23:59', orderBy: 'UpdatedOn', dir: 1 // Descending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/tariffs', params={ 'from_Tariff_UpdatedOn': '2025-01-01T00:00', 'to_Tariff_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of Tariff records matching the query. See the [Get one Tariff](/rest-api/billing/get-tariffs-by-id) 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](/rest-api/billing/get-tariffs-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "BusinessId": 0, "BusinessName": null, "Name": "", "SystemTariffType": 0, "Price": 0, "DefaultInvoicingDay": null, "Visible": false, "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, "RequestAddressIdentityCheck": false, "AddressIdentityCheckProvider": 0, "KeepPausedIfAddressMismatch": false, "AddressIdentityCheckRepeatPattern": 0, "RequestIdentityCheck": false, "IdentityCheckProvider": 0, "IdentityCheckRepeatPattern": 0, "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 } ```