Required roles
- Tariff-*
Learn more about Price Plans in our Knowledge Base.
Properties
Property | Type | Required | Information |
|---|---|---|---|
ActiveContracts | int | No | |
BusinessId | int | Yes | |
BusinessName | string | No | Read-only |
Name | string | Yes | |
Price | float | Yes | |
DefaultInvoicingDay | int | No | |
Visible | boolean | No | |
UseTimePasses | boolean | No | |
Description | string | No | |
InvoiceLineDisplayAs | string | No | |
SignUpFee | float | Yes | |
CurrencyId | int | Yes | |
CurrencyCode | string | No | Read-only |
TaxRateId | int | No | |
ReducedTaxRateId | int | No | |
ExemptTaxRateId | int | No | |
FinancialAccountId | int | No | |
TermsAndConditions | string | No | |
CancellationPeriod | int | No | |
DisplayOrder | int | No | |
GroupName | string | No | |
DisablePortalCancellations | boolean | No | |
SubscribersLimit | int | No | |
CancellationLimitDays | int | No | |
DefaultContractTerm | int | No | |
CancelMemeberAccountAfter | int | No | |
CheckinPricePlanLimit | int | No | |
CheckinMonthLimit | int | No | |
CheckinWeekLimit | int | No | |
VisitorMonthLimit | int | No | |
VisitorWeekLimit | int | No | |
VisitorDayLimit | int | No | |
HoursPricePlanLimit | int | No | |
HoursMonthLimit | int | No | |
HoursWeekLimit | int | No | |
BookingMinuteWeekLimit | int | No | |
BookingMinuteMonthLimit | int | No | |
DiscountExtraServices | float | No | |
DiscountTimePasses | float | No | |
DiscountCharges | float | No | |
InvoiceEvery | int | No | |
InvoiceEveryWeeks | int | No | |
AutoCancelAfter | int | No | |
AdvanceInvoiceCycles | int | No | |
ProrateDayOfMonth | int | No | |
ProrateDaysBefore | int | No | |
ProrateCancellations | boolean | No | |
ChargeAndExtend | int | No | |
AutoRaiseInvoices | boolean | No | |
RaiseInvoiceEvery | int | No | |
RaiseInvoiceEveryWeeks | int | No | |
MinimumPrice | float | Yes | |
MinimumPriceIncludeTimePasses | boolean | No | |
MinimumPriceIncludeExtraServices | boolean | No | |
MinimumPriceIncludeEvents | boolean | No | |
Archived | boolean | No | |
Starred | boolean | No | |
KeepNewAccountsOnHold | boolean | No | |
BookingDueDateStrategy | enum | No | |
TotalSignUpPrice | float | No | |
TotalPrice | float | No | |
IsVirtualOffice | boolean | No | |
RequestAddressIdentityCheck | boolean | No | |
AddressIdentityCheckDescription | string | No | |
AddressIdentityCheckProvider | enum | No | |
KeepPausedIfAddressMismatch | boolean | No | |
AddressIdentityCheckRepeatPattern | enum | No | |
RequestIdentityCheck | boolean | No | |
IdentityCheckProvider | enum | No | |
IdentityCheckRepeatPattern | enum | No | |
IdentityCheckDescription | string | No | |
SendOnBoardingFormByEmail | boolean | No | |
FormPageId | int | No | |
FormPageName | string | No | Read-only |
ProductsStore | array_int | No | |
ProductsForward | array_int | No | |
ProductsRecycle | array_int | No | |
ProductsShred | array_int | No | |
ProductsScan | array_int | No | |
ProductsReturn | array_int | No | |
ProductsDeposit | array_int | No | |
ProductsCollect | array_int | No | |
MaximumDeliveryStorageDays | int | No | |
MaximumCompanyAliases | int | No | |
MaximumRecipients | int | No | |
MaximumAddresses | int | No | |
ContractDocumentFileName | string | No | |
Id | int | Yes | Read-only |
UpdatedOn | timestamp | No | Read-only |
CreatedOn | timestamp | No | Read-only |
UniqueId | string | No | Read-only |
SystemId | string | No |