HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Reimbursement policy / Update

⚠️ 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.

Update a reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the charge_point rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy.

Each rate source has its own reference: policy uses electricityRateId and integration uses integrationId. Changing electricityRateSource clears the reference the previous source used, whether or not the request sends that reference as null; sending it as null explicitly is accepted and produces the same result. Sending a non-null reference the selected rate source does not use is rejected with 422 keyed by that field. A policy whose rate source does not change keeps its stored reference when the reference is omitted, so an integration policy can be repointed by sending integrationId alone.

Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing partnerId on a policy that is already assigned to partner invites or has active charge point attachments, which returns a partnerId validation error rather than a 409. Deactivated attachments do not block the change.

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

Reimbursement policy update schema. The policy defines how a home-charging session's reimbursement rate is resolved and the validity window during which it applies.

string
length ≤ 255
date

Date (inclusive) from which the policy is valid.

string
enum

Origin of the per-kWh rate used to reimburse a home-charging session:

  • policy: The electricity rate linked to the policy provides the rate. electricityRateId is required and must belong to the same operator as the policy; integrationId must not be set on the policy.
  • charge_point: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. Neither electricityRateId nor integrationId is set on the policy.
  • integration: An integration resolves the electricity rate — for example by the charge point's region. integrationId is required and must reference a regional electricity rates integration of the same operator; electricityRateId must not be set on the policy. The integration's region-to-rate bindings are configured in the admin panel.
Allowed:
integer | null

Partner the policy is scoped to. Set to null to apply the policy to every partner of the operator. Clearing the partner also clears partnerContractId.

integer | null

Partner contract the policy is scoped to. Required whenever partnerId is set, and must belong to that partner, so it cannot be set to null while the policy has a partner — clear partnerId instead, which clears the contract with it. These rules are enforced when partnerId or partnerContractId is changed; an update that leaves both unchanged is accepted as is.

integer | null

Linked electricity rate providing the reimbursement rate. Required when electricityRateSource is policy, and must belong to the same operator as the policy. Not used by any other rate source — see the operation description for how references are cleared when the rate source changes.

integer | null

Regional electricity rates integration that resolves the reimbursement rate. Required when electricityRateSource is integration, and must belong to the same operator as the policy. Not used by any other rate source — see the operation description for how references are cleared when the rate source changes. The integration is created and configured in the admin panel; use the id shown on its detail page.

date | null

Date (inclusive) until which the policy is valid, in the YYYY-MM-DD date format. Set to null to remove the end date. Must be after validityStartsOn.

Responses

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