Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Channex Rate Plans API

Manage pricing plans for room types.

Channex Rate Plans API is one of 7 APIs that Channex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rate Plans. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://secure.channex.io/api/v1, https://staging.channex.io/api/v1.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://secure.channex.io/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Channex Rate Plans API declares 1 security scheme for authenticating requests. An API key is passed in the header as user-api-key (userApiKey). By default, every request must be authenticated.

  • userApiKey — Channex API key passed in the user-api-key request header. Generate a key in the Channex application under your account settings.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Rate Plans 6

Manage pricing plans for room types.

GET
/rate_plans
List rate plans
listRatePlans 3 params → 200
POST
/rate_plans
Create a rate plan
createRatePlan body → 201
GET
/rate_plans/options
List rate plan options
listRatePlanOptions → 200
GET
/rate_plans/{id}
Get a rate plan
getRatePlan 1 param → 200
PUT
/rate_plans/{id}
Update a rate plan
updateRatePlan 1 param body → 200
DELETE
/rate_plans/{id}
Delete a rate plan
deleteRatePlan 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are RatePlanAttributes (17 properties), RatePlan (3 properties), RatePlanList (2 properties), RatePlanWriteRequest (1 property). Each schema is shown below with its type and property counts.

RatePlan
object
3 properties
RatePlanResponse
object
1 property
RatePlanList
object
2 properties
RatePlanAttributes
object
17 properties 3 required
OptionsList
object
1 property
RatePlanWriteRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

channex-rate-plans-api-openapi.yml Raw ↑

Other APIs Channex publishes across the network.

Channex ARI API
Channex Bookings API
Channex Channels API
Channex Properties API
Channex Room Types API
Channex Webhooks API