API Reference

Update an existing Rate Plan.

patch
https://api.cloudbeds.com/rates/v1/rate-plans/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Rate Plan ID.

Body Params

Rate Plan data.

string
required

Rate Plan ID.

boolean

Whether the rate plan is active.

string | null

The allotment block's ID this rate belongs to.

string | null

Promotional code for the rate plan.

sources
array of strings | null

List of sources for the rate plan.

sources
float | null
Defaults to 0

Value for the derived rate plan.

integer | null

Derived rate plan ID.

string
enum
Defaults to fixed

Rate plan derived type.

Allowed:
name
object | null

Name in multiple languages.

description
object | null

Description in multiple languages.

namePrivate
object | null

Internal name in multiple languages.

terms
object | null

Terms and conditions in multiple languages.

intervals
array of objects | null

List of rate plan intervals.

intervals
addons
array of objects | null

List of addons for the rate plan. Omitted or null leaves the current addons unchanged; an empty array removes all of them.

addons
integer | null

Segment ID associated with the rate plan.

integer | null

Policy ID associated with the rate plan.

Headers
string
required

A numeric, comma-separated string representing the property IDs, sent in the header.

Responses

Updated 9 days ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago

Did this page help you?