HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner invite corporate billing policy / Update

patch
https://{tenantUrl}/public-api/resources/partner-invite-corporate-billing-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.

Update a partner invite corporate billing policy.

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

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

Partner invite corporate billing policy update schema. The policy defines when corporate billing covers a driver's session costs and which limits, restrictions, and charger-type rules apply.

string
length ≤ 255
string
enum

Corporate billing policy coverage type:

  • full_coverage: The policy covers eligible session costs without tariff thresholds
  • limited_coverage: The policy covers eligible session costs only within configured limits
Allowed:
float | null
> 0

Authorization-time spending threshold for a driver's accumulated corporate-billed cost on the corporate account within the billing period. Once the accumulated cost reaches the limit, the policy stops covering that driver's subsequent sessions until the period resets. The session in which the limit is reached is still covered in full. Set to null to remove the per-driver spending limit.

string | null

An optional external identifier for integration purposes

restrictions
object | null
tariffThresholds
object | null

Per-component limits on the costs the policy covers. Costs above the configured limits are the driver's responsibility. Omitted limit fields mean that the policy has no limit for that dimension.

overallCostCap
object | null

Caps the amount the policy covers at maxCostPerKwh for each kWh charged. When the covered cost exceeds maxCostPerKwh multiplied by the energy charged, coverage is reduced to that maximum and the remainder is the driver's responsibility.

chargerTypeConfig
object | null

Defines separate AC and DC coverage. Each charger type has its own coverage type for full coverage, limited coverage, or no coverage. Both ac and dc are required when this object is provided. When chargerTypeConfig is present, coverage is resolved per charger type from this object, and the top-level coverageType, tariffThresholds, and overallCostCap are ignored.

Responses

Updated 20 days 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 20 days ago

Did this page help you?