Get the rendered smart policy text and scheduled payments for a reservation.

get/smart-policies/v1/reservations/{reservationId}/policy-information

Request

Base URL
https://api.cloudbeds.com
URL
https://api.cloudbeds.com/smart-policies/v1/reservations/{reservationId}/policy-information
Auth
OAuth 2
Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:reservation

Path parameters

reservationIdReservationId required(unresolved $ref)

Reservation identifier.

Query parameters

languageCodestring nullable

Language code for the rendered policy text (e.g. "fr", "en-US"). Defaults to the property's language when omitted.

Headers

x-property-idstring required

Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

Policy information for the reservation. When the reservation is not governed by a smart policy, falls back to the property's legacy cancellation policy text (policyTextSource="legacy"); when neither is available, returns a null policyText rather than an error.

policyTextSource'smart' | 'legacy' nullable required

Where policyText came from: "smart" when rendered from the reservation's smart policy, "legacy" when it is the property's legacy cancellation policy text. Null when policyText is null.

Example response

{
  "policyText": {
    "id": "42310212898960",
    "name": "Standard 3-day policy",
    "rootId": "42310212898960",
    "guaranteeText": "A deposit of 20% is collected at the time of booking.",
    "cancellationText": "Free cancellation until 3 days before check-in; the deposit is forfeited afterwards.",
    "noShowText": "No-shows are charged the full reservation amount.",
    "cancellationType": {
      "text": "Fully refundable until Nov 8, 2026",
      "type": "FULLY_REFUNDABLE",
      "fullyRefundableUntilDaysBeforeCheckIn": 3,
      "fullyRefundableUntilDaysBeforeDate": "2026-11-08",
      "fullyRefundableUntilDateTime": "2026-11-08T15:00:00+00:00",
      "fullyRefundableUntilMinutesBeforeCheckIn": 4320
    },
    "paymentSummaryRows": [
      {
        "timingLabel": "Until Nov 8, 2026",
        "actionCopy": "Free cancellation",
        "detail": "Full refund of the deposit.",
        "anchor": "CHECK_IN",
        "anchorOffsetMinutes": -1440,
        "dateTime": "2026-11-08T00:00:00+00:00"
      }
    ],
    "cancellationSummaryRows": [
      {
        "timingLabel": "Until Nov 8, 2026",
        "actionCopy": "Free cancellation",
        "detail": "Full refund of the deposit.",
        "anchor": "CHECK_IN",
        "anchorOffsetMinutes": -1440,
        "dateTime": "2026-11-08T00:00:00+00:00"
      }
    ],
    "noShowSummaryRows": [
      {
        "timingLabel": "Until Nov 8, 2026",
        "actionCopy": "Free cancellation",
        "detail": "Full refund of the deposit.",
        "anchor": "CHECK_IN",
        "anchorOffsetMinutes": -1440,
        "dateTime": "2026-11-08T00:00:00+00:00"
      }
    ]
  },
  "scheduledPayments": [
    {
      "formattedDate": "Nov 10, 2026",
      "formattedAmountWithIsoCode": "USD 100.00",
      "formattedAmountWithSymbol": "$100.00",
      "type": "deposit"
    }
  ],
  "policyTextSource": "smart"
}

Changes

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