HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog

Changelog

3.162.0 release notes

  1. ⚠️ Breaking changes
    1. Notes endpoints for Charge Points, EVSEs, Locations, Partners, and Sub-operators (/resources/charge-points/v2.0/{chargePoint}/notes, /resources/evses/v2.1/{evse}/notes, /resources/locations/v2.0/{location}/notes, /resources/partners/v2.0/{partner}/notes, /resources/sub-operators/v2.0/{subOperator}/notes) now require view permission on the parent resource. Requests without this permission will receive a 403 response.
  2. New features
    1. Added new Subscription Billing Periods endpoints: GET /resources/users/v1.0/{user}/subscription-billing-periods and GET /resources/users/v1.0/{user}/subscription-billing-periods/{billingPeriod}. These return billing period details including amounts, fees, currency, payment failure information, and obligation transfer timestamps. The listing endpoint supports filtering by subscriptionPlanId, subscriptionId, date ranges (startedAfter, startedBefore, endedAfter, endedBefore), and hasUnresolvedPaymentFailure.
    2. Added the optional emi3Id property to EVSE responses on GET /resources/charge-points/v2.0/{chargePoint}/evses, POST /resources/charge-points/v2.0/{chargePoint}/evses, GET /resources/charge-points/v2.0/{chargePoint}/evses/{evse}, PATCH /resources/charge-points/v2.0/{chargePoint}/evses/{evse}, GET /resources/evses/v2.1, POST /resources/evses/v2.1, GET /resources/evses/v2.1/{evse}, and PATCH /resources/evses/v2.1/{evse}. This field contains the eMI3 identifier when available.
    3. Added the optional subscriptionBillingPeriodId and settledByTransactionId properties to Transaction responses on GET /resources/transactions/v1.0, POST /resources/transactions/v1.0, GET /resources/transactions/v1.0/{transaction}, and PATCH /resources/transactions/v1.0/{transaction}. These fields link transactions to their associated subscription billing period and settlement transaction, respectively.
    4. Added new subscriptionBillingPeriodId and settledByTransactionId filter parameters to GET /resources/transactions/v1.0 for filtering transactions by their subscription billing period or settlement transaction.
    5. Added the new corporateBilling.limitReached notification type to all Notifications endpoints (/notifications/v1.0, /notifications/v2.0, and /actions/notifications/v1.0/{notification}/resend), available in both request and response payloads.
  3. 🔧 Improvements
    1. Changed the tokenizationMethod field on Transaction responses to only derive its value from wallet type for Apple Pay and Google Pay wallets. Previously, other wallet types could produce incorrect tokenization method values.

3.161.0 release notes

  1. New features
    1. Added new Sub-operators v2.0 endpoints with full CRUD support: GET /resources/sub-operators/v2.0, POST /resources/sub-operators/v2.0, GET /resources/sub-operators/v2.0/{subOperator}, PATCH /resources/sub-operators/v2.0/{subOperator}, and DELETE /resources/sub-operators/v2.0/{subOperator}. The new version adds create, update, and delete operations alongside the existing list and read capabilities.
    2. Added the optional monitoringEnabled property to EVSE request and response bodies across all EVSE endpoints: GET /resources/charge-points/v2.0/{chargePoint}/evses, POST /resources/charge-points/v2.0/{chargePoint}/evses, GET /resources/charge-points/v2.0/{chargePoint}/evses/{evse}, PATCH /resources/charge-points/v2.0/{chargePoint}/evses/{evse}, GET /resources/evses/v2.1, POST /resources/evses/v2.1, GET /resources/evses/v2.1/{evse}, and PATCH /resources/evses/v2.1/{evse}. Defaults to true when not provided on create/update.
    3. Added the optional userVisibility property to the options object on Partner endpoints: GET /resources/partners/v2.0, POST /resources/partners/v2.0, GET /resources/partners/v2.0/{partner}, and PATCH /resources/partners/v2.0/{partner}. This field replaces the now-deprecated allowViewingUsersWhoAcceptedInvite option.
    4. Added the optional graceTimeEndAt property to charging period objects in Session responses on GET /resources/sessions/v1.0 and GET /resources/sessions/v1.0/{session}. This field is present on idle charging periods when a grace time end is defined.
    5. Added billingCompletedBefore and billingCompletedAfter query filter parameters to GET /resources/sessions/v1.0 for filtering sessions by billing completion date.
    6. Added chargingZoneId query filter parameter to GET /resources/charge-points/v2.0 for filtering charge points by charging zone.
  2. 🗑️ Deprecations
    1. Deprecated the Sub-operators v1.0 endpoints GET /resources/sub-operators/v1.0 and GET /resources/sub-operators/v1.0/{subOperator}. Consumers should migrate to the v2.0 endpoints.
    2. Deprecated the allowViewingUsersWhoAcceptedInvite property in the options object on Partner endpoints. Use the new userVisibility property instead.

