# Get all active and upcoming custom rates for a listing.

`GET /listings/{listing_id}/custom_rates`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-custom-rates · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetCustomRates` · Tag: Custom Rates

Returns all custom rate periods that are currently active and affect future stay dates.
Expired rate periods (those whose `expires_at` timestamp has passed) are excluded.

This is the state of the listing's custom rates now, not their history. For a record of
when custom rates were added, split or removed, and by whom, read the listing's
[changelog](https://docs.usewheelhouse.com/rm/reference/rm-get-preferences-changelog.md) and look for `Custom rates` events.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/custom_rates`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Read-only keys can call this endpoint.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/custom_rates?channel=<channel>' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

The list of active and upcoming custom rate periods.

Body (`application/json`): array of object `rate_period_response`

A custom rate period.

- `id` (integer): The Wheelhouse internal rate period ID.
- `listing_id` (integer): The Wheelhouse internal listing ID.
- `rate_type` (string, one of: `fixed`, `adjustment`): The type of custom rate. `fixed` means a fixed nightly price; `adjustment` means a percentage adjustment to the Wheelhouse recommendation. Note: when reading prices via `GET /listings/{listing_id}/price_recommendations`, an `adjustment` rate appears as `custom_type: "adjusted"` (past-tense form).
- `currency` (string, nullable): The currency of the fixed rate (ISO-4217). Only present for `fixed` type rates.
- `start_date` (string (date)): The first date of the rate period (YYYY-MM-DD).
- `end_date` (string (date)): The last date of the rate period (YYYY-MM-DD).
- `sunday` (number, nullable): Sunday price or adjustment value.
- `monday` (number, nullable): Monday price or adjustment value.
- `tuesday` (number, nullable): Tuesday price or adjustment value.
- `wednesday` (number, nullable): Wednesday price or adjustment value.
- `thursday` (number, nullable): Thursday price or adjustment value.
- `friday` (number, nullable): Friday price or adjustment value.
- `saturday` (number, nullable): Saturday price or adjustment value.
- `created_user_id` (integer): The ID of the user who created this rate period.
- `split_user_id` (integer, nullable): When a PUT or DELETE operation partially overlaps this rate period, causing it to be shortened or split, this field records the ID of the user whose request triggered the split. Null if the period has never been split.
- `expires_at` (string (date-time), nullable): The date-time after which this rate period is considered expired and no longer applies. Null if the period does not expire automatically.
- `valid_until` (string (date-time), nullable): Internal archival timestamp. Null means this is the currently active rate period. Non-null means this period has been replaced or deleted — the replacement took effect at this time.
- `created_at` (string (date-time)): When this rate period was created (ISO-8601).
- `updated_at` (string (date-time)): When this rate period was last updated (ISO-8601).

Example shape (generated from the schema; placeholder values, not a real response):

```json
[
  {
    "id": 0,
    "listing_id": 0,
    "rate_type": "fixed",
    "currency": "string",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "sunday": 0,
    "monday": 0,
    "tuesday": 0,
    "wednesday": 0,
    "thursday": 0,
    "friday": 0,
    "saturday": 0,
    "created_user_id": 0,
    "split_user_id": 0,
    "expires_at": "2026-01-01T00:00:00Z",
    "valid_until": "2026-01-01T00:00:00Z",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  }
]
```

### 401

API key authorization failed.

### 403

Listing authorization failed.

### 404

Listing not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```
