---
title: "Retrieve all resource rates."
method: GET
path: "/api/v2/organizations/{orgSlug}/resource-rates"
tags: ["Resource Rates"]
---

# Retrieve all resource rates.

`GET /api/v2/organizations/{orgSlug}/resource-rates`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/resource-rates`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.billing.resourceRates.read`

Retrieve all resource rates. 

 Required scopes: `flex.billing.resourceRates.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `createdAt` string
- `modifiedAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` ResourceRateResultDto[]
    - `_id` string: The _id of the rate.
    - `name` string: The name of the rate in hand.
    - `code` string: A unique code to identify the rate.
    - `description` string: A short description of the rate.
    - `type` string: The type of the rate.
    - `intervalLength` 'once' | 'hour' | 'day' | 'month': The type of interval of the rate.
    - `intervalCount` number: The amount of intervals of the rate.
    - `price` number: The price of the main component - i.e. either price per hour or price per day.
    - `shouldProrate` boolean: Shows if the rate has proration
    - `useCoins` boolean: Shows if coins can be used in the rate.
    - `rates` RateComponentDto[]: An array containing the secondary components of the rate.
      - `_id` string: The _id of the rate component.
      - `price` number: The price of the secondary component.
      - `intervalLength` 'hour' | 'day' | 'week' | 'month': Depending on the type of the component can be either hour, day, week or month.
      - `intervalCount` number: Can be either 1 or 4 depending on the type of rate. 1 is used for most rates, 4 is used only for half-day rates. This is used for internal calculations mainly.
      - `isOffRate` boolean: Determines if the rate is a non-business hours rate. If the parameter is missing then it's considered false.
      - `isWeekendRate` boolean: Determines if the rate is a weekend rate. If the parameter is missing then it's considered false.
      - `isHalfDayRate` boolean: Determines if the rate is a half-day rate. If the parameter is missing then it's considered false.
    - `extras` string[]: An array with all the extras in the rate.
    - `revenueAccount` string: The _id of the revenue account with which the rate is associated. If missing, the default "Booking fees" account rate will be used.
    - `locations` string[]: An array of location _ids, that determine for which location the plan is valid. If empty, the rate can be used for all locations.
    - `amenities` string[]: An array of amenity _ids, that determine which amenities are available for this rate.
    - `createdAt` string, date-time: The time at which the rate was created.
    - `createdBy` string: The _id of the user that created the rate.

---

[API](https://skmtc.dev/officernd/apis/billing-product-api.md) - [All operations](https://skmtc.dev/officernd/apis/billing-product-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/billing-product-api/revisions/78f9c9851fb0?raw)