HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Tariff / Scheduled Change / Update

Update a pending scheduled pricing change. Not allowed on derived tariffs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
integer
required
Body Params
date-time

The UTC date/time when the pricing change takes effect. Must be a future datetime. Seconds and sub-second components are truncated to :00 (stored at minute precision).

string
string
enum

Tariff type. Changing type clears incompatible pricing data.

description
object | null

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

additionalInformation
object | null

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

learnMoreUrl
object | null

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

string

A time when the day begins

string

A time when the night begins

pricing
object
stopSession
object
display
object
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json