VRPlatformVRPlatform
Recurring feesListing periods

/recurring-fees/listing-periods

List recurring fee listing periods

GET
/recurring-fees/listing-periods
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

recurringFeeId?string
listingId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
date?string

Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD.

Formatvrp-date-boundary
recurringFeeType?string
Value in"managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee"
limit?number
Default100
Range1 <= value <= 250
page?number
Default1
Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/recurring-fees/listing-periods"
{
  "data": [
    {
      "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
      "startAt": "string",
      "endAt": "string",
      "rate": -9007199254740991,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "recurringFee": {
        "id": "string",
        "name": "string",
        "type": "managementFee",
        "rateType": "flat",
        "defaultRate": -9007199254740991
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}