Booking Activity and Quote Retrieval API

URL Query Parameters:

• bookingId unique-identifier required

  bookingId refers to an activity ID of the specific booking.

Response Payload:

• succeeded boolean

  Indicates whether the request to retrieve tenant activity and quotes for storage boxes was successful. It is a boolean value where true denotes success, and false indicates failure.

• status string

  Describes the status of the request to retrieve tenant activity and quotes. It is a string providing additional information about the status.

• data object | null

  Upon success, this property contains detailed information about booking activity and quotes for requested storage boxes, including selected add-ons such as insurance, service, merchandise items, and applicable discounts. The quote is available in two variations: for the prorated period from the move-in date to the last invoice cycle and for a complete invoice cycle. The primary details encompass tenant information, property details, and storage box specifics, providing a quick overview for booking inquiries. If the operation is not successful, the value is null.

• errors array

  Holds error information if applicable. It is an array containing error details in case there are issues with retrieving tenant activity and quotes.

object: data

• id unique-identifier

  Unique identifier for the booking transaction.

• transactId string

  Transaction ID associated with the booking.

• transactDate object

  Transaction date with both raw and localized values (see date and formattedDate).

• moveInDate object

  Move-in date with both raw and localized values (see date and formattedDate).

• client object

  Client details (refer to Client Details section).

• spaceInfo object

  Allocated/held space details (e.g., slot spaceDisplayId), used for the 15-minute hold during booking.

• subscription object

  Full-cycle quote view including rent and applied discounts (same structure as Billing Subscription).

• billingSubscription object

  Billing subscription details (refer to Billing Subscription Details section).

• proRataSubscription object

  Prorated subscription details from move-in to cycle end (refer to Pro-Rata Subscription section).

• discount object

  Discount rule metadata applied to this activity (percentage/amount, recurrence, lifetime, occurrences).

• business object

  Business information, including name and support contacts.

• property object

  Property details (refer to Property Details section).

• storage object

  Storage type details, including ID and name.

• storageCategory object

  Category classification for the storage (e.g., “Box”).

• storageSize object

  Storage size details, including size object, metrics, and dimensions.

• paymentPeriod object

  Selected payment period for this quote (e.g., Monthly/WEEKLY equivalent), with duration and enum value.

• isDocumentSigned boolean

  Indicates whether the client has completed the contract signing process.

• documentList array | null

  List of generated/identity documents available for preview; null if none.

• mandate object | null

  Payment mandate details when available; otherwise null.

• configuration object | null

  Additional configuration for the booking flow; null if not set.

• propertySizePriceData object | null

  Optional size/price matrix for the property; null in this response.

• rental object | null

  Rental agreement details when present; null if not created yet.

• businessBankDetailsInfo object

  Banking information for payments (bank name, IBAN, BIC, etc.).

• spacePrice object

  Price comparison for the allocated space: standardPrice vs discountedPrice (each includes taxable, tax, and payable amounts).

Space Price

object: data.spacePrice

• standardPrice object

  Undiscounted price: objects taxablePrice, taxPrice, payablePrice (each has price and formattedPrice).

• discountedPrice object

  Price after discounts: same three objects and fields as above.

Storage & Size Details

Information about the selected storage type, its category, and the unit’s physical dimensions.

object: data.storage

• id unique-identifier

  Unique identifier for the storage type.

• name string

  Display name of the storage type (e.g., “Box Storage”).

object: data.storageCategory

• id unique-identifier

  Identifier of the storage category.

• name string

  Category label (e.g., “Box”).

object: data.storageSize

• size object

  Overall size value of the unit. The object provides a numeric value and its localized display string (fields: number, formattedNumber).

• scaleMetrics string

  Unit symbol for dimensions (e.g., "m" for meters).

• defaultSizeMetrics string

  How the size is interpreted: AREA or VOLUME.

• length object

  Length dimension of the unit. The object contains a numeric value and a localized string (fields: number, formattedNumber).

