Method to retrieve current pricing schemes applied

Table of Contents
  1. URL Endpoint
  2. Method Parameters
  3. Method Output

URL Endpoint

/schemes/plan

Warning

This method is only accessible using a Hotelier API account.

This method is only accessible using a GET request.

This method is only available in JSON. Make sure you send the Accept: application/json header.

Terms

This method should be called only for user-initiated actions.

Scheduled (automated) calls on this method are only allowed if they happen a few times per day.

This method is NOT a replacement of channel-management functionality.

This method should NOT be used to feed 3rd party systems without our consent.

API usage is closely monitored and improper usage will result in a ban.


Method parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
from date (ISO 8601) * YES &from=2024-02-22  
to date (ISO 8601) from + 2 years YES &to=2025-02-22  

Method Output

[
	{
		"date":ISO 8601, // Date
		"scheme":VARCHAR, // Scheme code
		"color":VARCHAR // HEX color code of scheme to optionally be used for UI
	}
]