HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner Contract / Start offboarding

Experimental endpoint — not yet a stable contract. This action ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Start offboarding the partner contract, with the same rules as the Start offboarding action in the admin panel. The status becomes offboarding, the contract end date is set to endDate and all charge points of the contract are set to Disabled. The charge points are disabled in the background after the response, so they can still be Enabled when the response is returned.

Monthly platform fees continue until the end date for the charge points that would have been billed when offboarding started. After the end date the status becomes ended.

Available only while the contract is active; in any other status the action returns 409 and nothing is changed. An end date before today in the operator's timezone returns 422 with "The end date can't be in the past.". An end date before the contract's start date returns 422 with "The end date can't be before the contract's start date.".

The API token's administrator may run this action when they may update the partner contract. Partner administrators cannot run it.

Required permission: PartnerContracts.update

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

The ID of the partner contract

Body Params
date-time
required

The last day of the contract, inclusive, ending at midnight in the operator's timezone. Must be today or later and not before the contract start date.

Responses

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