Tariffs
Get one Tariff
Retrieve a single Tariff record by its Id.
GET
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.Path Parameters
The Id of the Tariff record to retrieve.
Code Examples
Response
200
Business Id.
Business name.
Tariff name.
System tariff type. See
eTariffType enum values: 1 = FullTimePrivateOffice, 2 = PartTimePrivateOffice, 3 = FullTimeDedicatedDesk, 4 = PartTimeDedicatedDesk, 5 = FullTimeHotDesk, 6 = PartTimeHotDesk, 7 = FullTimeOther, 8 = PartTimeOther, 9 = Storage, 10 = VirtualOffice, 11 = Virtual, 99 = Other.Price.
Default invoicing day.
Whether the tariff is visible.
Whether to use time passes.
Description.
Invoice line display text.
Sign-up fee.
Currency Id.
Currency code.
Tax Rate Id.
Reduced Tax Rate Id.
Exempt Tax Rate Id.
Financial Account Id.
Terms and conditions.
Contract Document File Name.
New Contract Document Url.
Clear Contract Document File.
Cancellation period in days.
Display order.
Group name.
Disable portal cancellations.
Subscribers limit.
Cancellation limit in days.
Default contract term in months.
Cancel member account after days.
Check-in price plan limit.
Check-in month limit.
Check-in week limit.
Visitor month limit.
Visitor week limit.
Visitor day limit.
Hours price plan limit.
Hours month limit.
Hours week limit.
Booking minute week limit.
Booking minute month limit.
Discount percentage for extra services.
Discount percentage for time passes.
Discount percentage for charges.
Invoice every N months.
Invoice every N weeks.
Auto cancel after days.
Advance invoice cycles.
Prorate day of month.
Prorate days before.
Prorate cancellations.
Charge and extend days.
Exclude From Invoice.
Auto raise invoices.
Raise invoice every N months.
Raise invoice every N weeks.
Minimum price.
Include time passes in minimum price.
Include extra services in minimum price.
Include events in minimum price.
Whether the tariff is archived.
Whether the tariff is starred.
Keep new accounts on hold.
Whether the tariff can be paused.
Pause yearly limit.
Pause cycles limit.
Booking due date strategy. See
eTariffBookingDueDateStrategy enum values: 1 = RenewalDate, 2 = BookingEndDate, 3 = BookingCreationDate, 4 = NextNthOfMonth.Booking due date day of month.
Total sign-up price.
Total price.
Whether this is a virtual office tariff.
Request address identity check.
Address identity check description.
Address identity check provider. See
eIdentityCheckProvider enum values: 1 = Manual, 2 = StripeIdentity.Keep paused if address mismatch.
Address identity check repeat pattern. See
eIdentityCheckRepeatPattern enum values: 1 = Never, 2 = Every3Months, 3 = Every6Months, 4 = Every12Months, 5 = Every24Months.Request identity check.
Identity check provider. See
eIdentityCheckProvider enum values: 1 = Manual, 2 = StripeIdentity.Identity check repeat pattern. See
eIdentityCheckRepeatPattern enum values: 1 = Never, 2 = Every3Months, 3 = Every6Months, 4 = Every12Months, 5 = Every24Months.Identity check description.
Send onboarding form by email.
Form Page Id.
Form page name.
Products Store.
Products Forward.
Products Recycle.
Products Shred.
Products Scan.
Products Return.
Products Deposit.
Products Collect.
Delivery preferences for mail.
Delivery preferences for parcels.
Delivery preferences for checks.
Delivery preferences for publicity.
Delivery preferences for other.
Maximum delivery storage days.
Maximum company aliases.
Maximum recipients.
Maximum addresses.
Transfer products to contract.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response