• width object

  Width dimension of the unit. The object contains a numeric value and a localized string (fields: number, formattedNumber).

• height object

  Height dimension of the unit. The object contains a numeric value and a localized string (fields: number, formattedNumber).

• notes null | string

  Optional notes or clarifications regarding the size; null if none.

• assumedVolume null | number

  Precomputed volume when applicable; null if not calculated.

Discount Details

Rule-level metadata for the discount applied to this activity (separate from the line item that appears inside each subscription view).

object: data.discount

• id unique-identifier

  Unique identifier of the discount rule.

• discountPropertyInfoId unique-identifier

  Identifier of the property-level discount configuration linked to this rule.

• name string

  Display name of the discount.

• isPercentage boolean

  Indicates whether the discount is percentage-based. If true, use discountPercentage; otherwise discountAmount is used.

• discountPercentage object

  Percentage details when the discount is percentage-based. The object carries the numeric percentage and a localized display string.

• discountAmount object | null

  Flat discount amount when the discount is amount-based; otherwise null. The object provides a numeric amount and a localized display string.

• category string

  Optional category/code for internal grouping or eligibility rules (empty when not set).

• isLifeTimeValidity boolean

  Whether the discount has no fixed end date (lifetime validity).

• expiration null | string (date)

  Expiration date of the discount, or null if not applicable.

• isRecurring boolean

  Indicates whether the discount repeats across billing cycles.

• isLifeTimeRecurring boolean

  If true, the recurring discount has no cap on the number of occurrences.

• occurrenceCount integer

  Maximum number of cycles the recurring discount applies to (ignored when lifetime recurring).

• recurringMode string

  Recurrence strategy. Example: PERIOD — apply per billing period.

Business Details

Information about the operating business responsible for this booking.

object: data.business

• id unique-identifier

  Unique identifier for the business.

• name string

  Registered/brand name of the business.

• emailId string (email)

  Primary support/contact email address.

• contactNumber string

  Primary support/contact phone number (may include country code).

Client Details

Details about the tenant or client, providing comprehensive information about their identity and contact details.

object: data.client

• id unique-identifier

  Tenant ID.

• contactBookInfoId unique-identifier | null

  Identifier of the linked contact in the address book/CRM, or null if none.

• name string

  Full name of the tenant.

• email string

  Email address of the tenant.

• phoneNumber string

  Phone number for the tenant. May include country dialing code.

• address string

  Street address of the tenant.

• city string

  City of residence for the tenant.

• region integer

  Region/State/Province identifier if applicable; defaults to 0 when not set.

• postalCode string

  Postal code of the tenant's location.

• country object

  Client’s country information.

object: data.client.country

• id integer

  Country ID.

• name string

  Country name.

• isoCode2 string

  ISO 3166-1 alpha-2 code (e.g., FR).

• isoCode3 string

  ISO 3166-1 alpha-3 code (e.g., FRA).

• currencyCode string

  Currency code for the country (e.g., EUR).

• dialingCode integer

  International dialing code; may be 0 if not set.

Subscriptions (Preview, Billing & Prorated)

This endpoint returns three subscription views of the quote for the selected space and period: subscription (the live preview of the current booking activity), billingSubscription (full billing cycle with active discounts), and proRataSubscription (from move-in date to the end of the current cycle). Each view provides price totals, line items (rent, discounts, and optional add-ons), and a transaction summary. Calculations follow the chosen paymentPeriod.

object: data.subscription, data.billingSubscription and data.proRataSubscription

• startDate string

  Subscription start date (e.g., "08-09-2025").

• endDate string

  Subscription end date for the priced period.

• taxUserType object | null

  Applied tax regime determined by the user type; null when the default tax rules apply.

• nonTaxableAmount object

  Price details for the non-taxable portion (numeric and localized display values).

• taxableAmount object

  Price details for the taxable portion.

• taxAmount object

  Total tax computed for the subscription period.

