Skip to main content

Represents a set of rules that govern charging sessions for fleets, drivers, or vehicles. Policies can be used for both enforcing restrictions and providing charging suggestions.

id
string
required

Unique identifier for the policy object.

Example:

"pol_123abc456def"

object
string
required

String representing the object's type. Always policy.

Example:

"policy"

name
string
required

A human-readable name for the policy.

Example:

"Weekday Daytime Charging"

mode
enum<string>
required

The operational mode of the policy. - enforcement: Strictly enforces rules at the start of a charging session. - suggestion: Provides recommendations for optimal charging, but does not block sessions.

Available options:
enforcement,
suggestion
Example:

"enforcement"

rules
object
required

A set of rules that define the policy's behavior.

status
enum<string>
required

The current status of the policy. Only active policies are evaluated.

Available options:
active,
inactive
Example:

"active"

created
integer<unix-time>
required

Time at which the policy was created.

description
string | null

An optional description of the policy's purpose.

Example:

"Allows charging only on weekdays between 9 AM and 5 PM at approved stations."

metadata
object

Set of key-value pairs to store custom structured data.