Update

API Reference

V1

Contracts

Rate Cards

Named Schedules

Update a contract's named schedule

v1.contracts.rate_cards.named_schedules.update(NamedScheduleUpdateParams**kwargs)

post/v1/contracts/updateNamedSchedule

Update a named schedule for the given contract. This endpoint's availability is dependent on your client's configuration.

Parameters

contract_idstr

ID of the contract whose named schedule is to be updated

formatuuid

customer_idstr

ID of the customer whose named schedule is to be updated

formatuuid

schedule_namestr

The identifier for the schedule to be updated

starting_atunion

Union[str, datetime]

formatdate-time

valueobject

The value to set for the named schedule. The structure of this object is specific to the named schedule.

ending_beforeunion

optional

Union[str, datetime]

formatdate-time

HTTPTypeScriptPythonGoRubyTerraform

from datetime import datetime
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
client.v1.contracts.rate_cards.named_schedules.update(
    contract_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    customer_id="9b85c1c1-5238-4f2a-a409-61412905e1e1",
    schedule_name="my-schedule",
    starting_at=datetime.fromisoformat("2022-02-01T00:00:00"),
    value={
        "my_key": "my_value"
    },
    ending_before=datetime.fromisoformat("2022-02-15T00:00:00"),
)