• netAmount object

  Net amount payable after tax and discounts.

• grossAmount object

  Gross amount (same as net for VAT-inclusive pricing).

• rent object

  Base rent line item (ID, name/description, tax percentage, period, recurrence, quantity, and price breakdown).

• securityDeposit object | null

  Security deposit line item when applicable; otherwise null.

• adminFee object | null

  Administration/processing fee when applicable; otherwise null.

• discount object | null

  Applied discount (percentage or fixed), including period, recurrence and price breakdown; null if none.

• insurance object | null

  Insurance line item and price details when selected; null if not applicable.

• service object | null

  Additional service line item(s) and pricing; null if none.

• merchandise array | null

  Merchandise items added to the quote, or null when not present.

• transactData array

  Flattened summary of priced items for this subscription view (see Transaction Item Details for the item schema).

Transaction Item Details

Details about the items used to compute a quote. Each item is typed (e.g., RENT, RENT_DISCOUNT) and carries its own price breakdown.

array: data.subscription.transactData, data.billingSubscription.transactData and data.proRataSubscription.transactData

• name string

  Line-item name.

• description string

  Human-readable description (includes duration where applicable).

• category string

  Item category (e.g., RENT, RENT_DISCOUNT).

• nonTaxableAmount object | null

  Non-taxable part of the line item, or null.

• taxableAmount object

  Taxable part of the line item.

• taxPercentage object

  Applied tax rate (numeric and formatted).

• taxAmount object

  Computed tax for the line item.

• netAmount object

  Net amount for the line item.

• grossAmount object

  Gross amount for the line item.

Property Details

Details about the property, including property name, address, city, latitude, longitude, postal code, country, and contact number.

object: data.property

• id unique-identifier

  Unique identifier for the property.

• name string

  Name of the property.

• identifier string (slug)

  SEO-friendly identifier used in URLs/routing (e.g., toulouse-est).

• brandName null | string

  Brand label for the property if multiple brands are operated.

• displayName string

  Customer-facing name used in UI and communications.

• emailId string (email)

  Primary email contact for this property.

• contactNumber string

  Primary phone number for the property.

• address string

  Street address of the property.

• city string

  City where the property is located.

• region object

  Administrative area of the property. Contains id and name (e.g., “North Rhine-Westphalia”).

• country object

  Country metadata containing id, name, isoCode2, isoCode3, currencyCode, and dialingCode (some values may be null).

• countryISOCode2 string

  Two-letter ISO code for the country (e.g., “DE”).

• latitude number

  Latitude of the property.

• longitude number

  Longitude of the property.

• postalCode string

  Postal/ZIP code of the property.

• officeHours string

  Formatted office hours text displayed to customers.

• accessHours string

  Formatted tenant access hours (e.g., 7/7 access window).

• googlePlaceId null | string

  Google Place ID for the property location, if available.

• rentStartsOn null | string (date)

  Earliest date from which rentals can commence at this property; null when not constrained or unspecified.

• propertyImageList null | array

  Collection of property images; null when not available.

• propertyOfficeOpeningHoursInfoList array

  Structured office hours by day (see Property Working Hours for schema and notes).

• paymentPeriod array

  Available billing cycle options (see Payment Period Options for schema).

• additionalData object

  Additional computed/display data such as the lowest rent and available storage types (see Additional Property Data for schema).

Property Working Hours

Day-wise office schedule including closures and one/two time slots.

array data.property.propertyOfficeOpeningHoursInfoList

• dayOfWeek integer

  0=Sunday … 6=Saturday; -1 denotes public holidays.

• week null | string

  Localized weekday label (French in this payload); may be null for holidays.

• firstTimeSlot null | string

  First opening range (e.g., “08:00 To 19:00”), or null if not applicable.

• secondTimeSlot null | string

  Second opening range, or null if not applicable.

• isClosed boolean

  Whether the property is closed on this day.

Payment Period Options