3.160.0 release notes

  1. ⚠️ Breaking changes
    1. Removed the operatorId field from update/patch request bodies on the following endpoints: PATCH /resources/downtime-period-notices/v1.0/{notice}, PATCH /resources/electricity-meters/v1.0/{electricityMeter}, PATCH /resources/locations/v2.0/{location}, PATCH /resources/payment-terminals/v1.0/{paymentTerminal}, PATCH /resources/payment-terminals/v1.1/{paymentTerminal}, PUT /resources/tariff-groups/v1.0/{tariffGroup}, PATCH /resources/user-groups/v1.0/USERGROUP, and PUT /resources/tariffs/v1.0/{tariff}. The operatorId remains available on all corresponding create (POST) endpoints.
    2. Removed the acceptedPaymentBrands and paymentOptions fields from the PATCH /resources/locations/v2.0/{location} request body. These fields can no longer be updated via PATCH.
    3. Removed the optional operatorId property from Payment Terminal v1.1 responses on GET /resources/payment-terminals/v1.1, GET /resources/payment-terminals/v1.1/{paymentTerminal}, POST /resources/payment-terminals/v1.1, and PATCH /resources/payment-terminals/v1.1/{paymentTerminal}.
    4. Made name and type required fields on PUT /resources/tariffs/v1.0/{tariff}. Consumers must now include these properties in every PUT request.
  2. New features
    1. Added the optional operatorId property to the POST /resources/subscription-plans/v2.0 request body. The operatorId property is also now included in all Subscription Plans v2.0 responses (GET /resources/subscription-plans/v2.0, GET /resources/subscription-plans/v2.0/{subscriptionPlan}, POST /resources/subscription-plans/v2.0, PATCH /resources/subscription-plans/v2.0/{subscriptionPlan}).
    2. Added the optional operatorId property to the POST /resources/users/v1.1 request body. Required for global admin tokens; defaults to the token's operator for operator-scoped tokens.
    3. Added the optional utilityId property to Electricity Rates v2.0 responses on GET /resources/electricity-rates/v2.0, GET /resources/electricity-rates/v2.0/{electricityRate}, POST /resources/electricity-rates/v2.0, and PATCH /resources/electricity-rates/v2.0/{electricityRate}.
    4. Added multiple optional fields to PUT /resources/tariffs/v1.0/{tariff}: additionalInformation, dayTariffStart, description, display, externalId, integrationId, learnMoreUrl, nightTariffStart, partner, pricing, restrictions, and stopSession.
  3. 🔧 Improvements
    1. Made the operatorId property on POST /resources/configuration-templates/v1.0 writable and nullable. Previously this field was read-only; it can now be set during creation.

3.159.0 release notes

  1. New features
    1. Added the optional stopConditions object to start session request bodies on POST /actions/charge-point/v1.0/{chargePoint}/start, POST /actions/charge-point/v1.0/{chargePoint}/start/{evse}, and POST /actions/evse/v1.0/{evse}/start. Accepts optional fields maxEnergyKwh, maxDurationMinutes, maxSocPercent, and maxAmount to define automatic session stop conditions.
    2. Added the optional countryStationId property to Charge Point request and response bodies on GET /resources/charge-points/v2.0, POST /resources/charge-points/v2.0, GET /resources/charge-points/v2.0/{chargePoint}, and PATCH /resources/charge-points/v2.0/{chargePoint}. Also available as a filter parameter on the listing endpoint.
    3. Added the optional paymentOptions and acceptedPaymentBrands array properties to Location request and response bodies on GET /resources/locations/v2.0, POST /resources/locations/v2.0, GET /resources/locations/v2.0/{location}, and PATCH /resources/locations/v2.0/{location}.
    4. Added the optional schedule includeable property to Circuit responses on GET /resources/circuits/v2.0, POST /resources/circuits/v2.0, GET /resources/circuits/v2.0/{circuit}, and PATCH /resources/circuits/v2.0/{circuit}. Use the include=schedule query parameter to retrieve circuit schedule data.
    5. Added new Circuit Schedule endpoints: GET /resources/circuits/v2.0/{circuit}/schedule to read a schedule, PUT /resources/circuits/v2.0/{circuit}/schedule to create or update a schedule, and DELETE /resources/circuits/v2.0/{circuit}/schedule to remove a schedule. Schedules define time-based current limits with daily or weekly granularity.
    6. Added the optional billingCompletedAt property to Session responses on GET /resources/sessions/v1.0 and GET /resources/sessions/v1.0/{session}. Returns an ISO 8601 timestamp when billing has completed.
    7. Added new endpoint GET /resources/partner-expenses/v1.2 as a replacement for the v1.1 partner expenses listing.
    8. Added new endpoint GET /resources/partner-revenues/v1.2 as a replacement for the v1.1 partner revenues listing.
    9. Added createdAfter and createdBefore filter parameters to GET /resources/subscription-plans/v2.0, GET /resources/user-groups/v1.0, GET /resources/parking-spaces/v1.0, and GET /resources/partners/v2.0.
    10. Expanded the validityPeriod enum on Voucher endpoints with three new values: 1 week, 2 days, and 2 weeks. Applies to both request and response bodies on GET /resources/vouchers/v2.1, POST /resources/vouchers/v2.1, GET /resources/vouchers/v2.1/{voucher}, and PATCH /resources/vouchers/v2.1/{voucher}.
  2. 🗑️ Deprecations
    1. Deprecated GET /resources/partner-expenses/v1.1. Use GET /resources/partner-expenses/v1.2 instead.
    2. Deprecated GET /resources/partner-revenues/v1.1. Use GET /resources/partner-revenues/v1.2 instead.

