Skip to main content
PUT
/
api
/
billing
/
tariffs
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing Tariff record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Enums

ValueName
1FullTimePrivateOffice
2PartTimePrivateOffice
3FullTimeDedicatedDesk
4PartTimeDedicatedDesk
5FullTimeHotDesk
6PartTimeHotDesk
7FullTimeOther
8PartTimeOther
9Storage
10VirtualOffice
11Virtual
99Other
ValueName
1RenewalDate
2BookingEndDate
3BookingCreationDate
4NextNthOfMonth
ValueName
1Manual
2StripeIdentity
ValueName
1Never
2Every3Months
3Every6Months
4Every12Months
5Every24Months

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the Tariff record to update.
​
BusinessId
integer
required
Business Id.
​
Name
string
required
Tariff name.
​
Price
number
required
Price.
​
CurrencyId
integer
required
Currency Id.
​
CancellationPeriod
integer
required
Cancellation period in days.
​
DisplayOrder
integer
required
Display order.
​
InvoiceEvery
integer
required
Invoice every N months.
​
InvoiceEveryWeeks
integer
required
Invoice every N weeks.

​
Optional Fields

​
SystemTariffType
integer
System tariff type. See eTariffType enum above.
​
DefaultInvoicingDay
integer
Default invoicing day.
​
Visible
boolean
Whether the tariff is visible.
​
UseTimePasses
boolean
Whether to use time passes.
​
Description
string
Description.
​
InvoiceLineDisplayAs
string
Invoice line display text.
​
SignUpFee
number
Sign-up fee.
​
TaxRateId
integer
Tax Rate Id.
​
ReducedTaxRateId
integer
Reduced Tax Rate Id.
​
ExemptTaxRateId
integer
Exempt Tax Rate Id.
​
FinancialAccountId
integer
Financial Account Id.
​
TermsAndConditions
string
Terms and conditions.
​
NewContractDocumentUrl
string
New Contract Document Url.
​
ClearContractDocumentFile
boolean
Clear Contract Document File.
​
GroupName
string
Group name.
​
DisablePortalCancellations
boolean
Disable portal cancellations.
​
SubscribersLimit
integer
Subscribers limit.
​
CancellationLimitDays
integer
Cancellation limit in days.
​
DefaultContractTerm
integer
Default contract term in months.
​
CancelMemeberAccountAfter
integer
Cancel member account after days.
​
CheckinPricePlanLimit
integer
Check-in price plan limit.
​
CheckinMonthLimit
integer
Check-in month limit.
​
CheckinWeekLimit
integer
Check-in week limit.
​
VisitorMonthLimit
integer
Visitor month limit.
​
VisitorWeekLimit
integer
Visitor week limit.
​
VisitorDayLimit
integer
Visitor day limit.
​
HoursPricePlanLimit
integer
Hours price plan limit.
​
HoursMonthLimit
integer
Hours month limit.
​
HoursWeekLimit
integer
Hours week limit.
​
BookingMinuteWeekLimit
integer
Booking minute week limit.
​
BookingMinuteMonthLimit
integer
Booking minute month limit.
​
DiscountExtraServices
number
Discount percentage for extra services.
​
DiscountTimePasses
number
Discount percentage for time passes.
​
DiscountCharges
number
Discount percentage for charges.
​
AutoCancelAfter
integer
Auto cancel after days.
​
AdvanceInvoiceCycles
integer
Advance invoice cycles.
​
ProrateDayOfMonth
integer
Prorate day of month.
​
ProrateDaysBefore
integer
Prorate days before.
​
ProrateCancellations
boolean
Prorate cancellations.
​
ChargeAndExtend
integer
Charge and extend days.
​
ExcludeFromInvoice
boolean
Exclude From Invoice.
​
AutoRaiseInvoices
boolean
Auto raise invoices.
​
RaiseInvoiceEvery
integer
Raise invoice every N months.
​
RaiseInvoiceEveryWeeks
integer
Raise invoice every N weeks.
​
MinimumPrice
number
Minimum price.
​
MinimumPriceIncludeTimePasses
boolean
Include time passes in minimum price.
​
MinimumPriceIncludeExtraServices
boolean
Include extra services in minimum price.
​
MinimumPriceIncludeEvents
boolean
Include events in minimum price.
​
Archived
boolean
Whether the tariff is archived.
​
Starred
boolean
Whether the tariff is starred.
​
KeepNewAccountsOnHold
boolean
Keep new accounts on hold.
​
CanBePaused
boolean
Whether the tariff can be paused.
​
PauseYearlyLimit
integer
Pause yearly limit.
​
PauseCyclesLimit
integer
Pause cycles limit.
​
BookingDueDateStrategy
integer
Booking due date strategy. See eTariffBookingDueDateStrategy enum above.
​
BookingDueDateDayOfMonth
integer
Booking due date day of month.
​
IsVirtualOffice
boolean
Whether this is a virtual office tariff.
​
RequestAddressIdentityCheck
boolean
Request address identity check.
​
AddressIdentityCheckDescription
string
Address identity check description.
​
AddressIdentityCheckProvider
integer
Address identity check provider. See eIdentityCheckProvider enum above.
​
KeepPausedIfAddressMismatch
boolean
Keep paused if address mismatch.
​
AddressIdentityCheckRepeatPattern
integer
Address identity check repeat pattern. See eIdentityCheckRepeatPattern enum above.
​
RequestIdentityCheck
boolean
Request identity check.
​
IdentityCheckProvider
integer
Identity check provider. See eIdentityCheckProvider enum above.
​
IdentityCheckRepeatPattern
integer
Identity check repeat pattern. See eIdentityCheckRepeatPattern enum above.
​
IdentityCheckDescription
string
Identity check description.
​
SendOnBoardingFormByEmail
boolean
Send onboarding form by email.
​
FormPageId
integer
Form Page Id.
​
ProductsStore
integer[]
Products Store.
​
AddedProductsStore
integer[]
Added Products Store.
​
RemovedProductsStore
integer[]
Removed Products Store.
​
ProductsForward
integer[]
Products Forward.
​
AddedProductsForward
integer[]
Added Products Forward.
​
RemovedProductsForward
integer[]
Removed Products Forward.
​
ProductsRecycle
integer[]
Products Recycle.
​
AddedProductsRecycle
integer[]
Added Products Recycle.
​
RemovedProductsRecycle
integer[]
Removed Products Recycle.
​
ProductsShred
integer[]
Products Shred.
​
AddedProductsShred
integer[]
Added Products Shred.
​
RemovedProductsShred
integer[]
Removed Products Shred.
​
ProductsScan
integer[]
Products Scan.
​
AddedProductsScan
integer[]
Added Products Scan.
​
RemovedProductsScan
integer[]
Removed Products Scan.
​
ProductsReturn
integer[]
Products Return.
​
AddedProductsReturn
integer[]
Added Products Return.
​
RemovedProductsReturn
integer[]
Removed Products Return.
​
ProductsDeposit
integer[]
Products Deposit.
​
AddedProductsDeposit
integer[]
Added Products Deposit.
​
RemovedProductsDeposit
integer[]
Removed Products Deposit.
​
ProductsCollect
integer[]
Products Collect.
​
AddedProductsCollect
integer[]
Added Products Collect.
​
RemovedProductsCollect
integer[]
Removed Products Collect.
​
DeliveryPreferencesMail
string
Delivery preferences for mail.
​
DeliveryPreferencesParcels
string
Delivery preferences for parcels.
​
DeliveryPreferencesChecks
string
Delivery preferences for checks.
​
DeliveryPreferencesPublicity
string
Delivery preferences for publicity.
​
DeliveryPreferencesOther
string
Delivery preferences for other.
​
MaximumDeliveryStorageDays
integer
Maximum delivery storage days.
​
MaximumCompanyAliases
integer
Maximum company aliases.
​
MaximumRecipients
integer
Maximum recipients.
​
MaximumAddresses
integer
Maximum addresses.
​
TransferProductsToContract
boolean
Transfer products to contract.

​
Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/tariffs" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Price": 0,
    "CurrencyId": 0,
    "CancellationPeriod": 0,
    "DisplayOrder": 0,
    "InvoiceEvery": 0,
    "InvoiceEveryWeeks": 0,
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the tariff was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Tariff was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}