Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Rates

Get rate pricing

Returns prices for a given rate for a specified time interval. Prices will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one price for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two prices for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see Time units.

post/api/connector/v1/rates/getPricing

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

RateIdstring uuid required

Unique identifier of the Rate.

ProductIdstring uuid nullable

Unique identifier of the Product.

FirstTimeUnitStartUtcstring date-time required

Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.

LastTimeUnitStartUtcstring date-time required

End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 24 months if months.

Response

OK

Currencystring required

ISO-4217 code of the Currency.

DatesUtcstring[] nullable
TimeUnitStartsUtcstring[] required

Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.

BasePricesnumber[] required
RelativeAdjustmentnumber double

Specific amount which shows the difference between this rate and the base rate.

AbsoluteAdjustmentnumber double

Relative amount which shows the difference between this rate and the base rate.

EmptyUnitAdjustmentnumber double

Price adjustment for when the resource booked with this rate is not full to capacity.

ExtraUnitAdjustmentnumber double

Price adjustment for when the resource booked with this rate exceeds capacity.