Billing cycles supported by this property (e.g., Monthly, Quarterly). The canonical code reflects the underlying cadence.

array data.property.paymentPeriod

• id unique-identifier

  Unique ID of the payment period option.

• name string

  Display label (e.g., “Monthly”, “Quarterly”).

• duration integer (months)

  Number of months in the cycle (e.g., 1, 3, 5, 12).

• paymentPeriod string

  Canonical code for the cadence (e.g., MONTHLY; may also be WEEKLY where supported).

Additional Property Data

Helper fields for display and quick filtering such as the lowest available rent and supported storage types.

object: data.property.additionalData

• minimumSize null | number

  Smallest advertised unit size for this property, if available.

• maximumSize null | number

  Largest advertised unit size for this property, if available.

• rentStartsFrom object

  Lowest rent available at this property, provided as a raw numeric amount and a localized display string.

• storage array

  Supported storage types at this property.

object: data.property.additionalData.storage[]

• id unique-identifier

  Storage type identifier.

• name string

  Internal name (e.g., “Box”).

• displayName string

  Customer-facing label (e.g., “Box Storage”).

• property null | object

  Optional nested property info (not populated in this response).

Business Bank Details

Bank account information used for payouts and customer payments.

object: data.businessBankDetailsInfo

• id unique-identifier

  Unique identifier of this bank details record.

• bankName string

  Name of the French bank (e.g., “BNP Paribas”, “Société Générale”).

• iban string

  IBAN used for bank transfers. Example (France): FR76 3000 6000 0112 3456 7890 189.

• branchCode string

  Branch identifier (code guichet). Example: 30004.

• bicCode string

  BIC/SWIFT code for the bank. Examples: BNPAFRPP, SOGEFRPPXXX.

Space Price

Price comparison for the selected space. The API returns two views: standardPrice (rack/base price) and discountedPrice (after active discounts). Each price field is a Price object that carries a numeric amount and a localized display string (currency & separators), e.g., 74,10 €.

object: data.spacePrice

• standardPrice object

  Rack/base price without discounts.

  • taxablePrice Price

    Taxable portion of the price (numeric amount + localized display).

  • taxPrice Price

    Calculated tax amount (numeric amount + localized display).

  • payablePrice Price

    Total amount due for this view (taxable + tax), provided as numeric and localized display.

• discountedPrice object

  Price after applying the current discount(s).

  • taxablePrice Price

    Discount-adjusted taxable amount (numeric + localized display).

  • taxPrice Price

    Tax computed on the discounted taxable amount (numeric + localized display).

  • payablePrice Price

    Total due after discounts (numeric + localized display).

Storage Details

Information about the storage, including storage box ID and name.

object: data.storage

• id unique-identifier

  Unique identifier for the storage box.

• name string

  Name of the storage box.

Storage Size Details

Details about the size of the storage box, including size, scale metrics, default size metrics, length, width, and height.

object: data.storageSize

• size float

  Size of the storage in specified metrics (e.g., 2.5).

• scaleMetrics string

  Scale metrics used for the size (e.g., "m" for meters).

• defaultSizeMetrics string

  Default size metrics for the storage (e.g., "AREA", "VOLUME").

• length float

  Length dimension of the storage box.

• width float

  Width dimension of the storage box.

• height float

  Height dimension of the storage box.

Document Signing Status

Indicates whether the client (Prospective Tenant) has completed the contract signing process.

boolean: data.isDocumentSigned

• isDocumentSigned boolean

  Indicates whether the document signing process is completed by the client.

Document List

List of documents available for the booking, including pre-filled documents generated without signature binding after the completion of the signing process during the booking flow, intended solely for preview purposes, and any identity documents uploaded by the client during the booking flow.

array: data.documentList

• Document Item object

  Details of a document in the list.

  • key string

    Key representing the type or category of the document.

  • value object

    Each item in the document list contains details of a document. The value object provides information about the document, including its name and asset information necessary for downloading the physical file.