Periods

Overview

This resource represents Periods which define the timeline for applicability of the Seasons.

Parameters

OAuth Scopes:

rates_read

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Period
season	Integer	Read	Season's ID related to the Period
rates_table	Integer	Read	Rates Table's ID related to the Period
id	Integer	Read	Period's id.
created_at	Time	Read	Period's create time.
updated_at	Time	Read	Period's update time.
start_date	Date	Read	Period's start date.
end_date	Date	Read	Period's end date.
archived_at	Time	Read	Period's archived time.

rates_write

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to the Period
season	Integer	Read	Season's ID related to the Period
rates_table	Integer	Read	Rates Table's ID related to the Period
id	Integer	Read	Period's id.
created_at	Time	Read	Period's create time.
updated_at	Time	Read	Period's update time.
start_date	Date	Read/Write	Period's start date.	Required, must be before end_date
end_date	Date	Read/Write	Period's end date.	Required, must be after start_date, the maximum allowed value is 3 years from the current date
archived_at	Time	Read	Period's archived time.

List periods

List all periods for a given account.

GET /periods

OAuth Scopes:

rates_read / rates_write

response.json

{
  "links": {
    "periods.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{periods.rates_table}",
    "periods.season": "https://www.bookingsync.com/api/v3/seasons/{periods.season}"
  },
  "periods": [
    {
      "links": {
        "rates_table": 5,
        "season": 12
      },
      "id": 232,
      "start_date": "2026-09-02",
      "end_date": "2026-09-09",
      "created_at": "2026-08-12T03:04:38.248Z",
      "updated_at": "2026-08-19T03:04:38.248Z"
    }
  ]
}

Get a single period

Returns a single period identified by ID.

GET /periods/:period_id

OAuth Scopes:

rates_read / rates_write

response.json

{
  "links": {
    "periods.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{periods.rates_table}",
    "periods.season": "https://www.bookingsync.com/api/v3/seasons/{periods.season}"
  },
  "periods": [
    {
      "links": {
        "rates_table": 5,
        "season": 12
      },
      "id": 232,
      "start_date": "2026-09-02",
      "end_date": "2026-09-09",
      "created_at": "2026-08-12T03:04:38.251Z",
      "updated_at": "2026-08-19T03:04:38.251Z"
    }
  ]
}

Create a new period

Creates a period for given season.

POST /seasons/:season_id/periods

OAuth Scopes:

rates_write

request.json

{
  "periods": [
    {
      "start_date": "2026-09-02",
      "end_date": "2026-09-09"
    }
  ]
}

response.json

{
  "links": {
    "periods.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{periods.rates_table}",
    "periods.season": "https://www.bookingsync.com/api/v3/seasons/{periods.season}"
  },
  "periods": [
    {
      "links": {
        "rates_table": 5,
        "season": 12
      },
      "id": 232,
      "start_date": "2026-09-02",
      "end_date": "2026-09-09",
      "created_at": "2026-08-12T03:04:38.253Z",
      "updated_at": "2026-08-19T03:04:38.253Z"
    }
  ]
}

Update a period

Returns an updated period identified by ID.

PUT /periods/:period_id

OAuth Scopes:

rates_write

request.json

{
  "periods": [
    {
      "start_date": "2026-09-02",
      "end_date": "2026-09-09"
    }
  ]
}

response.json

{
  "links": {
    "periods.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{periods.rates_table}",
    "periods.season": "https://www.bookingsync.com/api/v3/seasons/{periods.season}"
  },
  "periods": [
    {
      "links": {
        "rates_table": 5,
        "season": 12
      },
      "id": 232,
      "start_date": "2026-09-02",
      "end_date": "2026-09-09",
      "created_at": "2026-08-12T03:04:38.254Z",
      "updated_at": "2026-08-19T03:04:38.254Z"
    }
  ]
}

Destroy a period

Required OAuth scope: :rates_write

Returns an empty response with 204 No Content status code on success.

DELETE /periods/:period_id