HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Reimbursement policy / Create

post
https://{tenantUrl}/public-api/resources/reimbursement-policies/v1.0

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

Create a reimbursement policy.

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

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

string
required
length ≤ 255
string
enum
required

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.
  • charge_point: The rate set by the owner on their personal charge point in the mobile app provides the rate. electricityRateId must not be set.
Allowed:
date
required

Date (inclusive) from which the policy is valid.

integer

Partner the policy is scoped to. When not set, the policy applies to every partner of the operator.

integer

Partner contract the policy is scoped to. Requires partnerId and must belong to that partner. When not set, the policy is not scoped to a specific contract.

integer

Linked electricity rate providing the reimbursement rate. Set only when electricityRateSource is policy, where it is required.

date

Date (inclusive) until which the policy is valid. Must be after validityStartsOn. When not set, the policy has no end date. The policy's validity window is date-only (whole calendar days).

integer

Required for global admin tokens.
Omit for operator-scoped tokens (defaults to the token's operator).

Responses

Updated about 8 hours ago

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

Updated about 8 hours ago

Did this page help you?