Bookings

Request to book

Turn an open quote into a booking. Set house_rules_accepted only after the guest agreed to the quote's house_rules. If the response has payment_url, the guest must open it and add a card within 60 minutes before the host gets the request.

post/v1/booking_requests

Request

  • Base URL: https://threshold.rentals/api
  • URL: https://threshold.rentals/api/v1/booking_requests
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique per attempt (e.g. a UUID). Retrying with the same key returns the original response instead of acting twice.

Request body

quote_idstring required
house_rules_acceptedtrue required
special_requestsstring

Shown to the host with the request

Response

The booking, with links for the guest

guest_status_urlstring uri

Private page for the guest to follow, pay, message or cancel

payment_urlstring uri

Give to the guest: a secure Stripe page to add a card within 60 minutes

agent_paymentobject

Present when you can pay with a Stripe shared payment token instead of payment_url; see instructions.

Example response

{
  "booking": {
    "check_in": "2026-11-13",
    "check_out": "2026-11-13",
    "total": {
      "currency": "USD"
    },
    "amount_paid": {
      "currency": "USD"
    },
    "amount_refunded": {
      "currency": "USD"
    },
    "refund_schedule": [
      {
        "refund": {
          "currency": "USD"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.