---
title: "Preview how a folio adjustment (tax/fee/rate/room-revenue) would affect Smart Policy scheduled payments."
method: POST
path: "/smart-policies/v1/payments/preview-adjustment"
tags: ["Smart Policies"]
---

# Preview how a folio adjustment (tax/fee/rate/room-revenue) would affect Smart Policy scheduled payments.

`POST /smart-policies/v1/payments/preview-adjustment`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/smart-policies/v1/payments/preview-adjustment`
- Auth: OAuth 2
  - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
  - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:rate`

## Headers

- `x-property-id` string, required

## Request body

- PreviewAdjustmentRequestSchema
  - `reservationId` string, required: Reservation ID to preview the adjustment for.
  - `adjustment` PreviewAdjustmentInputSchema, required
    - `target` 'TAX' | 'FEE' | 'RATE' | 'ROOM_REVENUE', required: The type of adjustment to preview.
    - `token` string, required: Folio adjustment id token, exactly as the save receives it (e.g. 'tax_42', 'fee_7', 'rate', 'roomRevenue_manual').
    - `amount` SmartPolicyMoneyInputSchema, required: Money input as per the REST API Modeling Specification: amount in the smallest representable units of the currency, paired with an ISO 4217 currency code.
      - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD).
      - `currencyCode` string, required: ISO 4217 currency code.
    - `bookingRoomId` string, nullable: Booking room id the adjustment targets (rate / room-revenue).
    - `rateSourceId` string, nullable: Rate source id — required for RATE adjustments to resolve the applicable taxes/fees.
    - `isRootSource` boolean, nullable: Whether the rate source is a root source (RATE adjustments).
    - `isHotelCollectBooking` boolean, nullable: Whether the booking is hotel-collect (RATE adjustments).

## Response `200`

Adjustment preview result.

- PreviewAdjustmentResponseSchema
  - `resultType` 'SCHEDULED_PAYMENT_REDUCED' | 'SCHEDULED_PAYMENT_CANCELLED' | 'REFUND_REQUIRED' | 'NO_SCHEDULE_CHANGE' | 'NO_SMART_POLICY': The outcome of the adjustment preview.
  - `newReservationTotal` MoneySchema: Money representation with amount in smallest currency unit and ISO 4217 currency code
    - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD). For example, USD $124.39 would be "12439".
    - `currencyCode` string, required: ISO 4217 currency code
  - `alreadyPaid` MoneySchema: Money representation with amount in smallest currency unit and ISO 4217 currency code
    - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD). For example, USD $124.39 would be "12439".
    - `currencyCode` string, required: ISO 4217 currency code
  - `refundRequired` MoneySchema: Money representation with amount in smallest currency unit and ISO 4217 currency code
    - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD). For example, USD $124.39 would be "12439".
    - `currencyCode` string, required: ISO 4217 currency code
  - `scheduledPayments` PreviewScheduledPaymentSchema[]
    - `id` string
    - `originalAmount` MoneySchema: Money representation with amount in smallest currency unit and ISO 4217 currency code
      - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD). For example, USD $124.39 would be "12439".
      - `currencyCode` string, required: ISO 4217 currency code
    - `newAmount` MoneySchema: Money representation with amount in smallest currency unit and ISO 4217 currency code
      - `amount` string, required: Amount in the smallest representable units of the currency (e.g., cents for USD). For example, USD $124.39 would be "12439".
      - `currencyCode` string, required: ISO 4217 currency code
    - `status` 'REDUCED' | 'CANCELLED' | 'UNCHANGED': Status of the scheduled payment after the adjustment.

## Other responses

- `400`: Bad request response.
- `403`: Forbidden response.
- `500`: Internal server error.

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/revisions/69bffac143cc?raw)