HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Churn record / Record exit

⚠️ Experimental endpoint — not yet a stable contract. This resource 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.

Record an exit that happened outside the platform, for example a dismounted home charger or an ended partner contract. The token's admin is recorded as the actor and the entry is marked as recorded by an integration. When the user starts a charging session after the exit date, a recovered entry is added automatically.

Only one exit is kept per user or partner: when an exit without a return already exists within 7 days of exitedOn, it is returned instead of adding a new one, and the given reason is added to it if it has none. Sending an externalReference already used by the operator returns that entry unchanged, so retries are safe.

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

ID of the user who left the home charger. Required when the home charger has no owner; rejected when it has one and for other subject types.

date
required

Date of the exit, today or earlier in the operator's time zone. The user's partners on this date are recorded with the exit.

churnReason
object
required

Why the subject left. Required, with either reasonId or customReason and exitType. An empty object is rejected with a validation error. The reason must apply to users, or to partners and the partner's category for a partner subject. Custom reasons allow the chose_to_leave, forced and circumstances_changed exit types.

string
length ≤ 255

Your reference for the exit, unique per operator. Sending it again returns the existing entry.

Responses

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