Tariffs
Update Tariff
Update an existing Tariff record.
PUT
Update Tariff
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
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
Request Body
Required Fields
integer
required
The Id of the Tariff record to update.
integer
required
ID of the business linked to this record.
string
required
Plan name.
integer
required
Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.
number
required
Recurring price charged per billing cycle. Can be overriden per contract..
integer
required
ID of the currency linked to this record.
integer
required
Number of days’ notice required before a contract can be cancelled.
integer
required
Display order on the members portal (lower numbers appear first).
integer
required
Billing cycle length in months. Set to 0 if billing by weeks instead.
integer
required
Billing cycle length in weeks. Set to 0 if billing by months instead.
integer
required
Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.
integer
required
Provider used for address identity checks: Manual or StripeIdentity.
integer
required
How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
integer
required
Provider used for identity checks: Manual or StripeIdentity.
integer
required
How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
integer
required
Handling preferences customers on this plan can select for mail deliveries (virtual office). Only included values are visible to the customer..
integer
required
Handling preferences customers on this plan can select for parcel deliveries (virtual office). Only included values are visible to the customer..
integer
required
Handling preferences customers on this plan can select for check deliveries (virtual office). Only included values are visible to the customer..
integer
required
Handling preferences customers on this plan can select for publicity deliveries (virtual office). Only included values are visible to the customer..
integer
required
Handling preferences customers on this plan can select for other deliveries (virtual office). Only included values are visible to the customer..
Optional Fields
integer
Day of the month on which invoices are generated for members on this plan. Can be overriden per contract..
boolean
Whether the plan is visible to customers on the members portal and mobile app.
boolean
Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
string
Custom notes provided to the AI assistant when describing this plan.
boolean
Whether to show the plan price to the AI assistant.
number
Custom price shown to the AI assistant instead of the actual price.
boolean
Whether this plan uses time passes for check-in access.
string
Plan description shown to customers.
string
Custom text shown on the invoice line instead of the plan name.
number
Legacy field. Do not use. Use TariffSignupProducts instead..
integer
Standard tax rate applied to charges on this plan.
integer
Reduced tax rate applied when applicable.
integer
Tax-exempt rate applied when applicable.
integer
Financial account used for revenue tracking.
string
Terms and conditions text that members must accept when signing up.
string
URL to upload a new contract document template.
boolean
Set to true to remove the uploaded contract document file.
string
Group name used to visually group plans together on the members portal.
boolean
Prevents members from cancelling this plan through the members portal.
integer
Maximum number of members that can be signed up to this plan at any time.
integer
Number of days’ notice customers must give before they can cancel the contract.
integer
Default minimum contract term in months for new sign-ups.
integer
Number of days an invoice can be due before the customer’s account is automatically suspended (contracts are not cancelled).
integer
Maximum number of check-ins included per billing cycle.
integer
Maximum number of check-ins allowed per month.
integer
Maximum number of check-ins allowed per week.
integer
Maximum number of visitor passes allowed per month.
integer
Maximum number of visitor passes allowed per week.
integer
Maximum number of visitor passes allowed per day.
integer
Maximum number of hours included per billing cycle.
integer
Maximum number of hours allowed per month.
integer
Maximum number of hours allowed per week.
integer
Maximum booking minutes allowed per week.
integer
Maximum booking minutes allowed per month.
number
Discount percentage for extra services.
number
Discount percentage for time passes.
number
Discount percentage for charges.
integer
Number of billing cycles after which the contract is automatically cancelled.
integer
Number of billing cycles to invoice in advance.
integer
Day of the month used to align billing cycles when prorating.
integer
Number of days before the prorate day to start prorating.
boolean
Whether to prorate the final invoice when a contract is cancelled mid-cycle.
integer
Number of days to extend a contract after payment is received.
boolean
Whether to exclude this plan’s charges from member invoices.
boolean
Whether to automatically generate invoices at the end of each billing cycle.
integer
Raise invoice every N months.
integer
Raise invoice every N weeks.
number
Minimum total amount charged per billing cycle regardless of usage.
boolean
Whether time pass charges count towards the minimum price.
boolean
Whether extra service charges count towards the minimum price.
boolean
Whether event charges count towards the minimum price.
boolean
Whether the plan is archived and no longer available for new sign-ups.
boolean
Whether the plan is starred (highlighted) on the members portal.
boolean
Whether new sign-ups are kept on hold until manually approved.
boolean
Whether members can pause their contract on this plan. A paused member loses member status (no member-only access, policies, or pricing) but other charges besides the plan fee continue billing..
integer
Maximum number of times a contract can be paused per year.
integer
Maximum number of billing cycles a contract can be paused for.
integer
Day of the month used when BookingDueDateStrategy is NextNthOfMonth.
boolean
Whether this is a virtual office plan with mail handling features.
boolean
Whether to keep the contract on hold until all required identity checks are completed.
boolean
Whether to request an address identity check from members signing up to this plan.
string
Instructions shown to members when completing the address identity check.
boolean
Whether to keep the contract paused if the address identity check reveals a mismatch.
boolean
Whether to request an identity (ID document) check from members signing up to this plan.
string
Instructions shown to members when completing the identity check.
boolean
Whether to request an AML check from members signing up to this plan.
boolean
Whether to enable AML checks against the OpenSanctions dataset.
boolean
Whether to enable AML checks against the Pappers dataset.
string
Which OpenSanctions dataset to check against for AML screening (e.g. ‘default’).
number
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
Whether to email the onboarding form to new members signing up to this plan.
integer
ID of the onboarding form page sent to new members.
integer[]
Product IDs for mail stored for collection (virtual office).
integer[]
IDs added to the ProductsStore relationship..
integer[]
IDs removed from the ProductsStore relationship..
integer[]
Product IDs for mail forwarding (virtual office).
integer[]
IDs added to the ProductsForward relationship..
integer[]
IDs removed from the ProductsForward relationship..
integer[]
Product IDs for mail recycling (virtual office).
integer[]
IDs added to the ProductsRecycle relationship..
integer[]
IDs removed from the ProductsRecycle relationship..
integer[]
Product IDs for mail shredding (virtual office).
integer[]
IDs added to the ProductsShred relationship..
integer[]
IDs removed from the ProductsShred relationship..
integer[]
Product IDs for mail scanning (virtual office).
integer[]
IDs added to the ProductsScan relationship..
integer[]
IDs removed from the ProductsScan relationship..
integer[]
Product IDs for returning mail to sender (virtual office).
integer[]
IDs added to the ProductsReturn relationship..
integer[]
IDs removed from the ProductsReturn relationship..
integer[]
Product IDs for check deposits (virtual office).
integer[]
IDs added to the ProductsDeposit relationship..
integer[]
IDs removed from the ProductsDeposit relationship..
integer[]
Product IDs for mail collection (virtual office).
integer[]
IDs added to the ProductsCollect relationship..
integer[]
IDs removed from the ProductsCollect relationship..
integer
Maximum number of days deliveries are stored before being returned (virtual office).
integer
Maximum number of company name aliases allowed for mail handling (virtual office).
integer
Maximum number of mail recipients allowed (virtual office).
integer
Maximum number of forwarding addresses allowed (virtual office).
boolean
Whether to automatically transfer mail handling products to the member’s contract.
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the tariff was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response