Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Resource Rates

Retrieve single resource rate.

Retrieve single resource rate.

Required scopes: flex.billing.resourceRates.read

get/api/v2/organizations/{orgSlug}/resource-rates/{resourceRateId}

Path parameters

resourceRateIdstring required

resource rate id

orgSlugstring required

organization slug

Response

_idstring

The _id of the rate.

namestring

The name of the rate in hand.

codestring

A unique code to identify the rate.

descriptionstring

A short description of the rate.

typestring

The type of the rate.

intervalLength'once' | 'hour' | 'day' | 'month'

The type of interval of the rate.

intervalCountnumber

The amount of intervals of the rate.

pricenumber

The price of the main component - i.e. either price per hour or price per day.

shouldProrateboolean

Shows if the rate has proration

useCoinsboolean

Shows if coins can be used in the rate.

extrasstring[]

An array with all the extras in the rate.

revenueAccountstring

The _id of the revenue account with which the rate is associated. If missing, the default "Booking fees" account rate will be used.

locationsstring[]

An array of location _ids, that determine for which location the plan is valid. If empty, the rate can be used for all locations.

amenitiesstring[]

An array of amenity _ids, that determine which amenities are available for this rate.

createdAtstring date-time

The time at which the rate was created.

createdBystring

The _id of the user that created the rate.

Example response

{
  "_id": "6080186f490fcf6e0537ec52",
  "name": "Rate 1",
  "code": "EXMPL",
  "description": "Example description",
  "type": "meeting_room",
  "intervalCount": 3,
  "price": 45,
  "shouldProrate": true,
  "useCoins": true,
  "rates": [
    {
      "_id": "67a2048010bab41f9aed3512",
      "price": 150,
      "intervalLength": "hour",
      "intervalCount": 4,
      "isWeekendRate": true,
      "isHalfDayRate": true
    },
    {
      "_id": "67a2048010bab41f9aed35df",
      "price": 14,
      "intervalLength": "week",
      "intervalCount": 1
    }
  ],
  "extras": [
    "6080186f490fcf6e0537eb20",
    "6080186f490fcf6e0537eb25"
  ],
  "revenueAccount": "6080186f490fcf6e0537ed15",
  "locations": [
    "6080186f490fcf6e0537eb22",
    "6080186f490fcf6e0537eb29"
  ],
  "amenities": [
    "6080186f490fcf6e0537eb21",
    "6080186f490fcf6e0537eb23"
  ],
  "createdAt": "2021-04-21T18:00:00.000Z",
  "createdBy": "5bbb155174321f100085eac1"
}