Monta
Monta API
Monta API

Tariff Period Groups

Retrieve Tariff Period Groups by tariff id

GET
https://partner-api.monta.com
/api/v1/tariff-period-groups

Required scope: tariff:read

Retrieve Tariff Period Groups by tariff id › query Parameters

tariffId
​integer · int64

Filter to retrieve tariff period groups by tariff id

Retrieve Tariff Period Groups by tariff id › Responses

Tariff period group with provided tariff id

TariffPeriodGroup
activeFrom
​string · date · required

tariff period group active from date

activeTo
​string · date · required

tariff period group active to date

description
​string · required

tariff period group description

id
​integer · int64

tariff period group id

tariffId
​integer · int64

tariff id

Create a new Tariff Period Group.

POST
https://partner-api.monta.com
/api/v1/tariff-period-groups

Required scope: tariffs:write
Note: Once you are done with creating/updating tariffs and its components you have to call the create-prices endpoint to create the prices for the tariff.

Create a new Tariff Period Group. › Request Body

TariffPeriodGroup_1
activeFrom
​string · date · required

tariff period group active from date

activeTo
​string · date · required

tariff period group active to date

description
​string · required

tariff period group description

tariffId
​integer · int64

tariff id

Create a new Tariff Period Group. › Responses

New Tariff Period Group

TariffPeriodGroup
activeFrom
​string · date · required

tariff period group active from date

activeTo
​string · date · required

tariff period group active to date

description
​string · required

tariff period group description

id
​integer · int64

tariff period group id

tariffId
​integer · int64

tariff id

Retrieve Tariff Period Groups by id

GET
https://partner-api.monta.com
/api/v1/tariff-period-groups/{id}

Required scope: tariff:read

Retrieve Tariff Period Groups by id › path Parameters

id
​integer · int64 · required

Filter to retrieve tariff period groups by id

Retrieve Tariff Period Groups by id › Responses

Tariff period group with provided group id

TariffPeriodGroup
activeFrom
​string · date · required

tariff period group active from date

activeTo
​string · date · required

tariff period group active to date

description
​string · required

tariff period group description

id
​integer · int64

tariff period group id

tariffId
​integer · int64

tariff id

Update existing Tariff Period Group.

PATCH
https://partner-api.monta.com
/api/v1/tariff-period-groups/{id}

Required scope: tariffs:write
Note: Once you are done with creating/updating tariffs and its components you have to call the create-prices endpoint to create the prices for the tariff.

Update existing Tariff Period Group. › path Parameters

id
​integer · int64 · required

Update existing Tariff Period Group. › Request Body

TariffPeriodGroup_2
activeFrom
​string | null · date

tariff period group active from date

activeTo
​string | null · date

tariff period group active to date

description
​string | null

tariff period group description

Update existing Tariff Period Group. › Responses

Updated Tariff Period Group

TariffPeriodGroup
activeFrom
​string · date · required

tariff period group active from date

activeTo
​string · date · required

tariff period group active to date

description
​string · required

tariff period group description

id
​integer · int64

tariff period group id

tariffId
​integer · int64

tariff id

Delete an existing Tariff Period Group, and all contained recurring periods and prices.

DELETE
https://partner-api.monta.com
/api/v1/tariff-period-groups/{id}

Required scope: tariffs:delete
Note: Once you are done with creating/updating tariffs and its components you have to call the create-prices endpoint to create the prices for the tariff.

Delete an existing Tariff Period Group, and all contained recurring periods and prices. › path Parameters

id
​integer · int64 · required

Delete an existing Tariff Period Group, and all contained recurring periods and prices. › Responses

Tariff Period Group deleted

No data returned
TariffTariff Recurring Periods