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
| 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 |
eTariffBookingDueDateStrategy — BookingDueDateStrategy values
eTariffBookingDueDateStrategy — BookingDueDateStrategy values
| Value | Name |
|---|---|
| 1 | RenewalDate |
| 2 | BookingEndDate |
| 3 | BookingCreationDate |
| 4 | NextNthOfMonth |
eIdentityCheckProvider — AddressIdentityCheckProvider values
eIdentityCheckProvider — AddressIdentityCheckProvider values
| Value | Name |
|---|---|
| 1 | Manual |
| 2 | StripeIdentity |
eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values
eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values
| Value | Name |
|---|---|
| 1 | Never |
| 2 | Every3Months |
| 3 | Every6Months |
| 4 | Every12Months |
| 5 | Every24Months |
eDeliveryHandlingPreference
eDeliveryHandlingPreference
| Value | Name |
|---|---|
| 1 | StoreForCollection |
| 2 | Forward |
| 3 | OpenScanForward |
| 4 | OpenScanRecycle |
| 5 | OpenScanShred |
| 6 | OpenScanStoreForCollection |
| 7 | Recycle |
| 8 | ReturnToSender |
| 9 | Shred |
| 10 | DepositCheck |
| 11 | Unknown |
Request Body
Required Fields
The Id of the Tariff record to update.
ID of the business linked to this record.
Plan name.
Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.
Recurring price charged per billing cycle.
ID of the currency linked to this record.
Number of days’ notice required before a contract can be cancelled.
Display order on the members portal (lower numbers appear first).
Billing cycle length in months. Set to 0 if billing by weeks instead.
Billing cycle length in weeks. Set to 0 if billing by months instead.
Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.
Provider used for address identity checks: Manual or StripeIdentity.
How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
Provider used for identity checks: Manual or StripeIdentity.
How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
Allowed handling preferences for mail deliveries (virtual office).
Allowed handling preferences for parcel deliveries (virtual office).
Allowed handling preferences for check deliveries (virtual office).
Allowed handling preferences for publicity deliveries (virtual office).
Allowed handling preferences for other deliveries (virtual office).
Optional Fields
Day of the month on which invoices are generated for members on this plan.
Whether the plan is visible to customers on the members portal and mobile app.
Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
Custom notes provided to the AI assistant when describing this plan.
Whether to show the plan price to the AI assistant.
Custom price shown to the AI assistant instead of the actual price.
Whether this plan uses time passes for check-in access.
Plan description shown to customers.
Custom text shown on the invoice line instead of the plan name.
One-off fee charged when a customer first signs up to this plan.
Standard tax rate applied to charges on this plan.
Reduced tax rate applied when applicable.
Tax-exempt rate applied when applicable.
Financial account used for revenue tracking.
Terms and conditions text that members must accept when signing up.
URL to upload a new contract document template.
Set to true to remove the uploaded contract document file.
Group name used to visually group plans together on the members portal.
Prevents members from cancelling this plan through the members portal.
Maximum number of members that can be signed up to this plan at any time.
Minimum number of days a contract must be active before it can be cancelled.
Default minimum contract term in months for new sign-ups.
Number of days after contract cancellation before the member account is deactivated.
Maximum number of check-ins included per billing cycle.
Maximum number of check-ins allowed per month.
Maximum number of check-ins allowed per week.
Maximum number of visitor passes allowed per month.
Maximum number of visitor passes allowed per week.
Maximum number of visitor passes allowed per day.
Maximum number of hours included per billing cycle.
Maximum number of hours allowed per month.
Maximum number of hours allowed per week.
Maximum booking minutes allowed per week.
Maximum booking minutes allowed per month.
Discount percentage for extra services.
Discount percentage for time passes.
Discount percentage for charges.
Number of days after which the contract is automatically cancelled if not paid.
Number of billing cycles to invoice in advance.
Day of the month used to align billing cycles when prorating.
Number of days before the prorate day to start prorating.
Whether to prorate the final invoice when a contract is cancelled mid-cycle.
Number of days to extend a contract after payment is received.
Whether to exclude this plan’s charges from member invoices.
Whether to automatically generate invoices at the end of each billing cycle.
Raise invoice every N months.
Raise invoice every N weeks.
Minimum total amount charged per billing cycle regardless of usage.
Whether time pass charges count towards the minimum price.
Whether extra service charges count towards the minimum price.
Whether event charges count towards the minimum price.
Whether the plan is archived and no longer available for new sign-ups.
Whether the plan is starred (highlighted) on the members portal.
Whether new sign-ups are kept on hold until manually approved.
Whether members can pause their contract on this plan.
Maximum number of times a contract can be paused per year.
Maximum number of billing cycles a contract can be paused for.
Day of the month used when BookingDueDateStrategy is NextNthOfMonth.
Whether this is a virtual office plan with mail handling features.
Whether to keep the contract on hold until all required identity checks are completed.
Whether to request an address identity check from members signing up to this plan.
Instructions shown to members when completing the address identity check.
Whether to keep the contract paused if the address identity check reveals a mismatch.
Whether to request an identity (ID document) check from members signing up to this plan.
Instructions shown to members when completing the identity check.
Whether to request an AML check from members signing up to this plan.
Whether to enable AML checks against the OpenSanctions dataset.
Whether to enable AML checks against the Pappers dataset.
Which OpenSanctions dataset to check against for AML screening (e.g. ‘default’).
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.
Whether to email the onboarding form to new members signing up to this plan.
ID of the onboarding form page sent to new members.
Product IDs for mail stored for collection (virtual office).
The added products store value for this tariff.
The removed products store value for this tariff.
Product IDs for mail forwarding (virtual office).
The added products forward value for this tariff.
The removed products forward value for this tariff.
Product IDs for mail recycling (virtual office).
The added products recycle value for this tariff.
The removed products recycle value for this tariff.
Product IDs for mail shredding (virtual office).
The added products shred value for this tariff.
The removed products shred value for this tariff.
Product IDs for mail scanning (virtual office).
The added products scan value for this tariff.
The removed products scan value for this tariff.
Product IDs for returning mail to sender (virtual office).
The added products return value for this tariff.
The removed products return value for this tariff.
Product IDs for check deposits (virtual office).
The added products deposit value for this tariff.
The removed products deposit value for this tariff.
Product IDs for mail collection (virtual office).
The added products collect value for this tariff.
The removed products collect value for this tariff.
Maximum number of days deliveries are stored before being returned (virtual office).
Maximum number of company name aliases allowed for mail handling (virtual office).
Maximum number of mail recipients allowed (virtual office).
Maximum number of forwarding addresses allowed (virtual office).
Whether to automatically transfer mail handling products to the member’s contract.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the tariff was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update Tariff