We’ve migrated our documentation to a new site, which means some URLs have changed.
Subscriptions
Subscriptions
Breadcrumbs

How to update a Site licensing schedule via API

It's possible to easily update a Site License Contract schedule via the UI in the Piano dashboard under Manage → Site Licenses:

SL_1.png

When doing this, you will be automatically prompted to also update the schedule for any active subscriptions. This will update all contract subscriptions/accesses linked to the schedule.

When doing the schedule update via API, it's necessary to execute 2 calls to API endpoints, so that the schedule will be changed and also any subscriptions with this schedule updated.

  1. Call /publisher/schedule/period/update (API docs) or /publisher/schedule/update (API docs) - to update the schedule

  2. Call /publisher/licensing/schedule/contract/periods/activate (API docs) - to activate the updated schedule for any active subscriptions/accesses for the schedule_id specified

    If you'd like to update the schedule only for a specific contract, you can do so by calling the endpoint /publisher/licensing/contract/periods/activate (API docs) with the relevant contract_id

Last updated: