HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner Contract / Disable

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.

End the partner contract now, with the same rules as the Disable action in the admin panel. The contract end date is set to today in the operator's timezone and the status becomes ended. Monthly platform fees stop after the month of the end date.

When disableChargePoints is true, all charge points of the contract are set to Disabled. This happens in the background after the response, so the charge points can still be Enabled when the response is returned. Reactivating the contract enables them again.

Available only while the contract is active or offboarding; in any other status the action returns 409 and nothing is changed.

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
boolean
required

When true, all charge points of the contract are also set to Disabled.

Responses

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