3.158.0 release notes

  1. New features
    1. Added the optional idleFeeGracePeriodMode property to the pricing object on Tariff endpoints. This field controls how the idle fee grace period is calculated: idle_detection (default) starts the grace period when idle charging is detected, while session_start starts it from the beginning of the session. Available on POST /resources/tariffs/v1.0, PUT /resources/tariffs/v1.0/{tariff} (request), and all Tariff and Tariff Snapshot read endpoints (response).

3.157.0 release notes

  1. New features
    1. Added createdAfter and createdBefore filter parameters to GET /resources/partner-contracts/v1.0. These allow filtering partner contracts by their creation date, complementing the existing lastUpdatedAfter and lastUpdatedBefore filters.
  2. 🔧 Improvements
    1. Changed the name uniqueness validation on Charge Point Model endpoints to be scoped per vendor. Previously, model names had to be globally unique; now the same model name can be used by different vendors. Affects POST /resources/charge-point-models/v1.0 and PATCH /resources/charge-point-models/v1.0/{chargePointModel}.

3.156.0 release notes

  1. New features
    1. Added the optional roamingSessionId property to CDR responses on GET /resources/cdrs/v2.0 and GET /resources/cdrs/v2.0/{cdr}. This field contains the session identifier from the roaming partner's system when the CDR originated from a roaming session.
    2. Added the optional chargePointId and evseCount properties to Partner Expense responses on GET /resources/partner-expenses/v1.1.
    3. Added the optional chargePointId, evseCount, and period properties to Partner Revenue responses on GET /resources/partner-revenues/v1.1.
    4. Added support for private EVSE access fee records in Partner Expenses and Partner Revenues. The origin field on both endpoints now includes the private-evse-access-fee value for these records.
    5. Added createdAfter and createdBefore filter parameters to GET /resources/tariff-groups/v1.0 for filtering tariff groups by creation date.
  2. 🔧 Improvements
    1. Relaxed the pin field constraint on Charge Point responses. The field no longer enforces a maximum length of 4 characters, allowing for longer PIN codes. Affects GET /resources/charge-points/v2.0, POST /resources/charge-points/v2.0, GET /resources/charge-points/v2.0/{chargePoint}, and PATCH /resources/charge-points/v2.0/{chargePoint}.

3.155.0 release notes

  1. ⚠️ Breaking changes
    1. Changed intervalPricing behavior on tariff pricing responses: the API now returns only the explicitly configured time periods. Previously, gaps between configured periods were automatically filled with default-priced entries covering the full 24-hour day. Consumers relying on complete day coverage must now handle partial period lists.
  2. New features
    1. Added new filter parameters to GET /resources/sessions/v1.0: filter[roaming][roamingOperatorEmspIds] to filter by roaming eMSP operator IDs, and filter[roaming][roamingConnectionIds] to filter by roaming connection IDs.
    2. Added new filter parameters to GET /resources/subscriptions/v1.0: filter[startedAfter] and filter[startedBefore] to filter by subscription start date, filter[endedAfter] and filter[endedBefore] to filter by subscription end date, and filter[statusChangedAfter] and filter[statusChangedBefore] to filter by the date the subscription status last changed.
    3. Added the filter[sessionId] parameter to GET /resources/cdrs/v2.0 to filter CDRs by internal session ID.
    4. Added roaming as a new allowed value for the category field on Issue endpoints (POST /resources/issues/v1.0, PATCH /resources/issues/v1.0/{issue}). The same value is now also returned in Issue responses.
    5. Added session as a new allowed value for the keyResource.resourceType field when creating issues via POST /resources/issues/v1.0.
    6. Expanded the keyResource.resourceType response field on Issue endpoints to include new values: roaming-cdr, roaming-connection, and session.
  3. 🔧 Improvements
    1. Reactivated the status field on Location requests for POST /resources/locations/v2.0 and PATCH /resources/locations/v2.0/{location}, allowing location status to be set during creation and updates.

3.154.0 release notes

No significant public API changes compared to version 3.153.0.

3.153.0 release notes

  1. ⚠️ Breaking changes
    1. Added US address validation on Location endpoints (POST /resources/locations/v2.0, PATCH /resources/locations/v2.0/{location}). When country is US, state is now required and postCode must be a valid US ZIP code format. Additionally, the ZIP code is validated to match the provided state.
    2. Added US address validation on User v1.1 endpoints (POST /resources/users/v1.1, PATCH /resources/users/v1.1/{user}). When country is US, post_code must be a valid US ZIP code and state is required (when the state profile field is enabled). The ZIP code is validated to match the provided state.
  2. 🔧 Improvements
    1. When updating a US user via PATCH /resources/users/v1.1/{user}, the existing country, post_code, and state values are now used as defaults for ZIP code validation when those fields are not included in the request. This ensures partial updates are validated correctly against the full address context.