v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Resource Rates

Retrieve all resource rates.

Required scopes: flex.billing.resourceRates.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_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"
    }
  ]
}