> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stora.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List all Orders

> List orders, newest first. An order goes from `draft` to `finalized` (waiting for the contact to check out) to `completed`, or is `abandoned`. Filter by `status`, `contact_id`, `site_id` or `source`, and expand `line_items` or `contact` to include them.

See [Building a booking flow](https://docs.stora.co/2025-09/guides/booking-flow).

Required authorization scope: `public.order:read`




## OpenAPI

````yaml /2025-09/openapi.json get /2025-09/orders
openapi: 3.1.1
info:
  version: 2025-09
  title: Stora Public API
  description: >-
    The Stora Public API gives you programmatic access to your self-storage
    business. Use it to build custom integrations, automate operational
    workflows, and sync data with the tools you already use.
  termsOfService: https://www.stora.co/terms-of-service
  contact:
    name: Stora Support
    url: https://www.stora.co/contact
  x-build-date: '2025-02-22'
servers:
  - url: https://public-api.stora.co
    description: Production
security: []
tags:
  - name: Contacts
    description: >-
      Contact is the end user of an operator's storage business, an individual
      or company, used to manage everyone who inquires, books, signs contracts,
      and pays for storage. Use Staff instead for the operator's own team.
  - name: Contract Templates
    description: >-
      Contract Template is a reusable contract blueprint, used to generate
      contracts for a specific contact and tenancy. It contains the contract
      content with fillable fields and variables that Stora can pre-fill at
      document generation time.
  - name: Contracts
    description: >-
      Contract is a document generated from a contract template for a specific
      contact, used to track the signing lifecycle. It moves through statuses
      such as pending, signed, voided, declined, and deleted.
  - name: Coupons
    description: >-
      Coupon is a reusable promotion, used to reduce the price a contact pays by
      either a percentage or a fixed amount. It can be applied to eligible
      charges such as unit rent or products and may be limited by duration,
      number of uses, or scope. Use Price Adjustments instead to change an
      existing subscription's recurring price.
  - name: Credit Notes
    description: >-
      Credit Note is a document that reduces or reverses part or all of a
      previously issued invoice, used to correct what a contact was charged. It
      references the original invoice and contact, along with the specified
      corrected amounts and taxes.
  - name: Deals
    description: >-
      Deal is a qualified sales lead for a contact, used to track a potential
      rental through pipeline stages until it is won or lost. Use Opportunities
      instead to capture early interest before it is qualified, and Orders once
      the contact is ready to book with agreed pricing.
  - name: Deals / Stages
    description: >-
      Deal Stage is a step in the operator's sales pipeline, used to show how
      far a deal has progressed. Stages are configured in the Stora back office
      and are read-only through the API.
  - name: Identity Verifications
    description: >-
      Identity Verification is a check of a contact's identity documents, used
      to confirm who is renting before move-in. It records the verification's
      status, the reason it failed, and the contact it belongs to.
  - name: Images
    description: >-
      Image is a picture of a resource such as a site or unit type, used to
      display that resource in your own app or website. The endpoint redirects
      to a temporary pre-signed storage URL where the image can be downloaded.
  - name: Invoices
    description: >-
      Invoice is a finalized billing document issued to a contact, used to
      charge for their storage subscriptions and related charges. It itemizes
      line items like unit rent and protection, applies taxes and discounts, and
      tracks totals, balance due, and status over time.
  - name: Notes
    description: >-
      Note is a free-text annotation on a contact, unit, subscription, or task,
      used to record observations and context added by staff or integrations.
      Use Timeline Events instead to show structured activity from an external
      system on a resource's timeline.
  - name: OAuth 2
    description: >-
      OAuth 2 is the authorization standard of the Stora Public API, used to get
      the access token that authenticates every request. Use the **Client
      Credentials** flow if you are an operator building your own integration.
      Use the **Authorization Code** flow if you are a partner integrating on
      behalf of an operator.
  - name: Opportunities
    description: >-
      Opportunity is an expression of interest in storage, used to capture leads
      before they are qualified. Examples include an incomplete order, a price
      reveal, a quote request, or a lead captured before a site opens. Use Deals
      instead once the lead is qualified, and Orders once the contact is ready
      to book. It records the contact, the site and storage they were interested
      in, and can go on to be associated with a deal.
  - name: Orders
    description: >-
      Order is a contact's request to rent storage, used to book a unit type at
      a site with a move-in date and agreed pricing. Use Deals instead for leads
      that aren't ready to book. It includes optional add-ons like protection,
      products, and services and tracks status over its lifecycle. An order
      becomes `completed` when Stora creates its subscription and tenancy from
      it.
  - name: Orders / Line Items
    description: >-
      Order Line Item is an individual charge in an order, used to itemize what
      the contact will pay. Each line item represents a product or service such
      as unit rent, protection, or a one-off fee, and includes its quantity,
      unit price, and currency.
  - name: Price Adjustments
    description: >-
      Price Adjustment is a scheduled percentage change (increase or decrease)
      to a subscription's recurring prices, used to change what a contact pays
      from a future renewal date. It tracks its lifecycle from scheduling
      through application and invoicing, along with contact notification
      details. Use Coupons instead for promotional discounts.
  - name: Product Categories
    description: >-
      Product Category is a group of related products and services, used to
      classify them for pricing and display.
  - name: Products
    description: >-
      Product is a sellable item or service offered by the operator, used to
      sell extras alongside storage. It defines attributes such as name,
      description, pricing model, currency, and category, which determine how
      it's presented and billed. Use Protection Levels instead for coverage
      add-ons.
  - name: Protection Levels
    description: >-
      Protection Level is an optional add-on that protects a contact's stored
      goods up to a chosen coverage amount, used to offer coverage alongside
      storage. It's priced and billed alongside storage, appears as its own
      product or line item, and follows the same tax and discount rules as other
      charges.


      Each protection level belongs to one site. Global levels (`site` is
      `null`) stay readable for historical references, but you can't use them on
      new order or deal line items. See [Migrating to site-scoped protection
      levels](https://docs.stora.co/2025-09/guides/site-scoped-protection-levels).
  - name: Sites
    description: >-
      Site is a single physical self-storage location, used to scope units, unit
      types, pricing, and access control to that location. It's the container
      for everything specific to that location, including taxes and reporting.
  - name: Staff
    description: >-
      Staff is a member of the operator's team who uses the Stora back office,
      used to assign tasks and deals and to see who created a record.
  - name: Subscriptions
    description: >-
      Subscription is the recurring billing agreement for a contact's rental,
      used to charge them on a schedule for storage and related services. It
      defines the billing period and active prices, accrues charges into
      invoices, and reflects proration, discounts, and taxes. Use Tenancies
      instead for the physical side of the same rental.
  - name: Tasks
    description: >-
      Task is a to-do for staff, optionally linked to a unit, contact, or
      subscription, used to track follow-ups and operational work. Tasks are
      `open` or `completed` and can be assigned to a staff member.
  - name: Tenancies
    description: >-
      Tenancy is the storage agreement between a contact and the operator, used
      to see who rents which units at which site and for which dates. Use
      Subscriptions instead for the billing side of the same rental.
  - name: Timeline / Events
    description: >-
      Timeline Event is a custom entry from an external integration, used to
      show CRM, messaging, or other system activity on a resource's timeline.
      Use Notes instead for free-text annotations. An event can link to a
      contact, site, subscription, tenancy, unit, invoice, or unit type.
  - name: Timeline / Sources
    description: >-
      Timeline Source is the external system a timeline event comes from, such
      as a CRM or a custom integration, used to label and group events.
  - name: Timeline / Templates
    description: >-
      Timeline Template is the Liquid message format for a timeline event, used
      to render the event's text from its variables.
  - name: Unit Allocations
    description: >-
      Unit Allocation is the assignment of a specific unit to a tenancy, used to
      track when the unit was reserved and when the contact was granted access.
      Use Units instead for the unit's own details and status.
  - name: Unit Types
    description: >-
      Unit Type is a standardized storage offering at a site, such as "50 sq ft
      indoor" or "20 ft container", used to set pricing and show availability.
      It defines core attributes including size, features or access type, and
      display name.
  - name: Units
    description: >-
      Unit is a specific, bookable storage space at a site, for example "Unit
      A-012" of a given unit type, used to track each individual space and its
      status. Use Unit Allocations instead to see which tenancy a unit is
      assigned to.
  - name: Webhook Endpoints
    description: >-
      Webhook Endpoint is a URL you register with Stora, used to receive
      notifications when specific events occur. Use Webhooks instead for the
      event payloads Stora sends. Stora sends a `POST` request to the endpoint
      with the event payload.
  - name: Webhooks
    description: >-
      Webhook is an event notification that Stora sends as a `POST` request to
      your subscribed endpoints, used to react in real time when something
      happens, such as an invoice being paid. Use Webhook Endpoints instead to
      register the URLs that receive them. Stora sends each notification to all
      endpoints subscribed to that event type.
externalDocs:
  description: Stora Public API documentation website
  url: https://docs.stora.co/2025-09/
paths:
  /2025-09/orders:
    get:
      tags:
        - Orders
      summary: List all Orders
      description: >
        List orders, newest first. An order goes from `draft` to `finalized`
        (waiting for the contact to check out) to `completed`, or is
        `abandoned`. Filter by `status`, `contact_id`, `site_id` or `source`,
        and expand `line_items` or `contact` to include them.


        See [Building a booking
        flow](https://docs.stora.co/2025-09/guides/booking-flow).


        Required authorization scope: `public.order:read`
      operationId: order_list
      parameters:
        - name: expand
          in: query
          required: false
          description: >-
            This endpoint supports expandable responses. For more, see the
            [documentation
            page](https://docs.stora.co/2025-09/guides/responses#expanding-responses).
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: fields
          in: query
          required: false
          description: >-
            Returns only the listed fields, such as `id,status,site.name`.
            Identifiers and constant fields such as `object` are always
            returned. A field inside an expandable association also needs it in
            `expand`, unless the collapsed association returns it, such as
            `site.id`. For more, see the [documentation
            page](https://docs.stora.co/2025-09/guides/responses#selecting-fields).
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: page
          in: query
          required: false
          description: 'Pagination: Page number'
          schema:
            type: integer
            minimum: 1
        - name: limit
          in: query
          required: false
          description: 'Pagination: Limit number of items per page.'
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: sort_by
          in: query
          required: false
          description: Sorting by attribute. Default `created_at`
          schema:
            type: string
            enum:
              - created_at
              - updated_at
        - name: sort_direction
          in: query
          required: false
          description: >-
            Sorting by `ASC` or `DESC` direction, case-insensitive. Default
            `DESC`
          schema:
            type: string
            enum:
              - ASC
              - DESC
        - name: contact_id
          in: query
          required: false
          description: >-
            Filter by Contact IDs. Supports multiple values separated by a
            comma.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: site_id
          in: query
          required: false
          description: Filter by Site IDs. Supports multiple values separated by a comma.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: status
          in: query
          required: false
          description: Filter by status. Supports multiple values separated by a comma.
          style: form
          explode: false
          examples:
            single:
              value:
                - draft
            multiple:
              value:
                - finalized
                - completed
          schema:
            type: array
            items:
              type: string
              enum:
                - draft
                - finalized
                - completed
                - abandoned
        - name: source
          in: query
          required: false
          description: Filter by source. Supports multiple values separated by a comma.
          style: form
          explode: false
          examples:
            single:
              value:
                - backoffice
            multiple:
              value:
                - storefront
                - public_api
          schema:
            type: array
            items:
              type: string
              enum:
                - backoffice
                - storefront
                - storefront_multi_step
                - import
                - public_api
                - unspecified
        - name: billing_period
          in: query
          required: false
          description: >-
            Filter by billing period. Supports multiple values separated by a
            comma.
          style: form
          explode: false
          examples:
            single:
              value:
                - monthly
            multiple:
              value:
                - monthly
                - weekly
          schema:
            type: array
            items:
              type: string
              enum:
                - monthly
                - weekly
                - every_four_weeks
                - every_three_months
                - every_six_months
                - yearly
                - one_time
        - name: created_after
          in: query
          required: false
          description: >-
            Filters results to `created` after (including given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          required: false
          description: >-
            Filters results to `created` before (excluding given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: updated_after
          in: query
          required: false
          description: >-
            Filters results to `updated` after (including given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: updated_before
          in: query
          required: false
          description: >-
            Filters results to `updated` before (excluding given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: starts_after
          in: query
          required: false
          description: >-
            Filters results to `starts` after (including given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: starts_before
          in: query
          required: false
          description: >-
            Filters results to `starts` before (excluding given date) the given
            ISO 8601 timestamp (e.g., `2025-01-12T15:30:00Z`).
          schema:
            type: string
            format: date-time
        - name: metadata
          in: query
          required: false
          description: >-
            Filter by metadata. Use `metadata[key]=value` to filter by specific
            metadata keys.
          style: deepObject
          explode: true
          schema:
            type: object
            additionalProperties:
              type: string
            maxProperties: 20
      responses:
        '200':
          description: list of orders
          content:
            application/json:
              examples:
                default:
                  value:
                    orders:
                      - id: order_942ae99a1fdc940e
                        billing_period: monthly
                        contact:
                          id: con_0ac0514ed0711462
                        contract_template:
                          id: ctpl_33ae8d0b2b371ba2
                        coupon:
                          id: cpn_a26d0d4c582740c1
                        created_at: '2025-02-22T14:36:00Z'
                        email_notifications:
                          booking_confirmation: true
                          move_in_day: true
                          payment_details: false
                        line_items:
                          - id: olitm_1001cbd3d5fec937
                          - id: olitm_260799c6b6b1a274
                          - id: olitm_47eba7938308c71d
                          - id: olitm_b202613e81c9101e
                        metadata: {}
                        one_time_total:
                          amount: 201998
                          currency: GBP
                          formatted: £2,019.98
                        one_time_total_excluding_tax:
                          amount: 201998
                          currency: GBP
                          formatted: £2,019.98
                        payment_method: card
                        payment_url: null
                        purchase_order_number: PO987654321
                        site:
                          id: site_14b419f1096013f1
                        source: public_api
                        starts_at: '2025-02-23T14:41:00Z'
                        status: draft
                        subscription: null
                        subtotal:
                          amount: 11998
                          currency: GBP
                          formatted: £119.98
                        tax:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        tenancy: null
                        total:
                          amount: 5999
                          currency: GBP
                          formatted: £59.99
                        total_discount:
                          amount: 5999
                          currency: GBP
                          formatted: £59.99
                        total_excluding_tax:
                          amount: 5999
                          currency: GBP
                          formatted: £59.99
                        updated_at: '2025-02-22T14:41:00Z'
                      - id: order_9b4d7b10f6b3e0d4
                        billing_period: null
                        contact: null
                        contract_template: null
                        coupon: null
                        created_at: '2025-02-22T14:31:00Z'
                        email_notifications:
                          booking_confirmation: true
                          move_in_day: true
                          payment_details: false
                        line_items: []
                        metadata: {}
                        one_time_total:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        one_time_total_excluding_tax:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        payment_method: card
                        payment_url: null
                        purchase_order_number: null
                        site:
                          id: site_14b419f1096013f1
                        source: public_api
                        starts_at: null
                        status: draft
                        subscription: null
                        subtotal:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        tax:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        tenancy: null
                        total:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        total_discount:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        total_excluding_tax:
                          amount: 0
                          currency: GBP
                          formatted: £0.00
                        updated_at: '2025-02-22T14:41:00Z'
                    meta:
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      curies:
                        - name: bo
                          href: https://app.stora.test{rel}
                          templated: true
                          title: Backoffice
                        - name: sf
                          href: https://acme.stora.test{rel}
                          templated: true
                          title: Storefront
                      pagination:
                        count: 2
                        last: 1
                        limit: 50
                        next: null
                        page: 1
                        pages: 1
                        prev: null
                  summary: list of orders
              schema:
                $ref: '#/components/schemas/OrderList'
      security:
        - Bearer:
            - public.order:read
        - OAuth2:
            - public.order:read
components:
  schemas:
    OrderList:
      type: object
      required:
        - orders
        - meta
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/Order'
          description: Orders on this page.
        meta:
          $ref: '#/components/schemas/MetaWithPagination'
      additionalProperties: false
      description: List of Orders
    Order:
      type: object
      description: Order
      required:
        - id
        - billing_period
        - contact
        - contract_template
        - coupon
        - created_at
        - email_notifications
        - line_items
        - metadata
        - one_time_total
        - one_time_total_excluding_tax
        - payment_method
        - payment_url
        - purchase_order_number
        - site
        - source
        - starts_at
        - status
        - subscription
        - subtotal
        - tax
        - tenancy
        - total
        - total_discount
        - total_excluding_tax
        - updated_at
      properties:
        id:
          type: string
          pattern: ^order_
          description: Unique identifier for the order (`order_…`).
        billing_period:
          type:
            - string
            - 'null'
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
            - null
          description: Billing period of the order, `null` when not set.
        contact:
          anyOf:
            - $ref: '#/components/schemas/Contact'
            - $ref: '#/components/schemas/ContactCollapsed'
            - type: 'null'
          description: >-
            Contact associated with the order. **Expandable** (shows only ID
            when not expanded).
        contract_template:
          anyOf:
            - $ref: '#/components/schemas/ContractTemplate'
            - $ref: '#/components/schemas/ContractTemplateCollapsed'
            - type: 'null'
          description: >-
            Contract template associated with the order. **Expandable** (shows
            only ID when not expanded).
        coupon:
          anyOf:
            - $ref: '#/components/schemas/Coupon'
            - $ref: '#/components/schemas/CouponCollapsed'
            - type: 'null'
          description: >-
            Coupon associated with the order. **Expandable** (shows only ID when
            not expanded).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the order.
        email_notifications:
          $ref: '#/components/schemas/OrdersEmailNotification'
          description: Email notifications settings for the order.
        line_items:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/OrderLineItem'
              - $ref: '#/components/schemas/OrderLineItemCollapsed'
          description: >-
            List of line items in the order. **Expandable** (shows only ID when
            not expanded).
        metadata:
          type: object
          additionalProperties:
            type: string
          maxProperties: 20
          description: >-
            Set of key-value pairs for storing additional information. [Learn
            more about metadata.](https://docs.stora.co/2025-09/guides/metadata)
        one_time_total:
          $ref: '#/components/schemas/Money'
          description: Gross cost of one off products after applying taxes and discounts.
        one_time_total_excluding_tax:
          $ref: '#/components/schemas/Money'
          description: >-
            Gross cost of one off products before applying taxes and after
            applying discounts.
        payment_method:
          type:
            - string
            - 'null'
          description: Payment method used for the order.
        payment_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            URL for payment processing. Available only when the order is
            finalized.
        purchase_order_number:
          type:
            - string
            - 'null'
          description: Purchase order number associated with the order.
        site:
          anyOf:
            - $ref: '#/components/schemas/Site'
            - $ref: '#/components/schemas/SiteCollapsed'
          description: >-
            Site associated with the order. **Expandable** (shows only ID when
            not expanded).
        source:
          type:
            - string
            - 'null'
          enum:
            - backoffice
            - storefront
            - storefront_multi_step
            - import
            - public_api
            - unspecified
            - null
          description: Source of the order.
        starts_at:
          type:
            - string
            - 'null'
          anyOf:
            - const: now
            - format: date-time
          description: >-
            Start date and time of the order (ISO 8601 date-time, UTC), or `now`
            while a draft order is set to start immediately after finalization.
        status:
          type: string
          enum:
            - draft
            - finalized
            - completed
            - abandoned
          description: Status of the order.
        subscription:
          anyOf:
            - $ref: '#/components/schemas/SubscriptionExpandableWithoutTenancy'
            - $ref: '#/components/schemas/SubscriptionCollapsed'
            - type: 'null'
          description: >-
            Subscription associated with the order. **Expandable** (shows only
            ID when not expanded).
        subtotal:
          $ref: '#/components/schemas/Money'
          description: Gross cost of order before applying taxes and discounts.
        tax:
          $ref: '#/components/schemas/Money'
          description: Total cost of tax.
        tenancy:
          anyOf:
            - $ref: >-
                #/components/schemas/TenancyExpandableWithoutSubscriptionAndOrder
            - $ref: '#/components/schemas/TenancyCollapsed'
            - type: 'null'
          description: >-
            Tenancy associated with the order. **Expandable** (shows only ID
            when not expanded).
        total:
          $ref: '#/components/schemas/Money'
          description: Gross cost of order after applying taxes and discounts.
        total_discount:
          $ref: '#/components/schemas/Money'
          description: Discount total towards order.
        total_excluding_tax:
          $ref: '#/components/schemas/Money'
          description: >-
            Gross cost of order before applying taxes and after applying
            discounts.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the order.
      additionalProperties: false
    MetaWithPagination:
      type: object
      required:
        - curies
        - pagination
        - request_id
      properties:
        curies:
          type: array
          items:
            $ref: '#/components/schemas/Curie'
          description: CURIE definitions for resolving namespaced link relations.
        pagination:
          $ref: '#/components/schemas/Pagination'
          description: Pagination of the list.
        request_id:
          type: string
          description: Unique request identifier.
      additionalProperties: false
    Contact:
      type: object
      description: Contact
      required:
        - id
        - accounting_code
        - address
        - company_registration_number
        - created_at
        - email
        - full_name
        - identity_check
        - marketing_source
        - metadata
        - phone_number
        - source
        - status
        - stripe_customer_id
        - tax_id
        - tenancies_count
        - type
        - updated_at
        - use_case
      properties:
        id:
          type: string
          pattern: ^con_
          description: Unique identifier for the contact (`con_…`).
        accounting_code:
          type:
            - string
            - 'null'
          description: >-
            The contact's account reference in your accounting software,
            included in invoice exports.
        address:
          anyOf:
            - $ref: '#/components/schemas/ContactsAddress'
            - type: 'null'
          description: Address of the contact, `null` when no address is set.
        company_registration_number:
          type:
            - string
            - 'null'
          description: Company registration number of the contact.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the contact.
        email:
          type: string
          format: email
          description: Email address of the contact.
        full_name:
          type: string
          description: Full name of the contact.
        identity_check:
          $ref: '#/components/schemas/ContactsIdentityCheck'
          description: Identity check requirement and status of the contact.
        marketing_source:
          type:
            - string
            - 'null'
          enum:
            - used_before
            - recommendation
            - received_leaflet
            - seen_building_signs
            - seen_advert
            - facebook_marketplace
            - google_search
            - other_online_search
            - social_media
            - email
            - radio
            - other
            - null
          description: Source of marketing for the contact.
        metadata:
          type: object
          additionalProperties:
            type: string
          maxProperties: 20
          description: >-
            Set of key-value pairs for storing additional information. [Learn
            more about metadata.](https://docs.stora.co/2025-09/guides/metadata)
        phone_number:
          type:
            - string
            - 'null'
          description: Phone number of the contact.
        source:
          type:
            - string
            - 'null'
          enum:
            - pre_open
            - incomplete_booking
            - registered_interest
            - price_interest
            - quotation_request
            - booking
            - popup
            - external_enquiry
            - phone
            - walkin
            - import
            - other
            - null
          description: Source of the contact information.
        status:
          type: string
          enum:
            - lead
            - customer
            - churned
          description: >-
            Status of the contact, derived from its tenancies. `lead` means the
            contact has no tenancies, and is the default. `customer` means at
            least one tenancy hasn't ended. `churned` means all tenancies have
            ended.
        stripe_customer_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated. Will be removed in a future API version.** Stripe
            Customer identifier of the contact. Kept for backwards
            compatibility. Don't use it in new integrations.
        tax_id:
          type:
            - string
            - 'null'
          description: Tax identification number of the contact.
        tenancies_count:
          type: integer
          description: Number of tenancies associated with the contact.
        type:
          type:
            - string
            - 'null'
          enum:
            - domestic
            - company
            - student
            - charity
            - local_authority
            - null
          description: Type of the contact.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the contact.
        use_case:
          type:
            - string
            - 'null'
          enum:
            - business_needs
            - moving_home
            - more_space
            - refurb
            - travelling
            - other
            - null
          description: Use case for the contact.
      additionalProperties: false
    ContactCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^con_
          description: Unique identifier for the contact (`con_…`).
      additionalProperties: false
    ContractTemplate:
      type: object
      description: Contract Template
      required:
        - id
        - created_at
        - name
        - updated_at
      properties:
        id:
          type: string
          pattern: ^ctpl_
          description: Unique identifier for the contract template (`ctpl_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the contract template.
        name:
          type: string
          description: Name of the contract template.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the contract template.
      additionalProperties: false
    ContractTemplateCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^ctpl_
          description: Unique identifier for the contract template (`ctpl_…`).
      additionalProperties: false
    Coupon:
      type: object
      description: Coupon
      required:
        - id
        - auto_apply_to
        - billing_period
        - code
        - created_at
        - duration
        - max_redemptions
        - months
        - name
        - public
        - title
        - type
        - updated_at
      properties:
        id:
          type: string
          pattern: ^cpn_
          description: Unique identifier for the coupon (`cpn_…`).
        amount:
          $ref: '#/components/schemas/Money'
          description: Amount deducted from the price when the coupon is applied.
        auto_apply_to:
          $ref: '#/components/schemas/CouponAutoApplyTo'
          description: >-
            Line items the coupon is applied to automatically when used on an
            order.
        billing_period:
          type:
            - string
            - 'null'
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
            - null
          description: Used for `repeating` duration.
        code:
          type:
            - string
            - 'null'
          description: Unique code for the coupon for non-public coupons.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the coupon.
        duration:
          type: string
          enum:
            - once
            - forever
            - repeating
          description: Duration of the coupon.
        max_redemptions:
          type:
            - integer
            - 'null'
          description: Maximum number of times the coupon can be redeemed.
        months:
          type:
            - integer
            - 'null'
          description: >-
            Number of months the coupon is valid for, applicable for `repeating`
            duration.
        name:
          type: string
          description: Name of the coupon.
        percent:
          type: number
          description: >-
            Percentage off the price, greater than 0 and at most 100, with up to
            2 decimal places. `20` means 20% off.
        public:
          type: boolean
          description: >-
            Indicates if the coupon is publicly available for any contact to
            use. When set to `true`, the `code` field is not used.
        title:
          type:
            - string
            - 'null'
          description: Title of the coupon.
        type:
          type: string
          enum:
            - percentage
            - amount
          description: Type of the coupon.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the coupon.
      additionalProperties: false
    CouponCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^cpn_
          description: Unique identifier for the coupon (`cpn_…`).
      additionalProperties: false
    OrdersEmailNotification:
      type: object
      description: Email notifications settings for the order.
      required:
        - booking_confirmation
        - move_in_day
        - payment_details
      properties:
        booking_confirmation:
          type: boolean
          description: Whether to send the booking confirmation email.
        move_in_day:
          type: boolean
          description: Whether to send the move-in day email.
        payment_details:
          type: boolean
          description: >-
            Whether to send the email with a link to complete payment when the
            order is finalized.
      additionalProperties: false
    OrderLineItem:
      type: object
      description: Order Line Item
      required:
        - id
        - created_at
        - discount_total
        - item
        - price
        - quantity
        - tax
        - total
        - total_excluding_tax
        - type
        - updated_at
      properties:
        id:
          type: string
          pattern: ^olitm_
          description: Unique identifier for the order line item (`olitm_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the order line item.
        discount_total:
          $ref: '#/components/schemas/Money'
          description: Discount towards line item.
        item:
          anyOf:
            - $ref: '#/components/schemas/UnitTypeExpandableWithoutPrices'
            - $ref: '#/components/schemas/UnitTypeCollapsed'
            - $ref: '#/components/schemas/ProtectionLevelExpandableWithoutPrices'
            - $ref: '#/components/schemas/ProtectionLevelCollapsed'
            - $ref: '#/components/schemas/ProductExpandableWithoutPrices'
            - $ref: '#/components/schemas/ProductCollapsed'
            - type: 'null'
          description: >-
            Item associated with the line item. Can be a Unit type, Protection
            level, or Product. **Expandable** (shows only ID when not expanded).
        price:
          $ref: '#/components/schemas/Money'
          description: Per-item cost of line item.
        quantity:
          type: integer
          description: Quantity of the item in the order line item.
        tax:
          $ref: '#/components/schemas/Money'
          description: Total cost of taxes.
        total:
          $ref: '#/components/schemas/Money'
          description: Gross cost of line item.
        total_excluding_tax:
          $ref: '#/components/schemas/Money'
          description: Total cost of line item before applying taxes.
        type:
          type: string
          enum:
            - unit_type
            - protection
            - product
            - security_deposit
          description: Type of the item on the line item.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the order line item.
      additionalProperties: false
    OrderLineItemCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^olitm_
          description: Unique identifier for the order line item (`olitm_…`).
      additionalProperties: false
    Money:
      type: object
      description: Money
      required:
        - amount
        - currency
        - formatted
      properties:
        amount:
          type: integer
          description: Amount of money in the smallest currency unit (e.g., cents for USD).
        currency:
          type: string
          enum:
            - AED
            - AUD
            - BGN
            - BRL
            - CAD
            - CHF
            - CZK
            - DKK
            - EUR
            - GBP
            - HKD
            - HUF
            - MXN
            - MYR
            - NOK
            - NZD
            - PLN
            - RON
            - SEK
            - SGD
            - THB
            - USD
          description: ISO 4217 currency code.
        formatted:
          type: string
          description: >-
            Formatted string representation of the money amount, including the
            currency symbol.
      additionalProperties: false
    Site:
      type: object
      description: Site
      required:
        - id
        - access_hours
        - address
        - created_at
        - description
        - directions
        - images
        - name
        - opened_at
        - phone
        - updated_at
      properties:
        id:
          type: string
          pattern: ^site_
          description: Unique identifier for the site (`site_…`).
        access_hours:
          anyOf:
            - $ref: '#/components/schemas/SitesAccessHours'
            - type: 'null'
          description: Access hours for the site.
        address:
          anyOf:
            - $ref: '#/components/schemas/SitesAddress'
            - type: 'null'
          description: Address of the site.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the site.
        description:
          type:
            - string
            - 'null'
          description: Description of the site.
        directions:
          $ref: '#/components/schemas/SitesDirections'
          description: Directions to the site.
        images:
          type: object
          additionalProperties: false
          properties:
            default:
              type:
                - object
                - 'null'
              description: The `default` image, or `null` when none is uploaded.
              additionalProperties: false
              properties:
                original:
                  type: string
                  format: uri
                  description: Original unresized image.
                small:
                  type: string
                  format: uri
                  description: Resized to max 250x250px.
                medium:
                  type: string
                  format: uri
                  description: Resized to max 500x500px.
                large:
                  type: string
                  format: uri
                  description: Resized to max 1000x1000px.
          description: >-
            Image URLs keyed by image name. Each URL redirects to a short-lived
            download link, so don't cache the redirect target.
        name:
          type: string
          description: Name of the site.
        opened_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time when the site opened or will open.
        phone:
          type:
            - string
            - 'null'
          description: Phone number of the site.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the site.
      additionalProperties: false
    SiteCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^site_
          description: Unique identifier for the site (`site_…`).
      additionalProperties: false
    SubscriptionExpandableWithoutTenancy:
      type: object
      description: Subscription
      required:
        - id
        - billing_period
        - cancellation_reason
        - cancelled
        - created_at
        - current_period
        - ends_at
        - line_items
        - starts_at
        - stripe_subscription_id
        - stripe_subscription_schedule_id
        - updated_at
      properties:
        id:
          type: string
          pattern: ^sub_
          description: Unique identifier for the subscription (`sub_…`).
        billing_period:
          type: string
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
          description: Billing period of the subscription.
        cancellation_reason:
          type:
            - string
            - 'null'
          enum:
            - move_out_not_needed
            - move_out_seasonal
            - move_out_business
            - issue_cost
            - issue_location
            - issue_security
            - issue_quality
            - issue_accessibility
            - issue_cleanliness
            - issue_unsuitable
            - new_sub_date_change
            - new_sub_unit_type_change
            - new_sub_payment_method_change
            - new_sub_incorrect_cancellation
            - new_sub_billing_period_change
            - eviction
            - no_show
            - alternative_found
            - other
            - null
          description: Reason for subscription cancellation.
        cancelled:
          type: boolean
          description: Indicates whether subscription is cancelled.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the subscription.
        current_period:
          $ref: '#/components/schemas/SubscriptionsCurrentPeriod'
          description: Current subscription period.
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time for end of the subscription period.
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionLineItem'
          description: List of line items in the subscription.
        starts_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time for start of the subscription period.
        stripe_subscription_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Subscription ID linked to the subscription. Retained for backwards
            compatibility; do not use in new integrations.
        stripe_subscription_schedule_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Subscription Schedule ID associated with the subscription. Retained
            for backwards compatibility; do not use in new integrations.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the subscription.
      additionalProperties: false
    SubscriptionCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^sub_
          description: Unique identifier for the subscription (`sub_…`).
      additionalProperties: false
    TenancyExpandableWithoutSubscriptionAndOrder:
      type: object
      description: Tenancy
      required:
        - id
        - created_at
        - ends_at
        - starts_at
        - unit_allocations
        - updated_at
      properties:
        id:
          type: string
          pattern: ^ten_
          description: Unique identifier for the tenancy (`ten_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time for the tenancy.
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time for end of the tenancy period.
        starts_at:
          type: string
          format: date-time
          description: Date and time for start of the tenancy period.
        unit_allocations:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/UnitAllocationExpandable'
              - $ref: '#/components/schemas/UnitAllocationCollapsed'
          description: >-
            Allocated units associated with the tenancy. **Expandable** (shows
            only ID when not expanded).
        updated_at:
          type: string
          format: date-time
          description: Last update date and time for the tenancy.
      additionalProperties: false
    TenancyCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^ten_
          description: Unique identifier for the tenancy (`ten_…`).
      additionalProperties: false
    Curie:
      type: object
      description: CURIE definition for resolving namespaced link relations.
      required:
        - href
        - name
        - templated
        - title
      properties:
        href:
          type: string
          description: URI template for resolving the CURIE.
        name:
          type: string
          enum:
            - bo
            - sf
          description: CURIE prefix name
        templated:
          type: boolean
          description: Whether the href is a URI template.
        title:
          type: string
          description: Human-readable title.
      additionalProperties: false
    Pagination:
      type: object
      description: Pagination
      required:
        - count
        - last
        - limit
        - next
        - page
        - pages
        - prev
      properties:
        count:
          type:
            - integer
            - 'null'
          description: >-
            Total number of items. The `null` value is used with countless
            pagination (used for faster response on large datasets).
        last:
          type:
            - integer
            - 'null'
          description: Last page number.
        limit:
          type: integer
          description: Number of items per page.
        next:
          type:
            - integer
            - 'null'
          description: Next page number, `null` on the last page.
        page:
          type: integer
          description: Current page.
        pages:
          type: integer
          description: Total number of pages.
        prev:
          type:
            - integer
            - 'null'
          description: Previous page number, `null` on the first page.
      additionalProperties: false
    ContactsAddress:
      type: object
      description: Address
      required:
        - city
        - country_alpha2
        - line_1
        - line_2
        - postal_code
        - state
      properties:
        city:
          type:
            - string
            - 'null'
          description: City
        country_alpha2:
          type:
            - string
            - 'null'
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - null
          description: Country Alpha 2
        line_1:
          type:
            - string
            - 'null'
          description: Line 1
        line_2:
          type:
            - string
            - 'null'
          description: Line 2
        postal_code:
          type:
            - string
            - 'null'
          description: Postal code
        state:
          type:
            - string
            - 'null'
          description: State or province, ISO 3166-2 only
      additionalProperties: false
    ContactsIdentityCheck:
      type: object
      description: Identity check of a contact
      required:
        - required
        - status
      properties:
        required:
          type: boolean
          description: >-
            Whether the contact is required to complete identity verification
            based on the operator's checkin settings.
        status:
          type: string
          enum:
            - failed
            - processing
            - succeeded
            - cancelled
            - not_attempted
          description: >-
            Status of the contact's latest identity verification.
            `not_attempted` is unique to this field (infers no identity
            verification resource yet exists for this contact).
      additionalProperties: false
    CouponAutoApplyTo:
      type: object
      description: Defines how the coupon should be auto-applied when used on an order.
      required:
        - products
        - protections
        - subscriptions
        - unit_types
      properties:
        products:
          type: boolean
          description: Whether the coupon applies to product line items.
        protections:
          type: boolean
          description: Whether the coupon applies to protection line items.
        subscriptions:
          type: boolean
          description: Whether the coupon applies to the subscription.
        unit_types:
          type: boolean
          description: Whether the coupon applies to unit type line items.
      additionalProperties: false
    UnitTypeExpandableWithoutPrices:
      type: object
      description: Unit Type
      required:
        - id
        - _links
        - created_at
        - dimensions
        - dynamic_pricing
        - images
        - live_prices
        - name
        - promotion
        - require_insurance_coverage
        - require_security_deposit
        - security_deposit
        - selling_points
        - size_description
        - slug
        - status
        - stripe_product_id
        - updated_at
      properties:
        id:
          type: string
          pattern: ^utype_
          description: Unique identifier for the unit type (`utype_…`).
        _links:
          type: object
          additionalProperties:
            type: object
            additionalProperties: false
            properties:
              href:
                type: string
                description: Relative path for API links, relative path for CURIE links.
              method:
                type: string
                description: Available only for API links. Other links use always `get`.
                enum:
                  - get
                  - post
                  - patch
                  - delete
              title:
                type: string
                description: Human-readable label for the link.
              reference:
                type:
                  - string
                  - 'null'
                description: >-
                  OpenAPI reference for API links. Component schema for self
                  links, path operation for action links.
          description: Links related to the resource.
        created_at:
          type: string
          format: date-time
          description: Creation date and time for the unit type.
        dimensions:
          $ref: '#/components/schemas/UnitTypesDimensions'
          description: Dimensions of the unit type.
        dynamic_pricing:
          type: boolean
          description: Indicates whether dynamic pricing is enabled for this unit type.
        images:
          type: object
          additionalProperties: false
          properties:
            default:
              type:
                - object
                - 'null'
              description: The `default` image, or `null` when none is uploaded.
              additionalProperties: false
              properties:
                original:
                  type: string
                  format: uri
                  description: Original unresized image.
                small:
                  type: string
                  format: uri
                  description: Resized to max 250x250px.
                medium:
                  type: string
                  format: uri
                  description: Resized to max 500x500px.
                large:
                  type: string
                  format: uri
                  description: Resized to max 1000x1000px.
          description: >-
            Image URLs keyed by image name. Each URL redirects to a short-lived
            download link, so don't cache the redirect target.
        live_prices:
          type: array
          items:
            $ref: '#/components/schemas/Price'
          description: >-
            Current source price used by storefront pricing. Returns the active
            dynamic price when one applies; otherwise returns the base
            storefront price. Promotions, discounts, and tax-exclusive variants
            are not applied.
        name:
          type: string
          description: Name of the unit type.
        promotion:
          anyOf:
            - $ref: '#/components/schemas/Coupon'
            - $ref: '#/components/schemas/CouponCollapsed'
            - type: 'null'
          description: >-
            Promotional coupon associated with the unit type. **Expandable**
            (shows only ID when not expanded).
        require_insurance_coverage:
          type: boolean
          description: Indicates whether insurance coverage is required for this unit type.
        require_security_deposit:
          type: boolean
          description: Indicates whether a security deposit is required for this unit type.
        security_deposit:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: Security deposit amount for the unit type.
        selling_points:
          type: array
          items:
            type: string
          description: List of selling points for the unit type.
        size_description:
          type: string
          description: Description of the size of the unit type.
        slug:
          type: string
          description: >-
            URL-friendly identifier for the unit type, typically used in web
            addresses.
        status:
          type: string
          enum:
            - bookable
            - hidden
            - lead_capture
          description: >-
            Availability of the unit type on the storefront: `bookable`,
            `lead_capture` (collecting leads) or `hidden`.
        stripe_product_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Product ID associated with the unit type, used for payment
            processing. Retained for backwards compatibility; do not use in new
            integrations.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time for the unit type.
      additionalProperties: false
    UnitTypeCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^utype_
          description: Unique identifier for the unit type (`utype_…`).
      additionalProperties: false
    ProtectionLevelExpandableWithoutPrices:
      type: object
      description: Protection Level
      required:
        - id
        - account_code
        - cover_level
        - created_at
        - public
        - site
        - stripe_product_id
        - updated_at
      properties:
        id:
          type: string
          pattern: ^plvl_
          description: Unique identifier for the protection level (`plvl_…`).
        account_code:
          type:
            - string
            - 'null'
          description: Account code associated with the protection level.
        cover_level:
          $ref: '#/components/schemas/Money'
          description: Monetary value representing the cover level of the protection.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the protection level.
        public:
          type: boolean
          description: Indicates whether the protection level is available for selection.
        site:
          anyOf:
            - $ref: '#/components/schemas/Site'
            - $ref: '#/components/schemas/SiteCollapsed'
            - type: 'null'
          description: >-
            Site associated with the protection level. Returns `null` for global
            protection levels. **Expandable** (shows only ID when not expanded).
        stripe_product_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Product ID associated with the protection level, used for payment
            processing. Retained for backwards compatibility; do not use in new
            integrations.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the protection level.
      additionalProperties: false
    ProtectionLevelCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^plvl_
          description: Unique identifier for the protection level (`plvl_…`).
      additionalProperties: false
    ProductExpandableWithoutPrices:
      type: object
      description: Product
      required:
        - id
        - accounting_code
        - category
        - charge_type
        - created_at
        - description
        - images
        - name
        - sku
        - updated_at
      properties:
        id:
          type: string
          pattern: ^prod_
          description: Unique identifier for the product (`prod_…`).
        accounting_code:
          type:
            - string
            - 'null'
          description: Accounting code associated with the product, if any.
        category:
          anyOf:
            - $ref: '#/components/schemas/ProductCategory'
            - $ref: '#/components/schemas/ProductCategoryCollapsed'
          description: >-
            Category associated with the product. **Expandable** (shows only ID
            when not expanded).
        charge_type:
          type: string
          enum:
            - one_time
            - recurring
          description: Type of charge for the product.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the product.
        description:
          type: string
          description: Detailed description of the product.
        images:
          type: object
          additionalProperties: false
          properties:
            default:
              type:
                - object
                - 'null'
              description: The `default` image, or `null` when none is uploaded.
              additionalProperties: false
              properties:
                original:
                  type: string
                  format: uri
                  description: Original unresized image.
                small:
                  type: string
                  format: uri
                  description: Resized to max 250x250px.
                medium:
                  type: string
                  format: uri
                  description: Resized to max 500x500px.
                large:
                  type: string
                  format: uri
                  description: Resized to max 1000x1000px.
          description: >-
            Image URLs keyed by image name. Each URL redirects to a short-lived
            download link, so don't cache the redirect target.
        name:
          type: string
          description: Name of the product.
        sku:
          type:
            - string
            - 'null'
          description: Stock keeping unit (SKU) of the product.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the product.
      additionalProperties: false
    ProductCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^prod_
          description: Unique identifier for the product (`prod_…`).
      additionalProperties: false
    SitesAccessHours:
      type: object
      description: Access hours for the site.
      required:
        - friday
        - monday
        - saturday
        - sunday
        - thursday
        - tuesday
        - wednesday
      properties:
        friday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        monday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        saturday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        sunday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        thursday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        tuesday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        wednesday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
      additionalProperties: false
    SitesAddress:
      type: object
      description: Address of the site.
      required:
        - city
        - line_1
        - line_2
        - postal_code
      properties:
        city:
          type:
            - string
            - 'null'
          description: City of the site.
        line_1:
          type:
            - string
            - 'null'
          description: First line of the address.
        line_2:
          type:
            - string
            - 'null'
          description: Second line of the address (optional).
        postal_code:
          type:
            - string
            - 'null'
          description: Postal code of the site.
      additionalProperties: false
    SitesDirections:
      type: object
      description: Directions to the site.
      required:
        - google_maps_url
      properties:
        google_maps_url:
          type:
            - string
            - 'null'
          description: URL to Google Maps for the site.
      additionalProperties: false
    SubscriptionsCurrentPeriod:
      type: object
      description: Current subscription period.
      required:
        - ends_at
        - starts_at
      properties:
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time for end of the subscription period.
        starts_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time for start of the subscription period.
      additionalProperties: false
    SubscriptionLineItem:
      type: object
      description: Subscription Line Item
      required:
        - created_at
        - item
        - price
        - quantity
        - type
        - updated_at
      properties:
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the subscription line item.
        item:
          anyOf:
            - $ref: '#/components/schemas/ProductExpandableWithoutPrices'
            - $ref: '#/components/schemas/ProductCollapsed'
            - $ref: '#/components/schemas/UnitTypeExpandableWithoutPrices'
            - $ref: '#/components/schemas/UnitTypeCollapsed'
            - $ref: '#/components/schemas/ProtectionLevelExpandableWithoutPrices'
            - $ref: '#/components/schemas/ProtectionLevelCollapsed'
          description: >-
            Item associated with the subscription line item. **Expandable**
            (shows only ID when not expanded).
        price:
          $ref: '#/components/schemas/Money'
          description: Price of the subscription line item per unit.
        quantity:
          type: integer
          description: Quantity of the item in the subscription line item.
        type:
          type: string
          enum:
            - protection
            - unit_type
            - custom_product
          description: Type of the item on the line item.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the subscription line item.
      additionalProperties: false
    UnitAllocationExpandable:
      type: object
      description: Unit Allocation
      required:
        - id
        - created_at
        - granted_access_at
        - reserved_at
        - unit
        - updated_at
      properties:
        id:
          type: string
          pattern: ^alloc_
          description: Unique identifier for the unit allocation (`alloc_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time.
        granted_access_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the contact was granted access to the unit, which is the
            move-in date. `null` until access is granted.
        reserved_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the unit was reserved for the contact. A reserved unit is held
            for the contact, who doesn't have access yet. `null` if the unit was
            allocated without a reservation.
        unit:
          anyOf:
            - $ref: '#/components/schemas/UnitExpandableWithoutUnitAllocation'
            - $ref: '#/components/schemas/UnitCollapsed'
          description: >-
            Unit associated with this allocation. **Expandable** (shows only ID
            when not expanded).
        updated_at:
          type: string
          format: date-time
          description: Last update date and time.
      additionalProperties: false
    UnitAllocationCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^alloc_
          description: Unique identifier for the unit allocation (`alloc_…`).
      additionalProperties: false
    UnitTypesDimensions:
      type: object
      description: Dimensions of the unit type.
      required:
        - height
        - length
        - measurement_unit
        - width
      properties:
        height:
          type: number
          description: Height of the unit type, in `measurement_unit`.
        length:
          type: number
          description: Length of the unit type, in `measurement_unit`.
        measurement_unit:
          type: string
          enum:
            - ft
            - m
          description: 'Unit of length of the dimensions: `m` for metres or `ft` for feet.'
        width:
          type: number
          description: Width of the unit type, in `measurement_unit`.
      additionalProperties: false
    Price:
      type: object
      description: Price
      required:
        - billing_period
        - price
        - stripe_price_id
      properties:
        billing_period:
          type: string
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
          description: Billing period for the price.
        price:
          $ref: '#/components/schemas/Money'
          description: Price for the specified billing period.
        stripe_price_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Price ID associated with this price, used for payment processing.
            Retained for backwards compatibility; do not use in new
            integrations.
      additionalProperties: false
    ProductCategory:
      type: object
      description: Product Category
      required:
        - id
        - name
      properties:
        id:
          type: string
          pattern: ^pcat_
          description: Unique identifier for the product category (`pcat_…`).
        name:
          type: string
          description: Name of the product category.
      additionalProperties: false
    ProductCategoryCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^pcat_
          description: Unique identifier for the product category (`pcat_…`).
      additionalProperties: false
    SiteAccessHoursDay:
      type: object
      description: Access Hours Day
      required:
        - close
        - open
        - status
      properties:
        close:
          type:
            - string
            - 'null'
          description: >-
            Closing time in 24-hour `HH:MM` format. Has `null` for `appointment`
            or `closed` status.
        open:
          type:
            - string
            - 'null'
          description: >-
            Opening time in 24-hour `HH:MM` format. Has `null` for `appointment`
            or `closed` status.
        status:
          type: string
          enum:
            - set_hours
            - appointment
            - closed
          description: >-
            Access on the day: `set_hours` between `open` and `close`,
            `appointment` by appointment only, or `closed`.
      additionalProperties: false
    UnitExpandableWithoutUnitAllocation:
      type: object
      description: Unit
      required:
        - id
        - created_at
        - reference_id
        - status
        - unit_type
        - updated_at
      properties:
        id:
          type: string
          pattern: ^unit_
          description: Unique identifier for the unit (`unit_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time for the unit.
        reference_id:
          type: string
          description: Reference identifier for the unit.
        status:
          type: string
          enum:
            - available
            - occupied
            - overlock
            - repossessed
            - reserved
            - unavailable
          description: Status of the unit.
        unit_type:
          anyOf:
            - $ref: '#/components/schemas/UnitTypeExpandableWithoutPrices'
            - $ref: '#/components/schemas/UnitTypeCollapsed'
          description: >-
            Unit type associated with the unit. **Expandable** (shows only ID
            when not expanded).
        updated_at:
          type: string
          format: date-time
          description: Last update date and time for the unit.
      additionalProperties: false
    UnitCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^unit_
          description: Unique identifier for the unit (`unit_…`).
      additionalProperties: false
  securitySchemes:
    Bearer:
      description: Bearer Token necessary to use API
      type: http
      scheme: bearer
      bearerFormat: token
    OAuth2:
      type: oauth2
      description: OAuth 2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://public-api.stora.co/oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.opportunity:read: Opportunity (Read)
            public.opportunity:write: Opportunity (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.price_adjustment:read: Price Adjustment (Read)
            public.price_adjustment:skip_notifications: Price Adjustment (Skip notifications)
            public.price_adjustment:write: Price Adjustment (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)
        authorizationCode:
          authorizationUrl: https://app.stora.co/oauth2/authorize
          tokenUrl: https://public-api.stora.co/oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.opportunity:read: Opportunity (Read)
            public.opportunity:write: Opportunity (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.price_adjustment:read: Price Adjustment (Read)
            public.price_adjustment:skip_notifications: Price Adjustment (Skip notifications)
            public.price_adjustment:write: Price Adjustment (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.