Tariffs
Get multiple Tariffs
Retrieve multiple Tariff records by their Ids in a single request.
GET
/
api
/
billing
/
tariffs
/
?id=[
{id1}
,
{id2}
,
{id3}
]
Get multiple Tariffs
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Fetch several Tariff records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.
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-Read role.Query Parameters
integer[]
required
A comma-separated list of Tariff Ids enclosed in square brackets, e.g.
[123,456,789].Code Examples
curl -X GET \
"https://spaces.nexudus.com/api/billing/tariffs/?id=[87654321,87654322,87654323]" \
-H "Authorization: Bearer YOUR_TOKEN"
const response = await fetch(
'https://spaces.nexudus.com/api/billing/tariffs/?id=[87654321,87654322,87654323]',
{
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
}
);
const records = await response.json();
import requests
response = requests.get(
'https://spaces.nexudus.com/api/billing/tariffs/',
params={
'id': '[87654321,87654322,87654323]'
},
headers={
'Authorization': 'Bearer YOUR_TOKEN'
}
)
records = response.json()
Response
200
Returns an array of Tariff records. Each record has the same structure as the response from the Get one Tariff endpoint.Partial records — This endpoint returns a summary representation of each Tariff. The following fields are not populated in the 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 this endpoint as the base for a PUT request, as missing fields may be unintentionally cleared.Example Response
[
{
"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
}
]
Was this page helpful?
⌘I
Get multiple Tariffs
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://spaces.nexudus.com/api/billing/tariffs/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));